Proof of concept for Columns as a Service

Datatable/AbstractDatatable.php

@@ -173,7 +173,8 @@ public function __construct(
         TranslatorInterface $translator,
         RouterInterface $router,
         EntityManagerInterface $em,
-        Twig_Environment $twig
+        Twig_Environment $twig,
+        $columns
     ) {
         $this->validateName();
 
@@ -191,7 +192,7 @@ public function __construct(
         $this->twig = $twig;
 
         $metadata = $em->getClassMetadata($this->getEntity());
-        $this->columnBuilder = new ColumnBuilder($metadata, $twig, $this->getName(), $em);
+        $this->columnBuilder = new ColumnBuilder($metadata, $twig, $this->getName(), $em, $columns);
 
         $this->ajax = new Ajax();
         $this->options = new Options();

Datatable/Column/ColumnBuilder.php

@@ -11,11 +11,10 @@
 
 namespace Sg\DatatablesBundle\Datatable\Column;
 
-use Sg\DatatablesBundle\Datatable\Factory;
-
 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\MappingException;
 use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
 use Twig_Environment;
 use Exception;
 
@@ -83,6 +82,12 @@ class ColumnBuilder
      */
     private $entityClassName;
 
+    /**
+     * Column services
+     *
+     * @var \Symfony\Component\DependencyInjection\Argument\RewindableGenerator
+     */
+    private $columnTypes;
     //-------------------------------------------------
     // Ctor.
     //-------------------------------------------------
@@ -94,8 +99,9 @@ class ColumnBuilder
      * @param Twig_Environment       $twig
      * @param string                 $datatableName
      * @param EntityManagerInterface $em
+     * @param RewindableGenerator    $columnTypes
      */
-    public function __construct(ClassMetadata $metadata, Twig_Environment $twig, $datatableName, EntityManagerInterface $em)
+    public function __construct(ClassMetadata $metadata, Twig_Environment $twig, $datatableName, EntityManagerInterface $em, $columnTypes)
     {
         $this->metadata = $metadata;
         $this->twig = $twig;
@@ -106,6 +112,7 @@ public function __construct(ClassMetadata $metadata, Twig_Environment $twig, $da
         $this->columnNames = array();
         $this->uniqueColumns = array();
         $this->entityClassName = $metadata->getName();
+        $this->columnTypes = $columnTypes;
     }
 
     //-------------------------------------------------
@@ -124,7 +131,20 @@ public function __construct(ClassMetadata $metadata, Twig_Environment $twig, $da
      */
     public function add($dql, $class, array $options = array())
     {
-        $column = Factory::create($class, ColumnInterface::class);
+        if (is_object($class)) {
+            throw new \RuntimeException('Use FCQN instead of object: ' . get_class($class));
+        }
+
+        $columns = [];
+        foreach ($this->columnTypes as $column) {
+            $columns[get_class($column)] = $column;
+        }
+
+        if (! array_key_exists($class, $columns)) {
+            throw new \RuntimeException(sprintf('Column %s is not a service', $class));
+        }
+
+        $column = clone $columns[$class];
         $column->initOptions();
 
         $this->handleDqlProperties($dql, $options, $column);

DependencyInjection/SgDatatablesExtension.php

@@ -11,6 +11,7 @@
 
 namespace Sg\DatatablesBundle\DependencyInjection;
 
+use Sg\DatatablesBundle\Datatable\Column\ColumnInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
@@ -36,6 +37,9 @@ public function load(array $configs, ContainerBuilder $container)
         $loader->load('services.yml');
 
         $container->setParameter('sg_datatables.datatable.query', $config['datatable']['query']);
+        $container->registerForAutoconfiguration(ColumnInterface::class)
+                  ->addTag('sg_datatables.column')
+        ;
     }
 
     /**

Resources/config/services.yml

@@ -1,12 +1,16 @@
 services:
-    sg_datatables.twig.extension:
-        class: Sg\DatatablesBundle\Twig\DatatableTwigExtension
-        public: false
-        tags:
-            - { name: twig.extension }
+    _defaults:
+        autoconfigure: true
+        autowire: true
 
-    sg_datatables.datatable.abstract:
-        class: Sg\DatatablesBundle\Datatable\AbstractDatatable
+    _instanceof:
+        Sg\DatatablesBundle\Datatable\Column\Column:
+            tags: ['sg_datatables.column']
+
+    Sg\DatatablesBundle\Datatable\Column\:
+        resource: '../../Datatable/Column/*'
+
+    Sg\DatatablesBundle\Datatable\AbstractDatatable:
         abstract: true
         arguments:
             - '@security.authorization_checker'
@@ -15,15 +19,14 @@ services:
             - '@router'
             - '@doctrine.orm.entity_manager'
             - '@twig'
+            - ! tagged sg_datatables.column
 
-    sg_datatables.response:
-        class: Sg\DatatablesBundle\Response\DatatableResponse
+    Sg\DatatablesBundle\Response\DatatableResponse:
         public: true
         arguments:
             - '@request_stack'
 
-    sg_datatables.factory:
-        class: Sg\DatatablesBundle\Datatable\DatatableFactory
+    Sg\DatatablesBundle\Datatable\DatatableFactory:
         public: true
         arguments:
             - '@security.authorization_checker'
@@ -32,3 +35,5 @@ services:
             - '@router'
             - '@doctrine.orm.entity_manager'
             - '@twig'
+
+    Sg\DatatablesBundle\Twig\DatatableTwigExtension: ~

Resources/doc/cache.md

@@ -12,9 +12,10 @@ Doctrine Query when creating response for DataTable.
 
 ``` php
 <?php
+use Sg\DatatablesBundle\Response\DatatableResponse;
 // ...
 if ($isAjax) {
-    $responseService = $this->get('sg_datatables.response');
+    $responseService = $this->get(DatatableResponse::class);
     $responseService->setDatatable($datatable);
 
     $datatableQueryBuilder = $responseService->getDatatableQueryBuilder();

Resources/doc/installation.md

@@ -365,14 +365,19 @@ class PostDatatable extends AbstractDatatable
 # app/config/services.yml
 
 services:
-    app.datatable.post:
-        class: AppBundle\Datatables\PostDatatable
-        parent: sg_datatables.datatable.abstract
+    _defaults:
+        autoconfigure: true
+        autowire: true
+    AppBundle\Datatables\PostDatatable:
+      bind:
+        $columns: !tagged sg_datatables.column
 ```
 
 ### Step 3: The Controller actions
 
 ``` php
+use Sg\DatatablesBundle\Datatable\DatatableFactory;
+use Sg\DatatablesBundle\Response\DatatableResponse;
 /**
  * Lists all Post entities.
  *
@@ -393,11 +398,11 @@ public function indexAction(Request $request)
 
     // or use the DatatableFactory
     /** @var DatatableInterface $datatable */
-    $datatable = $this->get('sg_datatables.factory')->create(PostDatatable::class);
+    $datatable = $this->get(DatatableFactory::class)->create(PostDatatable::class);
     $datatable->buildDatatable();
 
     if ($isAjax) {
-        $responseService = $this->get('sg_datatables.response');
+        $responseService = $this->get(DatatableResponse::class);
         $responseService->setDatatable($datatable);
         $responseService->getDatatableQueryBuilder();
 

Resources/doc/query.md

@@ -40,12 +40,14 @@ class Post
 Now you can view all posts created by `root`. The additional `where statement` now works like a filter.
 
 ``` php
+use Sg\DatatablesBundle\Response\DatatableResponse;
+
 public function indexAction(Request $request)
 {
     // ...
 
     if ($request->isXmlHttpRequest()) {
-        $responseService = $this->get('sg_datatables.response');
+        $responseService = $this->get(DatatableResponse::class);
         $responseService->setDatatable($datatable);
 
         $datatableQueryBuilder = $responseService->getDatatableQueryBuilder();