src/Diplix/KMGBundle/DataTables/DataTablesHelper.php line 274

Open in your IDE?
  1. <?php
  2. namespace Diplix\KMGBundle\DataTables;
  4. use Diplix\KMGBundle\DataTables\Expr\ExprStub;
  5. use Doctrine\ORM\Query\Expr\Andx;
  6. use Doctrine\ORM\Query\Expr\Orx;
  7. use Doctrine\ORM\QueryBuilder;
  8. use Symfony\Component\HttpFoundation\Request;
  9. use Symfony\Component\HttpFoundation\Response;
  11. /**
  12.  * (c) C.Schmidhuber, Version Nov2018
  13.  * Class DataTablesHelper
  14.  * @package Diplix\KMGBundle\DataTables
  15.  */
  16. class DataTablesHelper
  17. {
  18.     const T_RAW = "";
  19.     const T_BUTTONS = "action_buttons";
  20.     const T_SELECTOR = "selectorcheckbox";
  21.     const T_CSSICON = "cssicon";
  22.     const T_COMMENT = "comment";
  24.     // the default setup for a single column
  25.     public static $defaultSetup = array(
  26.         "fieldName"=>null,  // the name of the database field
  27.         "caption"=>null,    // the head title for the html table
  28.         "virtual"=>false,   // set to true to exclude from default filter handling
  29.         "searchable"=>true, // allow searching
  30.         "searchWithLike"=>true, // use like for field-specific search
  31.         "sortable"=>true,   // allow sorting for the column
  32.         "visible"=>true,    // show/hide columns,
  33.         "footer"=>false,    // add .nofooter class to footer cell
  34.         "type"=>self::T_RAW,// display type
  35.         "headStyle"=>"",    // additional styles for the th-tag
  36.     );
  38.     /** @var array Our complete setup*/
  39.     protected $columnSetup = array(
  40.         "columns" => array(),
  41.         "ajaxUrl"=>null,
  42.         "ajaxData"=>null,
  43.         "ajaxType"=>null, // GET / POST
  44.         "deferLoading"=>null,
  45.         "defaultSorting"=>null,
  46.         "searching"=>true,      // https://datatables.net/reference/option/searching
  47.         "autoCaptionPrefix"=>"th.",
  48.         "addTableClass" => "",
  49.         "addTableStyle" => "",
  50.         'stateSave' => false,
  51.         'stateContext' => null,
  52.     );
  54.     /**
  55.      * @var QueryBuilder
  56.      */
  57.     protected $queryBuilder;
  59.     protected $additionalOrX = [];
  60.     protected $additionalAndX = [];
  61.     protected $additionalParams = [];
  62.     protected $additionalOrdering = [];
  63.     protected $primaryOrdering = [];
  65.     /**
  66.      * DataTablesHelper constructor.
  67.      * @param array $columSetup see self::$defaultSetup for parameters
  68.      * @throws \Exception
  69.      */
  70.     public function __construct(array $columnSetup,$options=array())
  71.     {
  72.         // take column settings
  73.         foreach ($columnSetup as $idx=>$arr)
  74.         {
  75.             // check for unknown fields
  76.             if (count(array_diff_key($arr,self::$defaultSetup))>0)
  77.             {
  78.                 throw new \Exception(sprintf("columnSetup[%d] includes unknown fields",$idx));
  79.             }
  80.             // diverging default values for special types
  81.             if (isset($arr["type"]))
  82.             {
  83.                 if ($arr["type"]==self::T_BUTTONS) $arr = array_merge(array("sortable"=>false,"searchable"=>false),$arr);
  84.                 if ($arr["type"]==self::T_SELECTOR) $arr = array_merge(array("sortable"=>false,"searchable"=>false),$arr);
  85.                 if ($arr["type"]==self::T_COMMENT)  $arr = array_merge(array("searchable"=>false),$arr);
  86.             }
  87.             // fill missing fields with default values
  88.             $this->columnSetup["columns"][$idx] = array_merge(self::$defaultSetup,$arr);
  89.         }
  90.         // take other settings
  91.         if (count($options)>0)
  92.         foreach ($options as $k=>$o)
  93.         {
  94.             if (array_key_exists($k,$this->columnSetup))
  95.             {
  96.                 $this->columnSetup[$k] = $o;
  97.             }
  98.             else
  99.             {
  100.                 throw new \Exception(sprintf("Unknown parameter: %s",$k));
  101.             }
  102.         }
  103.     }
  105.     public function setQueryBuilder(QueryBuilder $queryBuilder)
  106.     {
  107.         $this->queryBuilder = $queryBuilder;
  108.     }
  110.     public function processRequest(Request $request)
  111.     {
  112.         $req = array_merge($request->query->all() , $request->request->all());
  113.         $this->addRequestParametersToDbQuery($this->queryBuilder,$this->columnSetup["columns"],$req);
  114.     }
  116.     public function getColumnSetup()
  117.     {
  118.         return $this->columnSetup;
  119.     }
  121.     protected function makeCaptionFromFieldName($fieldName)
  122.     {
  123.         $caption = "";
  124.         // remove entity reference part before the dot
  125.         $dp = strrpos($fieldName,".");
  126.         if ($dp!==false) $fieldName = substr($fieldName,$dp+1);
  127.         // transform
  128.         $len = strlen($fieldName);
  129.             for ($i = 0; $i < $len; ++$i) {
  130.                 if (ctype_upper($fieldName[$i])) {
  131.                     $caption .= ' '.$fieldName[$i];
  132.                 } else {
  133.                     $caption .= strtolower($fieldName[$i]);
  134.                 }
  135.             }
  136.         return ucfirst($caption);
  137.     }
  139.     public function addOr($expr,$params=[])
  140.     {
  141.         if (!is_array($expr)) $expr = [ $expr ];
  142.         foreach ($expr as $x)
  143.         {
  144.             $this->additionalOrX[]= $x;
  145.         }
  146.         $this->additionalParams = array_merge($this->additionalParams,$params);
  147.     }
  149.     public function addAnd($expr,$params=[])
  150.     {
  151.         if (!is_array($expr)) $expr = [ $expr ];
  152.         foreach ($expr as $x)
  153.         {
  154.             $this->additionalAndX[]= $x;
  155.         }
  156.         $this->additionalParams = array_merge($this->additionalParams,$params);
  157.     }
  159.     public function addOrderBy($expr,$order)
  160.     {
  161.         $this->additionalOrdering[$expr] = $order;
  162.     }
  164.     public function addPrimaryOrderBy($expr,$order)
  165.     {
  166.         $this->primaryOrdering[$expr] = $order;
  167.     }
  169.     /**
  170.      * @param \Doctrine\ORM\QueryBuilder $cb
  171.      * @param $knownColumns array
  172.      * @param $req array array containing the request parameters ($request->query->all())
  173.      */
  174.     protected function addRequestParametersToDbQuery(\Doctrine\ORM\QueryBuilder $cb, $knownColumns, $req )
  175.     {
  176.         $dtColumns = (array)$req['columns'];    // the columns known to datatables js
  177.         $params = array();
  179.         // filtering (global search)
  180.         $orLikes = array();
  181.         if ((isset($req['search']['value']))&&(strlen(trim($req['search']['value']))>0))
  182.         {
  183.             foreach ($dtColumns as $k=>$e)
  184.             {
  185.                 if ($knownColumns[$k]["virtual"]) continue; // virtual fields have to processed manually
  186.                 if (($e["searchable"]=="true")&&($knownColumns[$k]["searchable"]))
  187.                 {
  188.                     $orLikes[] =  $cb->expr()->like($knownColumns[$k]["fieldName"], ":orlike".$k );
  189.                     $params["orlike".$k] = "%".addcslashes($req['search']['value'], "%_")."%";
  190.                 }
  191.             }
  192.         }
  193.         $orLikes2 = array_merge( $orLikes , $this->additionalOrX  );
  194.         if (count($orLikes2)>0) $cb->andWhere(new Orx($orLikes2));
  196.         // filtering (field-wise search, not taking into account the actual field type)
  197.         $andLikes = array();
  198.         foreach($dtColumns as $k=>$e)
  199.         {
  200.             if ($knownColumns[$k]["virtual"]) continue; // virtual fields have to processed manually
  201.             if (($e['searchable']=="true") && ($knownColumns[$k]["searchable"]) && (trim($e['search']['value'])!=""))
  202.             {
  203.                 if ($knownColumns[$k]["searchWithLike"])
  204.                 {
  205.                     $andLikes[] = $cb->expr()->like($knownColumns[$k]["fieldName"], ":andlike".$k );
  206.                     $params["andlike".$k] = "%".addcslashes($e['search']['value'], "%_")."%";
  207.                 }
  208.                 else
  209.                 {
  210.                 $andLikes[]= $cb->expr()->eq($knownColumns[$k]["fieldName"], ":andlike".$k);
  211.                 $params["andlike".$k] = $e['search']['value'];
  212.             }
  213.         }
  214.         }
  215.         $andLikes2 = array_merge($andLikes, $this->additionalAndX);
  216.         if (count($andLikes2)>0) $cb->andWhere(new Andx($andLikes2));
  218.         foreach ( array_merge($params,$this->additionalParams) as $k=>$e)
  219.         {
  220.             $cb->setParameter($k,$e);
  221.         }
  223.         // ordering
  225.         foreach ($this->primaryOrdering as $expr => $order)
  226.         {
  227.             $cb->addOrderBy($expr,$order);
  228.         }
  230.         if (isset($req['order']))
  231.         {
  232.             $order = (array)$req['order'];
  233.             if (count($order)>0)
  234.             foreach ($order as $o)
  235.             if ( (array_key_exists($o["column"],$knownColumns)) && ($knownColumns[$o["column"]]["sortable"]) )
  236.             {
  237.                 if ($knownColumns[$o['column']]["virtual"]) continue; // virtual fields have to processed manually
  238.                 $cb->addOrderBy( $knownColumns[$o['column']]["fieldName"] , $o['dir']);
  239.             }
  240.         }
  242.         foreach ($this->additionalOrdering as $expr => $order)
  243.         {
  244.             $cb->addOrderBy($expr,$order);
  245.         }
  247.          // paging
  248.         if (isset($req['start'])) $cb->setFirstResult($req['start']);
  249.         if ( (isset($req['length'])) && ($req['length']>0)) $cb->setMaxResults($req['length']);
  250.     }
  252.     public function getRawColumnOrder($req)
  253.     {
  254.         $raw = [];
  255.         $knownColumns = $this->columnSetup["columns"];
  256.         if (isset($req['order']))
  257.         {
  258.             $order = (array)$req['order'];
  259.             if (count($order) > 0)
  260.                 foreach ($order as $o)
  261.                     if ((array_key_exists($o["column"], $knownColumns)))
  262.                     {
  263.                         $raw[$o['column']] = $o["dir"];
  264.                     }
  265.         }
  266.         return $raw;
  267.     }
  269.     protected function getUniqueName()
  270.     {
  271.         return "param".rand(1000,9999);
  272.     }
  274.     public function addSimpleFilter($colIndex,$req,$order,$orX=[],$orderExpr,$weak=false,$includedToGlobal=true)
  275.     {
  276.         if (count($orX)>0)
  277.         {
  278.             // column specific search means the search term has to be there (AND)
  279.             if ($colIndex>=0)
  280.             {
  281.                 $column = $req["columns"][$colIndex];
  282.                 $reqFilter = (isset($column["search"]["value"]) ? $column["search"]["value"] : "");
  284.                 if ($reqFilter!="")
  285.                 {
  286.                     if ($weak) $reqFilter = "%".addcslashes($reqFilter, "%_")."%";
  287.                     $u = $this->getUniqueName();
  288.                     $parts = [];
  289.                     /** @var ExprStub[] $orX  */
  290.                     for ($i=0;$i<count($orX);$i++) $parts[]= $orX[$i]->resurrect(":".$u);
  291.                     $this->addAnd(new OrX($parts), [$u=>$reqFilter]);
  292.                 }
  293.             }
  295.             if ($includedToGlobal)
  296.             {
  297.                 // global search filter just looks for matches everywhere (OR)
  298.                 $optFilter = $req["search"]["value"];
  299.                 if ($optFilter!="")
  300.                 {
  301.                     if ($weak) $optFilter = "%".addcslashes($optFilter, "%_")."%";
  302.                     $u = $this->getUniqueName();
  303.                     $parts = [];
  304.                     /** @var ExprStub[] $orX  */
  305.                     for ($i=0;$i<count($orX);$i++) $parts[] = $orX[$i]->resurrect(":".$u);
  306.                     $this->addOr(new OrX($parts), [$u=>$optFilter]);
  307.                 }
  308.             }
  309.         }
  311.         if (array_key_exists($colIndex,$order))
  312.         {
  313.             $this->addOrderBy($orderExpr,$order[$colIndex]);
  314.         }
  315.     }
  317.     public function output($draw,$totalRecordCount,$filteredRecordCount, array $data, ?Request $request, $httpResponseCode = Response::HTTP_OK ): Response
  318.     {
  319.         $output = array(
  320.             "draw" => $draw,
  321.             "recordsTotal"=>$totalRecordCount,
  322.             "recordsFiltered"=>$filteredRecordCount,
  323.             "data" => $data, // TODO: security update -- $this->filterTableDataResult($data)
  324.         );
  326.         $resp = new Response(
  327.             json_encode($output, JSON_THROW_ON_ERROR),
  328.             $httpResponseCode,
  329.             array(
  330.                 'content-type'=> 'text/plain',// Use plain browser-wide and let the js assume that the format will be json - this seems to work with every browser
  331.                 'cache-control'=>'no-store, no-cache, must-revalidate',
  332.                 'pragma'=>'no-cache'));
  333.         if ($request!==null)
  334.         {
  335.             $resp->prepare($request);
  336.         }
  337.         $resp->setCache(array('last_modified' => new \DateTime()));
  338.         $resp->expire();
  339.         return $resp;
  340.     }
  341. }