add closed tasks

- the entity has a new column / property "closed" (boolean)
- An event listener in created during container compilation, which listen on tasks
  status changed
- The taskworkflow manager and task workflow definition indicate if the tasks is closed ;
- Add list for closed tasks in controller, and change parameter 'date_status' to 'status';
- and change query to allow to filter on closed tasks

Controller/SingleTaskController.php

@@ -298,39 +298,42 @@ class SingleTaskController extends Controller
         $viewParams['person'] = $person;
         // collect parameters for filter
         $params['person'] = $person;
-        $statuses = $request->query->get('date_status', []);
+        $possibleStatuses = \array_merge(SingleTaskRepository::DATE_STATUSES, [ 'closed' ]);
+        $statuses = $request->query->get('status', $possibleStatuses);
         
-        if ($statuses) {
-            // check for invalid parameters
-            $diff = \array_diff(
-                $statuses, 
-                SingleTaskRepository::DATE_STATUSES)
-                ;
-            
-            if (count($diff) > 0) {
-                return new Response(
-                    'date_status not allowed: '. \implode(', ', $diff), 
-                     Response::HTTP_BAD_REQUEST
-                    );
-            }
+        // check for invalid statuses
+        $diff = \array_diff($statuses, $possibleStatuses);
+        if (count($diff) > 0) {
+            return new Response(
+                'date_status not allowed: '. \implode(', ', $diff), 
+                 Response::HTTP_BAD_REQUEST
+                );
         }
         
         $viewParams['isSingleStatus'] = $singleStatus = count($statuses) === 1;
             
-        foreach(SingleTaskRepository::DATE_STATUSES as $type) {
-            if($request->query->has('date_status') 
-                && FALSE === \in_array($type, $statuses ?? [])) {
+        foreach($statuses as $status) {
+            if($request->query->has('status') 
+                && FALSE === \in_array($status, $statuses)) {
                 continue;
             }
             
-            $params['date_status'] = $type;
+            // different query if regarding to date or 'closed'
+            if (in_array($status, SingleTaskRepository::DATE_STATUSES)) {
+                $params['date_status'] = $status;
+                $params['is_closed']   = false;
+            } else {
+                $params['date_status'] = null;
+                $params['is_closed']   = true;
+            }
+            
             $count = $taskRepository
                 ->countByParameters($params, $this->getUser())
                 ;
             $paginator = $paginatorFactory->create($count);
-            $viewParams['single_task_'.$type.'_count'] = $count;
-            $viewParams['single_task_'.$type.'_paginator'] = $paginator;
-            $viewParams['single_task_'.$type.'_tasks'] = $taskRepository
+            $viewParams['single_task_'.$status.'_count'] = $count;
+            $viewParams['single_task_'.$status.'_paginator'] = $paginator;
+            $viewParams['single_task_'.$status.'_tasks'] = $taskRepository
                 ->findByParameters($params, $this->getUser(), 
                     $singleStatus ? $paginator->getCurrentPage()->getFirstItemNumber() : 0, 
                     $singleStatus ? $paginator->getItemsPerPage() : 10)

Controller/TaskController.php

@@ -71,10 +71,10 @@ class TaskController extends Controller
             
             $em->flush();
             
-            $this->addFlash('success', 'The transition is sucessfully applyed');
+            $this->addFlash('success', 'The transition is sucessfully appliyed');
 
         } else {
-            $this->addFlash('error', 'The transition could not be applyed');
+            $this->addFlash('error', 'The transition could not be appliyed');
         }
         
         return $this->redirect($request->query->get('return_path', $defaultReturnPath));

DependencyInjection/Compiler/TaskWorkflowDefinitionCompilerPass.php

@@ -39,8 +39,17 @@ class TaskWorkflowDefinitionCompilerPass implements CompilerPassInterface
         $workflowManagerDefinition = $container->getDefinition(TaskWorkflowManager::class);
         
         foreach ($container->findTaggedServiceIds('chill_task.workflow_definition') as $id => $tags) {
+            // registering the definition to manager
             $workflowManagerDefinition
                 ->addMethodCall('addDefinition', [new Reference($id)]);
+            // adding a listener for currentStatus changes
+            $definition = $container->getDefinition($id);
+            $workflowManagerDefinition
+                ->addTag('kernel.event_listener', [
+                    'event' => sprintf('workflow.%s.entered', $definition->getClass()::getAssociatedWorkflowName()), 
+                    'method' => 'onTaskStateEntered', 
+                    'priority' => -255 
+                    ]);
         }
     }
 }

Entity/AbstractTask.php

@@ -80,6 +80,12 @@ abstract class AbstractTask implements HasScopeInterface, HasCenterInterface
      * @Assert\NotNull()
      */
     private $circle;
+    
+    /**
+     * @var boolean
+     * @ORM\Column(name="closed", type="boolean", options={ "default"=false })
+     */
+    private $closed = false;
 
     /**
      * Set type
@@ -229,6 +235,21 @@ abstract class AbstractTask implements HasScopeInterface, HasCenterInterface
         return $this->getCircle();
     }
 
-
+    /**
+     * @return bool
+     */
+    public function isClosed(): bool
+    {
+        return $this->closed;
+    }
+    
+    /**
+     * 
+     * @param bool $closed
+     */
+    public function setClosed(bool $closed)
+    {
+        $this->closed = $closed;
+    }
 }
 

Repository/SingleTaskRepository.php

@@ -69,6 +69,8 @@ class SingleTaskRepository extends \Doctrine\ORM\EntityRepository
      * - `person` : filter by person associated with the task ;
      * - `date_status`: type of task. To choose between :
      *      `ended`, `warning`, `current`, `not_started`
+     * - `is_closed`: boolean. Indicate if the tasks must be closed (true) or 
+     *  opened
      * 
      * @param type $params
      * @param User $currentUser
@@ -90,14 +92,18 @@ class SingleTaskRepository extends \Doctrine\ORM\EntityRepository
     {
         $this->buildACLQuery($qb, $currentUser);
         
-        if (\array_key_exists('person', $params)) {
+        if (\array_key_exists('person', $params) and !empty($params['person'])) {
             $qb->andWhere($qb->expr()->eq('st.person', ':person'));
             $qb->setParameter('person', $params['person']);
         }
         
-        if (\array_key_exists('date_status', $params)) {
+        if (\array_key_exists('date_status', $params) and !empty($params['date_status'])) {
             $this->addTypeFilter($qb, $params);
         }
+        
+        if (\array_key_exists('is_closed', $params)) {
+            $qb->andWhere($this->buildIsClosed($qb, !$params['is_closed']));
+        }
     }
     
     protected function addTypeFilter(QueryBuilder $qb, $params) 
@@ -106,7 +112,9 @@ class SingleTaskRepository extends \Doctrine\ORM\EntityRepository
         
         switch ($params['date_status']) {
             case self::DATE_STATUS_ENDED: 
-                $andWhere->add($this->buildNowIsAfterEndDate($qb));
+                $andWhere
+                    ->add($this->buildNowIsAfterEndDate($qb))
+                    ;
                 break;
             
             case self::DATE_STATUS_WARNING:
@@ -155,7 +163,7 @@ class SingleTaskRepository extends \Doctrine\ORM\EntityRepository
         }
     }
     
-    private function buildNowIsAfterWarningDate(QueryBuilder $qb, $negative = false)
+    private function buildNowIsAfterWarningDate(QueryBuilder $qb, bool $negative = false)
     {
         if ($negative === false) {
             return $qb->expr()->andX()
@@ -181,7 +189,7 @@ class SingleTaskRepository extends \Doctrine\ORM\EntityRepository
         }
     }
     
-    private function buildNowIsAfterStartDate(QueryBuilder $qb, $negative = false)
+    private function buildNowIsAfterStartDate(QueryBuilder $qb, bool $negative = false)
     {
         if ($negative === false) {
             return $qb->expr()->orX()
@@ -197,6 +205,15 @@ class SingleTaskRepository extends \Doctrine\ORM\EntityRepository
         }
     }
     
+    private function buildIsClosed(QueryBuilder $qb, bool $negative = false)
+    {
+        if ($negative === false) {
+            return $qb->expr()->eq('st.closed', "'TRUE'");
+        } else {
+            return $qb->expr()->eq('st.closed', "'FALSE'");
+        }
+    }
+    
     
     protected function buildACLQuery(QueryBuilder $qb, User $currentUser)
     {

Resources/migrations/Version20180426093011.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace Application\Migrations;
+
+use Doctrine\DBAL\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema;
+
+/**
+ * Add a column 'closed' on tasks
+ */
+class Version20180426093011 extends AbstractMigration
+{
+    public function up(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'postgresql', 'Migration can only be executed safely on \'postgresql\'.');
+
+        $this->addSql('ALTER TABLE chill_task.single_task ADD closed BOOLEAN DEFAULT \'false\' NOT NULL');
+        $this->addSql('ALTER TABLE chill_task.recurring_task ADD closed BOOLEAN DEFAULT \'false\' NOT NULL');
+    }
+
+    public function down(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() !== 'postgresql', 'Migration can only be executed safely on \'postgresql\'.');
+
+        $this->addSql('ALTER TABLE chill_task.recurring_task DROP closed');
+        $this->addSql('ALTER TABLE chill_task.single_task DROP closed');
+    }
+}

Resources/views/Task/index.html.twig

@@ -100,7 +100,7 @@
             {% else %}
                 <ul class="record_actions">
                     <li>
-                        <a href="{{ path('chill_task_task_list_by_person', {'personId': person.id, 'date_status' : [ status ] }) }}" class="sc-button bt-cancel">
+                        <a href="{{ path('chill_task_task_list_by_person', {'personId': person.id, 'status' : [ status ] }) }}" class="sc-button bt-cancel">
                             {{ 'See more' | trans }}
                         </a>
                     </li>
@@ -132,6 +132,10 @@
     {% if single_task_not_started_tasks is defined %}
         {{ helper.date_status('Tasks not started', single_task_not_started_tasks, single_task_not_started_count, single_task_not_started_paginator, 'not_started',  isSingleStatus, person) }}
     {% endif %}
+    
+    {% if single_task_closed_tasks is defined %}
+        {{ helper.date_status('Closed', single_task_closed_tasks, single_task_closed_count, single_task_closed_paginator, 'closed',  isSingleStatus, person) }}
+    {% endif %}
 
     {% if isSingleStatus == false %}
         <ul class="record_actions">

Workflow/Definition/DefaultTaskDefinition.php

@@ -53,7 +53,7 @@ class DefaultTaskDefinition implements \Chill\TaskBundle\Workflow\TaskWorkflowDe
             && $task->getType() === 'task_default';
     }
     
-    public function getAssociatedWorkflowName()
+    public static function getAssociatedWorkflowName()
     {
         return 'task_default';
     }
@@ -89,4 +89,10 @@ class DefaultTaskDefinition implements \Chill\TaskBundle\Workflow\TaskWorkflowDe
         
         return self::TRANSITION_METADATA[$transition->getName()][$key];
     }
+    
+    public function isClosed(AbstractTask $task) 
+    {
+        return \array_key_exists('closed', $task->getCurrentStates())
+            || \array_key_exists('canceled', $task->getCurrentStates());
+    }
 }

Workflow/TaskWorkflowManager.php

@@ -20,6 +20,7 @@ namespace Chill\TaskBundle\Workflow;
 use Chill\TaskBundle\Entity\AbstractTask;
 use Symfony\Component\Workflow\SupportStrategy\SupportStrategyInterface;
 use Symfony\Component\Workflow\Workflow;
+use Symfony\Component\Workflow\Event\Event;
 
 /**
  * 
@@ -80,4 +81,15 @@ class TaskWorkflowManager implements SupportStrategyInterface
         return $this->getTaskWorkflowDefinition($task)
             ->getWorkflowMetadata($key, $metadataSubject);
     }
+    
+    public function onTaskStateEntered(Event $e) 
+    {
+        $task = $e->getSubject();
+        
+        $definition = $this->getTaskWorkflowDefinition($task);
+        
+        $task->setClosed($definition->isClosed($task));
+        
+        dump($task);
+    }
 }