first impl for index action

src/Bundle/ChillMainBundle/CRUD/Controller/AbstractCRUDController.php

@@ -7,6 +7,7 @@ use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 use Chill\MainBundle\Pagination\PaginatorFactory;
+use Chill\MainBundle\Pagination\PaginatorInterface;
 
 class AbstractCRUDController extends AbstractController
 {
@@ -32,6 +33,122 @@ class AbstractCRUDController extends AbstractController
             ->find($id);
     }
 
+    /**
+     * Count the number of entities
+     *
+     * By default, count all entities. You can customize the query by 
+     * using the method `customizeQuery`.
+     * 
+     * @param string $action
+     * @param Request $request
+     * @return int
+     */
+    protected function countEntities(string $action, Request $request, $_format): int
+    {
+        return $this->buildQueryEntities($action, $request)
+            ->select('COUNT(e)')
+            ->getQuery()
+            ->getSingleScalarResult()
+            ;
+    }
+
+    /**
+     * Query the entity.
+     * 
+     * By default, get all entities. You can customize the query by using the
+     * method `customizeQuery`.
+     * 
+     * The method `orderEntity` is called internally to order entities.
+     * 
+     * It returns, by default, a query builder.
+     * 
+     */
+    protected function queryEntities(string $action, Request $request, string $_format, PaginatorInterface $paginator)
+    {
+        $query = $this->buildQueryEntities($action, $request)
+            ->setFirstResult($paginator->getCurrentPage()->getFirstItemNumber())
+            ->setMaxResults($paginator->getItemsPerPage());
+        
+        // allow to order queries and return the new query
+        return $this->orderQuery($action, $query, $request, $paginator, $_format);
+    }
+
+    /**
+     * Add ordering fields in the query build by self::queryEntities
+     * 
+     */
+    protected function orderQuery(string $action, $query, Request $request, PaginatorInterface $paginator, $_format)
+    {
+        return $query;
+    }
+
+    /**
+     * Build the base query for listing all entities.
+     *
+     * This method is used internally by `countEntities` `queryEntities`
+     * 
+     * This base query does not contains any `WHERE` or `SELECT` clauses. You
+     * can add some by using the method `customizeQuery`.
+     *
+     * The alias for the entity is "e".
+     * 
+     * @param string $action
+     * @param Request $request
+     * @return QueryBuilder
+     */
+    protected function buildQueryEntities(string $action, Request $request)
+    {
+        $qb = $this->getDoctrine()->getManager()
+            ->createQueryBuilder()
+            ->select('e')
+            ->from($this->getEntityClass(), 'e')
+            ;
+
+        $this->customizeQuery($action, $request, $qb);
+
+        return $qb;
+    }
+
+    protected function customizeQuery(string $action, Request $request, $query): void {}
+
+    /**
+     * Get the result of the query
+     */
+    protected function getQueryResult(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $query) 
+    {
+        return $query->getQuery()->getResult();
+    }
+
+    protected function onPreIndex(string $action, Request $request, string $_format): ?Response
+    { 
+        return null; 
+    }
+    
+    /**
+     * method used by indexAction
+     */
+    protected function onPreIndexBuildQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator): ?Response
+    { 
+        return null;
+    }
+
+    /**
+     * method used by indexAction
+     */
+    protected function onPostIndexBuildQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $query): ?Response
+    {
+        return null;
+    }
+    
+    /**
+     * method used by indexAction
+     */
+    protected function onPostIndexFetchQuery(string $action, Request $request, string $_format, int $totalItems, PaginatorInterface $paginator, $entities): ?Response
+    {
+        return null;
+    }
+    
+
     /**
      * Get the complete FQDN of the class
      * 
@@ -53,7 +170,7 @@ class AbstractCRUDController extends AbstractController
     /**
      * Called on post check ACL
      */
-    protected function onPostCheckACL(string $action, Request $request, $entity, $_format): ?Response
+    protected function onPostCheckACL(string $action, Request $request, string $_format, $entity): ?Response
     {
         return null;
     }
@@ -69,7 +186,7 @@ class AbstractCRUDController extends AbstractController
      * 
      * @throws \Symfony\Component\Security\Core\Exception\AccessDeniedHttpException
      */
-    protected function checkACL(string $action, Request $request, $entity, $_format)
+    protected function checkACL(string $action, Request $request, string $_format, $entity = null)
     {
         $this->denyAccessUnlessGranted($this->getRoleFor($action, $request, $entity, $_format), $entity);
     }
@@ -103,22 +220,6 @@ class AbstractCRUDController extends AbstractController
      */
     protected function getPaginatorFactory(): PaginatorFactory
     {
-        return $this->container->get(PaginatorFactory::class);
-    }
-
-    /**
-     * Defined the services necessary for this controller
-     *
-     * @return array
-     */
-    public static function getSubscribedServices(): array
-    {
-        return \array_merge(
-            parent::getSubscribedServices(),
-            [
-                PaginatorFactory::class => PaginatorFactory::class,
-
-            ]
-        );
+        return $this->container->get('chill_main.paginator_factory');
     }
 }

src/Bundle/ChillMainBundle/CRUD/Controller/ApiController.php

@@ -6,6 +6,8 @@ use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Serializer\SerializerInterface;
+use Chill\MainBundle\Serializer\Model\Collection;
+use Chill\MainBundle\Pagination\PaginatorInterface;
 
 class ApiController extends AbstractCRUDController
 {
@@ -41,7 +43,7 @@ class ApiController extends AbstractCRUDController
                 . "is not found", $this->getCrudName(), $id));
         }
         
-        $response = $this->checkACL($action, $request, $entity, $_format);
+        $response = $this->checkACL($action, $request, $_format, $entity);
         if ($response instanceof Response) {
             return $response;
         }
@@ -86,6 +88,110 @@ class ApiController extends AbstractCRUDController
         }
     }
 
+    /**
+     * Base action for indexing entities
+     */
+    public function indexApi(Request $request, string $_format)
+    {
+        switch ($request->getMethod()) {
+            case Request::METHOD_GET:
+            case REQUEST::METHOD_HEAD:
+                return $this->indexApiAction('_index', $request, $_format);
+            default:
+                throw $this->createNotFoundException("This method is not supported");
+        }
+    }
+
+    /**
+     * Build an index page.
+     * 
+     * Some steps may be overriden during this process of rendering.
+     * 
+     * This method:
+     * 
+     * 1.  Launch `onPreIndex`
+     * x.  check acl. If it does return a response instance, return it
+     * x.  launch `onPostCheckACL`. If it does return a response instance, return it
+     * 1.  count the items, using `countEntities`
+     * 2.  build a paginator element from the the number of entities ;
+     * 3.  Launch `onPreIndexQuery`. If it does return a response instance, return it
+     * 3.  build a query, using `queryEntities`
+     * x.  fetch the results, using `getQueryResult`
+     * x.  Launch `onPostIndexFetchQuery`. If it does return a response instance, return it
+     * 4.  create default parameters:
+     * 
+     *     The default parameters are: 
+     *     
+     *         * entities: the list en entities ;
+     *         * crud_name: the name of the crud ;
+     *         * paginator: a paginator element ;
+     * 5.  Launch rendering, the parameter is fetch using `getTemplateFor` 
+     *     The parameters may be personnalized using `generateTemplateParameter`.
+     * 
+     * @param string $action
+     * @param Request $request
+     * @return type
+     */
+    protected function indexApiAction($action, Request $request, $_format)
+    {
+        $this->onPreIndex($action, $request, $_format);
+        
+        $response = $this->checkACL($action, $request, $_format);
+        if ($response instanceof Response) {
+            return $response;
+        }
+        
+        if (!isset($entity)) {
+            $entity = '';
+        }
+        
+        $response = $this->onPostCheckACL($action, $request, $_format, $entity);
+        if ($response instanceof Response) {
+            return $response;
+        }
+        
+        $totalItems = $this->countEntities($action, $request, $_format);
+        $paginator = $this->getPaginatorFactory()->create($totalItems);
+        
+        $response = $this->onPreIndexBuildQuery($action, $request, $_format, $totalItems, 
+            $paginator);
+        
+        if ($response instanceof Response) {
+            return $response;
+        }
+        
+        $query = $this->queryEntities($action, $request, $_format, $paginator);
+        
+        $response = $this->onPostIndexBuildQuery($action, $request, $_format, $totalItems, 
+            $paginator, $query);
+        
+        if ($response instanceof Response) {
+            return $response;
+        }
+        
+        $entities = $this->getQueryResult($action, $request, $_format, $totalItems, $paginator, $query);
+        
+        $response = $this->onPostIndexFetchQuery($action, $request, $_format, $totalItems, 
+            $paginator, $entities);
+        
+        if ($response instanceof Response) {
+            return $response;
+        }
+        
+        return $this->serializeCollectionItems($action, $request, $_format, $paginator, $entities);    
+    }
+    
+    /**
+     * Serialize collections
+     *
+     */
+    protected function serializeCollectionItems(string $action, Request $request, string $_format, PaginatorInterface $paginator, $entities): Response
+    {
+        $model = new Collection($entities, $paginator); 
+
+        return $this->json($model);
+    }
+    
 
     protected function getContextForSerialization(string $action, Request $request, $entity, $_format): array
     {
@@ -103,8 +209,8 @@ class ApiController extends AbstractCRUDController
             return $actionConfig['roles'][$request->getMethod()];
         }
 
-        if ($this->crudConfig['role']) {
-            return $this->crudConfig['role'];
+        if ($this->crudConfig['base_role']) {
+            return $this->crudConfig['base_role'];
         }
 
         throw new \RuntimeException(sprintf("the config does not have any role for the ".