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

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;
  10. /**
  11.  * (c) C.Schmidhuber, Version Nov2018
  12.  * Class DataTablesHelper
  13.  * @package Diplix\KMGBundle\DataTables
  14.  */
  15. class DataTablesHelper
  16. {
  17.     const T_RAW = "";
  18.     const T_BUTTONS = "action_buttons";
  19.     const T_SELECTOR = "selectorcheckbox";
  20.     const T_CSSICON = "cssicon";
  21.     const T_COMMENT = "comment";
  23.     // the default setup for a single column
  24.     public static $defaultSetup = array(
  25.         "fieldName"=>null,  // the name of the database field
  26.         "caption"=>null,    // the head title for the html table
  27.         "virtual"=>false,   // set to true to exclude from default filter handling
  28.         "searchable"=>true, // allow searching
  29.         "searchWithLike"=>true, // use like for field-specific search
  30.         "sortable"=>true,   // allow sorting for the column
  31.         "visible"=>true,    // show/hide columns,
  32.         "footer"=>false,    // add .nofooter class to footer cell
  33.         "type"=>self::T_RAW,// display type
  34.         "headStyle"=>"",    // additional styles for the th-tag
  35.     );
  37.     /** @var array Our complete setup*/
  38.     protected $columnSetup = array(
  39.         "columns" => array(),
  40.         "ajaxUrl"=>null,
  41.         "ajaxData"=>null,
  42.         "ajaxType"=>null, // GET / POST
  43.         "deferLoading"=>null,
  44.         "defaultSorting"=>null,
  45.         "searching"=>true,      // https://datatables.net/reference/option/searching
  46.         "autoCaptionPrefix"=>"th.",
  47.         "addTableClass" => "",
  48.         "addTableStyle" => "",
  49.         'stateSave' => false,
  50.         'stateContext' => null,
  51.     );
  53.     /**
  54.      * @var QueryBuilder
  55.      */
  56.     protected $queryBuilder;
  58.     protected $additionalOrX = [];
  59.     protected $additionalAndX = [];
  60.     protected $additionalParams = [];
  61.     protected $additionalOrdering = [];
  62.     protected $primaryOrdering = [];
  64.     /**
  65.      * DataTablesHelper constructor.
  66.      * @param array $columSetup see self::$defaultSetup for parameters
  67.      * @throws \Exception
  68.      */
  69.     public function __construct(array $columnSetup,$options=array())
  70.     {
  71.         // take column settings
  72.         foreach ($columnSetup as $idx=>$arr)
  73.         {
  74.             // check for unknown fields
  75.             if (count(array_diff_key($arr,self::$defaultSetup))>0)
  76.             {
  77.                 throw new \Exception(sprintf("columnSetup[%d] includes unknown fields",$idx));
  78.             }
  79.             // diverging default values for special types
  80.             if (isset($arr["type"]))
  81.             {
  82.                 if ($arr["type"]==self::T_BUTTONS) $arr = array_merge(array("sortable"=>false,"searchable"=>false),$arr);
  83.                 if ($arr["type"]==self::T_SELECTOR) $arr = array_merge(array("sortable"=>false,"searchable"=>false),$arr);
  84.                 if ($arr["type"]==self::T_COMMENT)  $arr = array_merge(array("searchable"=>false),$arr);
  85.             }
  86.             // fill missing fields with default values
  87.             $this->columnSetup["columns"][$idx] = array_merge(self::$defaultSetup,$arr);
  88.         }
  89.         // take other settings
  90.         if (count($options)>0)
  91.         foreach ($options as $k=>$o)
  92.         {
  93.             if (array_key_exists($k,$this->columnSetup))
  94.             {
  95.                 $this->columnSetup[$k] = $o;
  96.             }
  97.             else
  98.             {
  99.                 throw new \Exception(sprintf("Unknown parameter: %s",$k));
  100.             }
  101.         }
  102.     }
  104.     public function setQueryBuilder(QueryBuilder $queryBuilder)
  105.     {
  106.         $this->queryBuilder = $queryBuilder;
  107.     }
  109.     public function processRequest(Request $request)
  110.     {
  111.         $req = array_merge($request->query->all() , $request->request->all());
  112.         $this->addRequestParametersToDbQuery($this->queryBuilder,$this->columnSetup["columns"],$req);
  113.     }
  115.     public function getColumnSetup()
  116.     {
  117.         return $this->columnSetup;
  118.     }
  120.     protected function makeCaptionFromFieldName($fieldName)
  121.     {
  122.         $caption = "";
  123.         // remove entity reference part before the dot
  124.         $dp = strrpos($fieldName,".");
  125.         if ($dp!==false) $fieldName = substr($fieldName,$dp+1);
  126.         // transform
  127.         $len = strlen($fieldName);
  128.             for ($i = 0; $i < $len; ++$i) {
  129.                 if (ctype_upper($fieldName[$i])) {
  130.                     $caption .= ' '.$fieldName[$i];
  131.                 } else {
  132.                     $caption .= strtolower($fieldName[$i]);
  133.                 }
  134.             }
  135.         return ucfirst($caption);
  136.     }
  138.     public function addOr($expr,$params=[])
  139.     {
  140.         if (!is_array($expr)) $expr = [ $expr ];
  141.         foreach ($expr as $x)
  142.         {
  143.             $this->additionalOrX[]= $x;
  144.         }
  145.         $this->additionalParams = array_merge($this->additionalParams,$params);
  146.     }
  148.     public function addAnd($expr,$params=[])
  149.     {
  150.         if (!is_array($expr)) $expr = [ $expr ];
  151.         foreach ($expr as $x)
  152.         {
  153.             $this->additionalAndX[]= $x;
  154.         }
  155.         $this->additionalParams = array_merge($this->additionalParams,$params);
  156.     }
  158.     public function addOrderBy($expr,$order)
  159.     {
  160.         $this->additionalOrdering[$expr] = $order;
  161.     }
  163.     public function addPrimaryOrderBy($expr,$order)
  164.     {
  165.         $this->primaryOrdering[$expr] = $order;
  166.     }
  168.     /**
  169.      * @param \Doctrine\ORM\QueryBuilder $cb
  170.      * @param $knownColumns array
  171.      * @param $req array array containing the request parameters ($request->query->all())
  172.      */
  173.     protected function addRequestParametersToDbQuery(\Doctrine\ORM\QueryBuilder $cb, $knownColumns, $req )
  174.     {
  175.         $dtColumns = (array)$req['columns'];    // the columns known to datatables js
  176.         $params = array();
  178.         // filtering (global search)
  179.         $orLikes = array();
  180.         if ((isset($req['search']['value']))&&(strlen(trim($req['search']['value']))>0))
  181.         {
  182.             foreach ($dtColumns as $k=>$e)
  183.             {
  184.                 if ($knownColumns[$k]["virtual"]) continue; // virtual fields have to processed manually
  185.                 if (($e["searchable"]=="true")&&($knownColumns[$k]["searchable"]))
  186.                 {
  187.                     $orLikes[] =  $cb->expr()->like($knownColumns[$k]["fieldName"], ":orlike".$k );
  188.                     $params["orlike".$k] = "%".addcslashes($req['search']['value'], "%_")."%";
  189.                 }
  190.             }
  191.         }
  192.         $orLikes2 = array_merge( $orLikes , $this->additionalOrX  );
  193.         if (count($orLikes2)>0) $cb->andWhere(new Orx($orLikes2));
  195.         // filtering (field-wise search, not taking into account the actual field type)
  196.         $andLikes = array();
  197.         foreach($dtColumns as $k=>$e)
  198.         {
  199.             if ($knownColumns[$k]["virtual"]) continue; // virtual fields have to processed manually
  200.             if (($e['searchable']=="true") && ($knownColumns[$k]["searchable"]) && (trim($e['search']['value'])!=""))
  201.             {
  202.                 if ($knownColumns[$k]["searchWithLike"])
  203.                 {
  204.                     $andLikes[] = $cb->expr()->like($knownColumns[$k]["fieldName"], ":andlike".$k );
  205.                     $params["andlike".$k] = "%".addcslashes($e['search']['value'], "%_")."%";
  206.                 }
  207.                 else
  208.                 {
  209.                 $andLikes[]= $cb->expr()->eq($knownColumns[$k]["fieldName"], ":andlike".$k);
  210.                 $params["andlike".$k] = $e['search']['value'];
  211.             }
  212.         }
  213.         }
  214.         $andLikes2 = array_merge($andLikes, $this->additionalAndX);
  215.         if (count($andLikes2)>0) $cb->andWhere(new Andx($andLikes2));
  217.         foreach ( array_merge($params,$this->additionalParams) as $k=>$e)
  218.         {
  219.             $cb->setParameter($k,$e);
  220.         }
  222.         // ordering
  224.         foreach ($this->primaryOrdering as $expr => $order)
  225.         {
  226.             $cb->addOrderBy($expr,$order);
  227.         }
  229.         if (isset($req['order']))
  230.         {
  231.             $order = (array)$req['order'];
  232.             if (count($order)>0)
  233.             foreach ($order as $o)
  234.             if ( (array_key_exists($o["column"],$knownColumns)) && ($knownColumns[$o["column"]]["sortable"]) )
  235.             {
  236.                 if ($knownColumns[$o['column']]["virtual"]) continue; // virtual fields have to processed manually
  237.                 $cb->addOrderBy( $knownColumns[$o['column']]["fieldName"] , $o['dir']);
  238.             }
  239.         }
  241.         foreach ($this->additionalOrdering as $expr => $order)
  242.         {
  243.             $cb->addOrderBy($expr,$order);
  244.         }
  246.          // paging
  247.         if (isset($req['start'])) $cb->setFirstResult($req['start']);
  248.         if ( (isset($req['length'])) && ($req['length']>0)) $cb->setMaxResults($req['length']);
  249.     }
  251.     public function getRawColumnOrder($req)
  252.     {
  253.         $raw = [];
  254.         $knownColumns = $this->columnSetup["columns"];
  255.         if (isset($req['order']))
  256.         {
  257.             $order = (array)$req['order'];
  258.             if (count($order) > 0)
  259.                 foreach ($order as $o)
  260.                     if ((array_key_exists($o["column"], $knownColumns)))
  261.                     {
  262.                         $raw[$o['column']] = $o["dir"];
  263.                     }
  264.         }
  265.         return $raw;
  266.     }
  268.     protected function getUniqueName()
  269.     {
  270.         return "param".rand(1000,9999);
  271.     }
  273.     public function addSimpleFilter($colIndex,$req,$order,$orX=[],$orderExpr,$weak=false,$includedToGlobal=true)
  274.     {
  275.         if (count($orX)>0)
  276.         {
  277.             // column specific search means the search term has to be there (AND)
  278.             if ($colIndex>=0)
  279.             {
  280.                 $column = $req["columns"][$colIndex];
  281.                 $reqFilter = (isset($column["search"]["value"]) ? $column["search"]["value"] : "");
  283.                 if ($reqFilter!="")
  284.                 {
  285.                     if ($weak) $reqFilter = "%".addcslashes($reqFilter, "%_")."%";
  286.                     $u = $this->getUniqueName();
  287.                     $parts = [];
  288.                     /** @var ExprStub[] $orX  */
  289.                     for ($i=0;$i<count($orX);$i++) $parts[]= $orX[$i]->resurrect(":".$u);
  290.                     $this->addAnd(new OrX($parts), [$u=>$reqFilter]);
  291.                 }
  292.             }
  294.             if ($includedToGlobal)
  295.             {
  296.                 // global search filter just looks for matches everywhere (OR)
  297.                 $optFilter = $req["search"]["value"];
  298.                 if ($optFilter!="")
  299.                 {
  300.                     if ($weak) $optFilter = "%".addcslashes($optFilter, "%_")."%";
  301.                     $u = $this->getUniqueName();
  302.                     $parts = [];
  303.                     /** @var ExprStub[] $orX  */
  304.                     for ($i=0;$i<count($orX);$i++) $parts[] = $orX[$i]->resurrect(":".$u);
  305.                     $this->addOr(new OrX($parts), [$u=>$optFilter]);
  306.                 }
  307.             }
  308.         }
  310.         if (array_key_exists($colIndex,$order))
  311.         {
  312.             $this->addOrderBy($orderExpr,$order[$colIndex]);
  313.         }
  314.     }
  315. }