vendor/sg/datatablesbundle/Response/DatatableFormatter.php line 87

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the SgDatatablesBundle package.
  5.  *
  6.  * (c) stwe <https://github.com/stwe/DatatablesBundle>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Sg\DatatablesBundle\Response;
  14. use Doctrine\ORM\Tools\Pagination\Paginator;
  15. use Sg\DatatablesBundle\Datatable\Column\ColumnInterface;
  16. use Sg\DatatablesBundle\Datatable\DatatableInterface;
  17. use Symfony\Component\PropertyAccess\PropertyAccess;
  18. use Symfony\Component\PropertyAccess\PropertyAccessor;
  20. class DatatableFormatter
  21. {
  22.     /**
  23.      * The output array.
  24.      *
  25.      * @var array
  26.      */
  27.     private $output;
  29.     /**
  30.      * The PropertyAccessor.
  31.      * Provides functions to read and write from/to an object or array using a simple string notation.
  32.      *
  33.      * @var PropertyAccessor
  34.      */
  35.     private $accessor;
  37.     public function __construct()
  38.     {
  39.         $this->output = ['data' => []];
  41.         $this->accessor = PropertyAccess::createPropertyAccessor();
  42.     }
  44.     //-------------------------------------------------
  45.     // Formatter
  46.     //-------------------------------------------------
  48.     /**
  49.      * Create the output array.
  50.      */
  51.     public function runFormatter(Paginator $paginator, DatatableInterface $datatable)
  52.     {
  53.         $lineFormatter = $datatable->getLineFormatter();
  54.         $columns = $datatable->getColumnBuilder()->getColumns();
  56.         foreach ($paginator as $row) {
  57.             // Adding custom DQL fields make PARTIAL columns stored in key 0
  58.             if (isset($row[0])) {
  59.                 $row = array_merge($row, $row[0]);
  60.                 unset($row[0]);
  61.             }
  63.             // Format custom DQL fields output ('custom.dql.name' => $row['custom']['dql']['name'] = 'value')
  64.             foreach ($columns as $column) {
  65.                 // @noinspection PhpUndefinedMethodInspection
  66.                 if (true === $column->isCustomDql()) {
  67.                     /** @noinspection PhpUndefinedMethodInspection */
  68.                     $columnAlias = str_replace('.', '_', $column->getData());
  69.                     /** @noinspection PhpUndefinedMethodInspection */
  70.                     $columnPath = '['.str_replace('.', '][', $column->getData()).']';
  71.                     // @noinspection PhpUndefinedMethodInspection
  72.                     if ($columnAlias !== $column->getData()) {
  73.                         $this->accessor->setValue($row, $columnPath, $row[$columnAlias]);
  74.                         unset($row[$columnAlias]);
  75.                     }
  76.                 }
  77.             }
  79.             // 1. Set (if necessary) the custom data source for the Columns with a 'data' option
  80.             foreach ($columns as $column) {
  81.                 /** @noinspection PhpUndefinedMethodInspection */
  82.                 $dql = $column->getDql();
  83.                 /** @noinspection PhpUndefinedMethodInspection */
  84.                 $data = $column->getData();
  86.                 // @noinspection PhpUndefinedMethodInspection
  87.                 if (false === $column->isAssociation()) {
  88.                     if (null !== $dql && $dql !== $data && false === \array_key_exists($data, $row)) {
  89.                         $row[$data] = $row[$dql];
  90.                         unset($row[$dql]);
  91.                     }
  92.                 }
  93.             }
  95.             // 2. Call the the lineFormatter to format row items
  96.             if (null !== $lineFormatter && \is_callable($lineFormatter)) {
  97.                 $row = \call_user_func($datatable->getLineFormatter(), $row);
  98.             }
  100.             /** @var ColumnInterface $column */
  101.             foreach ($columns as $column) {
  102.                 // 3. Add some special data to the output array. For example, the visibility of actions.
  103.                 $column->addDataToOutputArray($row);
  104.                 // 4. Call Columns renderContent method to format row items (e.g. for images or boolean values)
  105.                 $column->renderCellContent($row);
  106.             }
  108.             foreach ($columns as $column) {
  109.                 if (! $column->getSentInResponse()) {
  110.                     unset($row[$column->getDql()]);
  111.                 }
  112.             }
  114.             $this->output['data'][] = $row;
  115.         }
  116.     }
  118.     //-------------------------------------------------
  119.     // Getters && Setters
  120.     //-------------------------------------------------
  122.     /**
  123.      * @return array
  124.      */
  125.     public function getOutput()
  126.     {
  127.         return $this->output;
  128.     }
  129. }