Implements timeline

refs #224

Squashed commit of the following:

commit fb46cea3858036a932b8c6ff1354f4b0d9f166fb
Merge: d881b3d 0f4e285
Author: Julien Fastré <julien@fastre.info>
Date:   Wed Feb 18 00:14:38 2015 +0100

    Merge branch 'master' of git://github.com/Chill-project/Person into timeline

commit d881b3d69a53b2502f16d98d9d1809ead17fd77e
Author: Julien Fastré <julien@fastre.info>
Date:   Wed Feb 18 00:12:04 2015 +0100

    add closing period to timeline

    refs #224

commit 6363e59213f5cddded4e0678454e98929f885d39
Author: Julien Fastré <julien@fastre.info>
Date:   Wed Feb 18 00:08:09 2015 +0100

    refactor timeline #224

commit bd2e1b1808f73e39532e9538413025df5487cad0
Author: Julien Fastré <julien@fastre.info>
Date:   Wed Feb 11 00:39:05 2015 +0100

    implementing timeline for opening history file

    refs #224

    Some parts (method TimelineProviderInterface::getEntities, ...) are different from
    the design described in #224 and must be discussed

Controller/TimelinePersonController.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * Copyright (C) 2015 Julien Fastré <julien.fastre@champs-libres.coop>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Chill\PersonBundle\Controller;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+/**
+ *
+ *
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ */
+class TimelinePersonController extends Controller
+{
+
+    public function personAction(Request $request, $person_id)
+    {
+        $person = $this->getDoctrine()
+                ->getRepository('ChillPersonBundle:Person')
+                ->find($person_id);
+
+        if ($person === NULL) {
+            throw $this->createNotFoundException();
+        }
+
+        return $this->render('ChillPersonBundle:Timeline:index.html.twig', array
+            (
+                'timeline' => $this->get('chill.main.timeline_builder')
+                        ->getTimelineHTML('person', array('person' => $person)),
+                'person' => $person
+            )
+        );
+    }
+
+}

Resources/config/routing.yml

@@ -78,4 +78,13 @@ chill_person_admin:
             admin:
                 order: 100
                 label: menu.person.admin.index
-                helper: menu.person.admin.helper
+                helper: menu.person.admin.helper
+                
+chill_person_timeline:
+    pattern: /{_locale}/person/{person_id}/timeline
+    defaults: { _controller: ChillPersonBundle:TimelinePerson:person }
+    options:
+        menus:
+            person:
+                order: 60
+                label: Timeline

Resources/config/services.yml

@@ -18,3 +18,17 @@ services:
             - ['setContainer', ["@service_container"]]
         tags:
             - { name: chill.search, alias: 'person_regular' }
+            
+    chill.person.timeline.accompanying_period_opening:
+        class: Chill\PersonBundle\Timeline\TimelineAccompanyingPeriodOpening
+        arguments:
+            - "@doctrine.orm.entity_manager"
+        tags:
+            - { name: chill.timeline, context: 'person' }
+            
+    chill.person.timeline.accompanying_period_closing:
+        class: Chill\PersonBundle\Timeline\TimelineAccompanyingPeriodClosing
+        arguments:
+            - "@doctrine.orm.entity_manager"
+        tags:
+            - { name: chill.timeline, context: 'person' }

Resources/translations/messages.fr.yml

@@ -67,3 +67,7 @@ Reset: 'Remise à zéro'
 'Create accompanying period': 'Nouvel ouverture-fermeture à une autre date'
 'Closing motive': 'Motif de clôture'
 'Person details': 'Détails de la personne'
+
+#timeline
+'An accompanying period is opened for %person% on %date%': Une période d'accompagnement a été ouverte le %date% pour %person%
+'An accompanying period is closed for %person% on %date%': Une période d'accompagnement a été fermée le %date% pour %person%

Resources/views/Timeline/closing_period.html.twig

@@ -0,0 +1 @@
+<p><i class="fa fa-folder"></i>&nbsp;{{ 'An accompanying period is closed for %person% on %date%'|trans({'%person%': person, '%date%': period.dateClosing|localizeddate('long', 'none') } ) }}</p>

Resources/views/Timeline/index.html.twig

@@ -0,0 +1,32 @@
+{#
+ * Copyright (C) 2014, Champs Libres Cooperative SCRLFS, <http://www.champs-libres.coop>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#}
+{% extends "ChillPersonBundle::layout.html.twig"  %}
+
+{% set activeRouteKey = 'chill_person_timeline' %}
+
+{#
+This view should receive those arguments:
+- person
+#}
+
+{% block title %}{{ 'Timeline for %name%'|trans({'%name%': person }) }}{% endblock %}
+
+
+{% block personcontent %}
+    {{ timeline|raw }}
+    
+{% endblock personcontent %}

Resources/views/Timeline/opening_period.html.twig

@@ -0,0 +1 @@
+<p><i class="fa fa-folder-open"></i>&nbsp;{{ 'An accompanying period is opened for %person% on %date%'|trans({'%person%': person, '%date%': period.dateOpening|localizeddate('long', 'none') } ) }}</p>

Timeline/AbstractTimelineAccompanyingPeriod.php

@@ -0,0 +1,107 @@
+<?php
+
+/*
+ * Copyright (C) 2015 Julien Fastré <julien.fastre@champs-libres.coop>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Chill\PersonBundle\Timeline;
+
+use Chill\MainBundle\Timeline\TimelineProviderInterface;
+use Doctrine\ORM\EntityManager;
+
+/**
+ * Provide method to build timeline for accompanying periods
+ * 
+ * This class is resued by TimelineAccompanyingPeriodOpening (for opening)
+ * and TimelineAccompanyingPeriodClosing (for closing)
+ *
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ */
+abstract class AbstractTimelineAccompanyingPeriod implements TimelineProviderInterface
+{
+    /**
+     *
+     * @var EntityManager
+     */
+    protected $em;
+    
+    public function __construct(EntityManager $em)
+    {
+        $this->em = $em;
+    }
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function getEntities(array $ids)
+    {
+        $periods = $this->em
+                ->getRepository('ChillPersonBundle:AccompanyingPeriod')
+                ->findBy(array('id' => $ids));
+        
+        //set results in an associative array with id as indexes
+        $results = array();
+        foreach($periods as $period) {
+            $results[$period->getId()] = $period;
+        }
+        
+        return $results;
+    }
+
+    /**
+     * prepare fetchQuery without `WHERE` and `TYPE` clause
+     * 
+     * @param string $context
+     * @param array $args
+     * @return array
+     * @throws \LogicException
+     */
+    protected function basicFetchQuery($context, array $args)
+    {
+        if ($context !== 'person') {
+            throw new \LogicException('TimelineAccompanyingPeriod is not able '
+                    . 'to render context '.$context);
+        }
+        
+        $metadata = $this->em
+                ->getClassMetadata('ChillPersonBundle:AccompanyingPeriod')
+                ;
+        
+        return array(
+            'id' => $metadata->getColumnName('id'),
+            'date' => $metadata->getColumnName('date_opening'),
+            'FROM' => $metadata->getTableName(),
+        );
+    }
+
+    /**
+     * return the expected response for TimelineProviderInterface::getEntityTemplate
+     * 
+     * @param string $template the template for rendering
+     * @param mixed $entity
+     * @param string $context
+     * @param array $args
+     * @return array
+     */
+    protected function getBasicEntityTemplate($template, $entity, $context, array $args)
+    {
+        return array(
+            'template' => $template,
+            'template_data' => ['person' => $args['person'], 'period' => $entity]
+        );
+    }
+}

Timeline/TimelineAccompanyingPeriodClosing.php

@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * Copyright (C) 2015 Julien Fastré <julien.fastre@champs-libres.coop>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Chill\PersonBundle\Timeline;
+
+use Chill\MainBundle\Timeline\TimelineProviderInterface;
+use Doctrine\ORM\EntityManager;
+
+/**
+ * Provide information for opening periods to timeline
+ *
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ */
+class TimelineAccompanyingPeriodClosing extends AbstractTimelineAccompanyingPeriod
+{
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function supportsType($type)
+    {
+        return $type === 'accompanying_period_closing';
+    }
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function fetchQuery($context, array $args)
+    {
+        $metadata = $this->em
+                    ->getClassMetadata('ChillPersonBundle:AccompanyingPeriod');
+        
+        $data = $this->basicFetchQuery($context, $args);
+        
+        $data['type'] = 'accompanying_period_closing';
+        $data['WHERE'] = sprintf('%s = %d AND %s IS NOT NULL', 
+                $metadata
+                    ->getAssociationMapping('person')['joinColumns'][0]['name'],
+                $args['person']->getId(),
+                $metadata
+                    ->getColumnName('date_closing')
+                );
+        
+        return $data;
+    }
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function getEntityTemplate($entity, $context, array $args)
+    {
+        return $this->getBasicEntityTemplate(
+                'ChillPersonBundle:Timeline:closing_period.html.twig', 
+                $entity, 
+                $context, 
+                $args
+                );
+    }
+}

Timeline/TimelineAccompanyingPeriodOpening.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * Copyright (C) 2015 Julien Fastré <julien.fastre@champs-libres.coop>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Chill\PersonBundle\Timeline;
+
+use Chill\MainBundle\Timeline\TimelineProviderInterface;
+use Doctrine\ORM\EntityManager;
+
+/**
+ * Provide information for opening periods to timeline
+ *
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ */
+class TimelineAccompanyingPeriodOpening extends AbstractTimelineAccompanyingPeriod
+{
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function supportsType($type)
+    {
+        return $type === 'accompanying_period_opening';
+    }
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function fetchQuery($context, array $args)
+    {
+        
+        $data = $this->basicFetchQuery($context, $args);
+        
+        $data['type'] = 'accompanying_period_opening';
+        $data['WHERE'] = sprintf('%s = %d', 
+                $this->em
+                    ->getClassMetadata('ChillPersonBundle:AccompanyingPeriod')
+                    ->getAssociationMapping('person')['joinColumns'][0]['name'],
+                $args['person']->getId());
+        
+        return $data;
+    }
+
+    /**
+     * 
+     * {@inheritDoc}
+     */
+    public function getEntityTemplate($entity, $context, array $args)
+    {
+        return $this->getBasicEntityTemplate(
+                'ChillPersonBundle:Timeline:opening_period.html.twig', 
+                $entity, 
+                $context, 
+                $args
+                );
+    }
+}