{% for result in results %}
- {% include result.template with result.templateArgs %}
+ {% include result.template with result.template_data %}
{% endfor %}
diff --git a/Timeline/TimelineBuilder.php b/Timeline/TimelineBuilder.php
index 79472c9f2..6899d224b 100644
--- a/Timeline/TimelineBuilder.php
+++ b/Timeline/TimelineBuilder.php
@@ -50,93 +50,187 @@ class TimelineBuilder implements ContainerAwareInterface
*/
private $providers = array();
- public function getTimeline($context, array $args, $page = 0, $number = 20)
+ /**
+ * return an HTML string with timeline
+ *
+ * This function must be called from controller
+ *
+ * @example https://redmine.champs-libres.coop/projects/chillperson/repository/revisions/bd2e1b1808f73e39532e9538413025df5487cad0/entry/Controller/TimelinePersonController.php#L47 the implementation in person bundle
+ *
+ * @param string $context
+ * @param array $args arguments defined by the bundle which create the context
+ * @param int $page first page = 0
+ * @param int $number number of items by page
+ * @return string an HTML representation, must be included using `|raw` filter
+ */
+ public function getTimelineHTML($context, array $args, $page = 0, $number = 20)
{
- $query = $this->buildQuery($context, $args, $page, $number);
- $ids = $this->runQuery($query);
- $entitiesByKey = $this->getEntities($ids, $context);
-
- return $this->render($ids, $entitiesByKey);
+ $query = $this->buildUnionQuery($context, $args, $page, $number);
+ $fetched = $this->runQuery($query);
+ $entitiesByKey = $this->getEntities($fetched, $context);
+ return $this->render($fetched, $entitiesByKey, $context, $args);
}
+ /**
+ * add a provider id
+ *
+ * @internal This function is called by the TimelineCompilerClass
+ *
+ * @param string $context the context of the service
+ * @param string $id the
+ */
public function addProvider($context, $id)
{
- $this->providers[$context][] = [$id];
+ $this->providers[$context][] = $id;
}
-
- private function buildQuery($context, array $args, $page, $number)
+ /**
+ * Get providers by context
+ *
+ * @param string $context
+ * @return TimelineProviderInterface[]
+ */
+ public function getProvidersByContext($context)
{
+ $providers = array();
+
+ foreach($this->providers[$context] as $providerId) {
+ $providers[] = $this->container->get($providerId);
+ }
+
+ return $providers;
+ }
+
+ /**
+ * build the UNION query with all providers
+ *
+ * @uses self::buildSelectQuery to build individual SELECT queries
+ *
+ * @param string $context
+ * @param mixed $args
+ * @param int $page
+ * @param int $number
+ * @return string
+ * @throws \LogicException if no builder have been defined for this context
+ */
+ private function buildUnionQuery($context, array $args, $page, $number)
+ {
+ //throw an exception if no provider have been defined for this context
if (!array_key_exists($context, $this->providers)) {
throw new \LogicException(sprintf('No builders have been defined for "%s"'
. ' context', $context));
}
- $query = '';
- foreach($this->providers[$context] as $providerIds) {
- foreach ($providerIds as $providerId) {
- $provider = $this->container->get($providerId);
-
- $query .= ($query === '') ?
- $provider->fetchUnion($context, $args) :
- ' UNION '.$provider->fetchUnion($context, $args);
- }
+ //append SELECT queries with UNION keyword between them
+ $union = '';
+ foreach($this->getProvidersByContext($context) as $provider) {
+ $select = $this->buildSelectQuery($provider, $context, $args);
+ $append = ($union === '') ? $select : ' UNION '.$select;
+ $union .= $append;
}
- $query .= sprintf(' ORDER BY date LIMIT %d OFFSET %d',
+ //add ORDER BY clause and LIMIT
+ $union .= sprintf(' ORDER BY date LIMIT %d OFFSET %d',
$number, $page * $number);
- return $query;
-
-
+ return $union;
}
+ /**
+ * return the SQL SELECT query as a string,
+ *
+ * @uses TimelineProfiderInterface::fetchQuery use the fetchQuery function
+ * @param \Chill\MainBundle\Timeline\TimelineProviderInterface $provider
+ * @param string $context
+ * @param mixed[] $args
+ * @return string
+ */
+ private function buildSelectQuery(TimelineProviderInterface $provider, $context, array $args)
+ {
+ $data = $provider->fetchQuery($context, $args);
+
+ return sprintf(
+ 'SELECT "%s" AS id, '
+ . '"%s" AS "date", '
+ . "'%s' AS type "
+ . 'FROM %s '
+ . 'WHERE %s',
+ $data['id'],
+ $data['date'],
+ $data['type'],
+ $data['FROM'],
+ $data['WHERE']);
+ }
+
+ /**
+ * run the UNION query and return result as an array
+ *
+ * @param string $query
+ * @return array
+ */
private function runQuery($query)
{
$resultSetMapping = (new ResultSetMapping())
->addScalarResult('id', 'id')
- ->addScalarResult('key', 'key')
+ ->addScalarResult('type', 'type')
->addScalarResult('date', 'date');
return $this->em->createNativeQuery($query, $resultSetMapping)
->getArrayResult();
}
+ /**
+ *
+ * @param array $queriedIds
+ * @param string $context
+ * @return array with the form array($type => [$entity, $entity, $entity])
+ */
private function getEntities(array $queriedIds, $context)
{
- //gather entities by key. Having all ids in the same table allow to query from providers
- $idsByKey = array();
+ //gather entities by type to pass all id with same type to the TimelineProvider.
+ $idsByType = array();
foreach($queriedIds as $result) {
- $idsByKey[$result['key']][] = $result['id'];
+ $idsByType[$result['type']][] = $result['id'];
}
//fetch entities from providers
- $entitiesByKey = array();
- foreach ($idsByKey as $key => $ids) {
+ $entitiesByType = array();
+ foreach ($idsByType as $type => $ids) {
//iterate providers for current context
- foreach($this->providers[$context] as $providerIds) {
- foreach ($providerIds as $providerId){
- $provider = $this->container->get($providerId);
-
- if ($provider->supportsKey($key)) {
- $entitiesByKey[$key] = $provider->getEntities($ids);
- }
+ foreach($this->getProvidersByContext($context) as $provider) {
+ if ($provider->supportsType($type)) {
+ $entitiesByType[$type] = $provider->getEntities($ids);
+ break; //we assume that providers have unique keys => we break the loop
}
}
}
- return $entitiesByKey;
+ return $entitiesByType;
}
- private function render(array $queriedIds, $entitiesByKey)
+ /**
+ * render the timeline as HTML
+ *
+ * @param array $fetched
+ * @param array $entitiesByType
+ * @param string $context
+ * @param mixed[] $args
+ * @return string the HTML representation of the timeline
+ */
+ private function render(array $fetched, array $entitiesByType, $context, array $args)
{
//add results to a pretty array
$timelineEntries = array();
- foreach ($queriedIds as $result) {
- $timelineEntry['date'] = $result['date'];
- $timelineEntry['template'] = $entitiesByKey[$result['key']][$result['id']]['template'];
- $timelineEntry['templateArgs'] = $entitiesByKey[$result['key']][$result['id']]['entity'];
+ foreach ($fetched as $result) {
+ $data = $this->getTemplateData(
+ $result['type'],
+ $entitiesByType[$result['type']][$result['id']], //the entity
+ $context,
+ $args);
+ $timelineEntry['date'] = new \DateTime($result['date']);
+ $timelineEntry['template'] = $data['template'];
+ $timelineEntry['template_data'] = $data['template_data'];
$timelineEntries[] = $timelineEntry;
}
@@ -147,4 +241,22 @@ class TimelineBuilder implements ContainerAwareInterface
));
}
+
+ /**
+ * get the template data from the provider for the given entity, by type.
+ *
+ * @param string $type
+ * @param mixed $entity
+ * @param string $context
+ * @param mixed[] $args
+ * @return array the template data fetched from the provider
+ */
+ private function getTemplateData($type, $entity, $context, array $args)
+ {
+ foreach($this->getProvidersByContext($context) as $provider) {
+ if ($provider->supportsType($type)) {
+ return $provider->getEntityTemplate($entity, $context, $args);
+ }
+ }
+ }
}
diff --git a/Timeline/TimelineProviderInterface.php b/Timeline/TimelineProviderInterface.php
index 01cbe426b..3406186fc 100644
--- a/Timeline/TimelineProviderInterface.php
+++ b/Timeline/TimelineProviderInterface.php
@@ -68,6 +68,7 @@ interface TimelineProviderInterface
* @param string $context
* @param mixed[] $args the argument to the context.
* @return string[]
+ * @throw \LogicException if the context is not supported
*/
public function fetchQuery($context, array $args);
@@ -80,17 +81,16 @@ interface TimelineProviderInterface
public function supportsType($type);
/**
- * fetch entities from db and indicate how to render them
+ * fetch entities from db into an associative array. The keys **MUST BE**
+ * the id
*
- * All id returned by all SELECT queries
+ * All ids returned by all SELECT queries
* (@see TimeLineProviderInterface::fetchQuery) and with the type
* supported by the provider (@see TimelineProviderInterface::supportsType)
* will be passed as argument.
*
- * The function must return all object with the given id.
- *
- * @param array $ids
- * @return mixed[] an array of entities
+ * @param array $ids an array of id
+ * @return mixed[] an associative array of entities, with id as key
*/
public function getEntities(array $ids);
@@ -123,6 +123,7 @@ interface TimelineProviderInterface
* @param type $context
* @param array $args
* @return mixed[]
+ * @throws \LogicException if the context is not supported
*/
public function getEntityTemplate($entity, $context, array $args);