Merge PR stwe#820 support for join conditions (using 'WITH').

Author: pokurek

Datatable/Column/AbstractColumn.php

@@ -189,6 +189,14 @@ abstract class AbstractColumn implements ColumnInterface
      */
     protected $joinType;
 
+    /**
+     * Join conditions, if the column represents an association.
+     * Default: null
+     *
+     * @var string|null
+     */
+    protected $joinConditions;
+    
     /**
      * The data type of the column.
      * Is set automatically in ColumnBuilder when 'null'.
@@ -323,6 +331,7 @@ public function configureOptions(OptionsResolver $resolver)
             'width' => null,
             'add_if' => null,
             'join_type' => 'leftJoin',
+            'join_conditions' => null,
             'type_of_field' => null,
             'responsive_priority' => null,
             'sent_in_response' => true,
@@ -344,6 +353,7 @@ public function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedTypes('width', ['null', 'string']);
         $resolver->setAllowedTypes('add_if', ['null', 'Closure']);
         $resolver->setAllowedTypes('join_type', 'string');
+        $resolver->setAllowedTypes('join_conditions', ['null', 'string']);
         $resolver->setAllowedTypes('type_of_field', ['null', 'string']);
         $resolver->setAllowedTypes('responsive_priority', ['null', 'int']);
         $resolver->setAllowedTypes('sent_in_response', ['bool']);
@@ -769,6 +779,30 @@ public function setJoinType($joinType)
         return $this;
     }
 
+    /**
+     * Get join conditions.
+     *
+     * @return string
+     */
+    public function getJoinConditions()
+    {
+        return $this->joinConditions;
+    }
+
+    /**
+     * Set join conditions.
+     *
+     * @param string $joinConditions
+     *
+     * @return $this
+     */
+    public function setJoinConditions($joinConditions = null)
+    {
+        $this->joinConditions = $joinConditions;
+
+        return $this;
+    }
+    
     /**
      * Get type of field.
      *

Resources/doc/columns.md

@@ -47,6 +47,7 @@ With 'null' initialized options uses the default value of the DataTables plugin.
 | width               | null or string     | null              |          | Column width assignment. |
 | add_if              | null or Closure    | null              |          | Add column only if conditions are TRUE. |
 | join_type           | string             | 'leftJoin'        |          | Join type (default: 'leftJoin'), if the column represents an association. |
+| join_conditions     | null or string     | null              |          | Join conditions (using WITH), if the column represents an association. |
 | type_of_field       | null or string     | null (autodetect) |          | Set the data type itself for ordering (example: integer instead string). |
 | responsive_priority | null or int        | null              |          | Set column's visibility priority. Requires the Responsive extension. |
 | filter              | array              | TextFilter        |          | A Filter instance for individual filtering. |
@@ -124,6 +125,7 @@ $this->columnBuilder
         'data' => 'comments[,].title',
         'searchable' => true,
         'orderable' => true,
+        'join_conditions' => 'comments.reviewed = 1',
     ))
 ;
 ```

Response/DatatableQueryBuilder.php

@@ -403,6 +403,7 @@ private function initColumnArrays()
                 $this->addSearchColumn($column, null, $searchDql);
             } elseif (true === $this->accessor->getValue($column, 'selectColumn')) {
                 $parts = explode('.', $dql);
+                $withExpr = $this->accessor->getValue($column, 'joinConditions');
 
                 while (\count($parts) > 1) {
                     $previousPart = $currentPart;
@@ -412,8 +413,14 @@ private function initColumnArrays()
                     $currentAlias = ($previousPart === $this->entityShortName ? '' : $previousPart.'_').$currentPart;
                     $currentAlias = $this->getSafeName($currentAlias);
 
-                    if (! \array_key_exists($previousAlias.'.'.$currentPart, $this->joins)) {
-                        $this->addJoin($previousAlias.'.'.$currentPart, $currentAlias, $this->accessor->getValue($column, 'joinType'));
+                    $columnTableName = $previousAlias.'.'.$currentPart;
+                    if (!array_key_exists($columnTableName, $this->joins)) {
+                        $this->addJoin($columnTableName, $currentAlias, $this->accessor->getValue($column, 'joinType'));
+                    }
+                    // for the last dql part join using WITH, if expression is given for column
+                    if (count($parts) === 1 && array_key_exists($columnTableName, $this->joins) && null !== $withExpr) {
+                        $with = str_replace($currentPart . '.', $currentAlias . '.', $withExpr);
+                        $this->addJoin($columnTableName, $currentAlias, $this->accessor->getValue($column, 'joinType'), $with);
                     }
 
                     $metadata = $this->setIdentifierFromAssociation($currentAlias, $currentPart, $metadata);
@@ -486,7 +493,11 @@ private function setSelectFrom(QueryBuilder $qb)
     private function setJoins(QueryBuilder $qb)
     {
         foreach ($this->joins as $key => $value) {
-            $qb->{$value['type']}($key, $value['alias']);
+            if (\array_key_exists('with', $value) && null !== $value['with']) {
+                $qb->{$value['type']}($key, $value['alias'], Query\Expr\Join::WITH, $value['with']);
+            } else {
+                $qb->{$value['type']}($key, $value['alias']);
+            }
         }
 
         return $this;
@@ -714,14 +725,16 @@ private function addSearchOrderColumn($column, $columnTableName, $data)
      * @param string $columnTableName
      * @param string $alias
      * @param string $type
+     * @param string $with
      *
      * @return $this
      */
-    private function addJoin($columnTableName, $alias, $type)
+    private function addJoin($columnTableName, $alias, $type, $with = null)
     {
         $this->joins[$columnTableName] = [
             'alias' => $alias,
             'type' => $type,
+            'with' => $with,
         ];
 
         return $this;