Add Count column (#17)

Add CountColumn
Add CountFilter
Change "search" callback function signature

Author: HelloSebastian

README.md

@@ -16,11 +16,13 @@ Inspired by [SgDatatablesBundle](https://github.com/stwe/DatatablesBundle).
    2. [BooleanColumn](#booleancolumn)
    3. [DateTimeColumn](#datetimecolumn)
    4. [HiddenColumn](#hiddencolumn)
-   5. [ActionColumn](#actioncolumn)
+   5. [CountColumn](#countcolumn)
+   6. [ActionColumn](#actioncolumn)
 5. [Filters](#filters)
    1. [TextFilter](#textfilter)
    2. [ChoiceFilter](#choicefilter)
    3. [BooleanChoiceFilter](#booleanchoicefilter)
+   4. [CountFilter](#countfilter)
 6. [Configuration](#configuration)
    1. [Table Dataset Options](#table-dataset-options)
    2. [Table Options](#table-options)
@@ -269,7 +271,6 @@ Represents column with text. With formatter you can create complex columns.
 | visible         | bool           | true                           | show / hide column                                           |
 | emptyData       | string         | ""                             | default value if attribute from entity is null               |
 | sort            | Closure / null | null                           | custom sort query callback (see example)                     |
-| filter          | Closure / null | null                           | custom filter query callback (see example)                   |
 | data            | Closure / null | null                           | custom data callback (see example)                           |
 | addIf           | Closure        | ` function() {return true;}`   | In this callback it is decided if the column will be rendered. |
 | align           | string / null  | null                           | Indicate how to align the column data. `'left'`, `'right'`, `'center'` can be used. |
@@ -300,28 +301,24 @@ use Doctrine\ORM\QueryBuilder;
         $qb->addOrderBy('username', $direction);
     },
 
-    'search' => function (Composite $composite, QueryBuilder $qb, $dql, $search, $key) {
+    'search' => function (Composite $composite, QueryBuilder $qb, $search) {
       	//first add condition to $composite
-        //don't forget the '?' before $key
-        $composite->add($qb->expr()->like($dql, '?' . $key));
+        //don't forget the ':' before the parameter for binding
+        $composite->add($qb->expr()->like($dql, ':username'));
 
       	//then bind search to query
-        $qb->setParameter($key, '%' . $search . '%');
+        $qb->setParameter("username", $search . '%');
     }
 ))
 ```
 
 **search** Option:
 
-The search option seems a bit complicated at first, but it allows full control over the query in the column.
-
 | Paramenter name        | Description                                                  |
 | ---------------------- | ------------------------------------------------------------ |
-| `Composite $composite` | In the global search all columns are connected as or. In the advanced search all columns are combined with an and-connection. With `$composite` more parts can be added to the query. |
+| `Composite $composite` | In the global search all columns are connected as or. In the advanced search all columns are combined with an and-connection. With `$composite` more parts can be added to the query. `Composite` is the parent class of `AndX` and `OrX`. |
 | `QueryBuilder $qb`     | `$qb` holds the use QueryBuilder. It is the same instance as can be queried with `getQueryBuilder()` in the table class. |
-| `$dql`                 | `$dql` represents the "path" to the variable in the query (e.g. `user.username` or in case of a JOIN `costCentre.name`) |
 | `$search`              | The search in the type of a string.                          |
-| `$key`                 | The index of the columns already gone through. The index is used for parameter binding to the query. |
 
 
 
@@ -347,6 +344,8 @@ All options of TextColumn.
 #### Example
 
 ```php
+use HelloSebastian\HelloBootstrapTableBundle\Columns\BooleanColumn;
+
 ->add('isActive', BooleanColumn::class, array(
     'title' => 'is active',
     'trueLabel' => 'yes',
@@ -373,6 +372,8 @@ All Options of TextColumn
 #### Example
 
 ```php
+use HelloSebastian\HelloBootstrapTableBundle\Columns\DateTimeColumn;
+
 ->add('createdAt', DateTimeColumn::class, array(
     'title' => 'Created at',
     'format' => 'd.m.Y'
@@ -394,11 +395,47 @@ All Options of TextColumn.
 #### Example
 
 ```php
+use HelloSebastian\HelloBootstrapTableBundle\Columns\HiddenColumn;
+
 ->add("id", HiddenColumn::class)
 ```
 
 
 
+### CountColumn
+
+Represents column for counting OneToMany relations (for ArrayCollection attributes).
+
+*Only works with direct attributes so far. For example, "users" would work in a `DepartmentTable`, but "users.items" would not.*
+
+#### Options
+
+All Options of TextColumn.
+
+`filter` is set to `array(CountFilter::class, array())` by default.
+
+#### Example
+
+```php
+// App\Entity\Department.php
+
+/**
+ * @var ArrayCollection|User[]
+ * @ORM\OneToMany(targetEntity="App\Entity\User", mappedBy="department")
+ */
+private $users;
+
+
+// App\HelloTable\UserTable.php
+use HelloSebastian\HelloBootstrapTableBundle\Columns\CountColumn;
+
+->add('users', CountColumn::class, array(
+    'title' => 'Users'
+))
+```
+
+
+
 ### ActionColumn
 
 Represents column for action buttons (show / edit / remove ...).
@@ -509,6 +546,8 @@ use HelloSebastian\HelloBootstrapTableBundle\Filters\TextFilter;
 ))
 ```
 
+
+
 ### ChoiceFilter
 
 With the ChoiceFilter you can create a `select` input field.
@@ -542,6 +581,8 @@ use HelloSebastian\HelloBootstrapTableBundle\Filters\ChoiceFilter;
 ))
 ```
 
+
+
 ### BooleanChoiceFilter
 
 BooleanChoiceFilter is a special `ChoiceFilter` with default choices and query expression. The expression is optimized for boolean values.
@@ -581,6 +622,37 @@ If not `choices` is set to:
 
 
 
+### CountFilter
+
+With the CountFilter you can filtering and sorting by counting OneToMany relations.
+
+#### Options
+
+All Options from TextFilter.
+
+**And**:
+
+| Option     | Type   | Default | Description                                                  |
+| ---------- | ------ | ------- | ------------------------------------------------------------ |
+| condition  | string | "gte"   | Operation to compare counting.<br /> Available options: "gt", "gte", "eq", "neq", "lt", "lte" |
+| primaryKey | string | "id"    | Primary key of the target entity in the OneToMany relation. <br />For example: A user is in one deparment. One department has many users. In the user entity there is a `$department` attribute that is pointing to the department entity. With this option you specify the primary key of the department entity (the target entity). |
+
+#### Example
+
+```php
+use HelloSebastian\HelloBootstrapTableBundle\Filters\CountFilter;
+
+->add('users', CountColumn::class, array(
+    'title' => 'Users',
+    'filter' => array(CountFilter::class, array(
+        'condition' => 'lte',
+        'primaryKey' => 'uuid'
+    ))
+))
+```
+
+
+
 ## Configuration
 
 

src/Columns/AbstractColumn.php

@@ -235,7 +235,7 @@ protected function configureInternalOptions(OptionsResolver $resolver)
         $resolver->setAllowedTypes('data', ['Closure', 'null']);
         $resolver->setAllowedTypes('sort', ['Closure', 'null']);
         $resolver->setAllowedTypes('search', ['Closure', 'null']);
-        $resolver->setAllowedTypes('filter', ['array', 'null']);
+        $resolver->setAllowedTypes('filter', ['array']);
         $resolver->setAllowedTypes('addIf', ['Closure']);
     }
 

src/Columns/ActionColumn.php

@@ -32,10 +32,9 @@ public function buildData($entity)
         $item = array();
 
         /**
-         * @var int $key
          * @var ActionButton $button
          */
-        foreach ($this->outputOptions['buttons'] as $key => $button) {
+        foreach ($this->outputOptions['buttons'] as $button) {
             if ($button->getAddIfCallback()()) {
                 $routeParams = array();
                 foreach ($button->getRouteParams() as $param) {

src/Columns/CountColumn.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace HelloSebastian\HelloBootstrapTableBundle\Columns;
+
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\QueryBuilder;
+use HelloSebastian\HelloBootstrapTableBundle\Filters\CountFilter;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class CountColumn extends AbstractColumn
+{
+
+    protected function configureInternalOptions(OptionsResolver $resolver)
+    {
+        parent::configureInternalOptions($resolver);
+
+        $resolver->setDefaults(array(
+            "filter" => array(CountFilter::class, array())
+        ));
+    }
+
+    public function buildData($entity)
+    {
+        if (!$this->propertyAccessor->isReadable($entity, $this->getDql())) {
+            return $this->getEmptyData();
+        }
+
+        $collection = $this->propertyAccessor->getValue($entity, $this->getDql());
+
+        if (is_null($collection)) {
+            return $this->getEmptyData();
+        }
+
+        if (!$collection instanceof Collection) {
+            throw new \LogicException("Value should be implemented the interface Doctrine\Common\Collections\Collection. Type: " . gettype($collection));
+        }
+
+        return $collection->count();
+    }
+}

src/Filters/AbstractFilter.php

@@ -4,6 +4,7 @@
 namespace HelloSebastian\HelloBootstrapTableBundle\Filters;
 
 
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\Expr\Composite;
 use Doctrine\ORM\QueryBuilder;
 use HelloSebastian\HelloBootstrapTableBundle\Columns\AbstractColumn;
@@ -46,7 +47,12 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedTypes("placeholder", ["string", "null"]);
     }
 
-    public abstract function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key);
+    public abstract function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key, ClassMetadata $metadata);
+
+    public function addOrder(QueryBuilder $qb, $dql, $direction, ClassMetadata $metadata)
+    {
+        $qb->addOrderBy($dql, $direction);
+    }
 
     public function getOptions()
     {

src/Filters/BooleanChoiceFilter.php

@@ -4,6 +4,7 @@
 namespace HelloSebastian\HelloBootstrapTableBundle\Filters;
 
 
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\Expr\Composite;
 use Doctrine\ORM\QueryBuilder;
 use HelloSebastian\HelloBootstrapTableBundle\Columns\AbstractColumn;
@@ -41,7 +42,7 @@ protected function configureOptions(OptionsResolver $resolver)
     }
 
 
-    public function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key)
+    public function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key, ClassMetadata $metadata)
     {
         if ($search == "null") {
             return;

src/Filters/ChoiceFilter.php

@@ -4,6 +4,7 @@
 namespace HelloSebastian\HelloBootstrapTableBundle\Filters;
 
 
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\Expr\Composite;
 use Doctrine\ORM\QueryBuilder;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -22,7 +23,7 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedTypes("choices", ["array"]);
     }
 
-    public function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key)
+    public function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key, ClassMetadata $metadata)
     {
         if ($search == "null") {
             return;

src/Filters/CountFilter.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace HelloSebastian\HelloBootstrapTableBundle\Filters;
+
+use Doctrine\ORM\Mapping\ClassMetadata;
+use Doctrine\ORM\Query\Expr\Composite;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class CountFilter extends AbstractFilter
+{
+    /**
+     * To ensure sub query alias are unique.
+     *
+     * @var int
+     */
+    static $subQueryCounter = 0;
+
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefaults(array(
+            "condition" => "gte",
+            "primaryKey" => "id"
+        ));
+
+        $resolver->setAllowedValues("condition", ["gt", "gte", "eq", "neq", "lt", "lte"]);
+        $resolver->setAllowedTypes("primaryKey", ["string"]);
+    }
+
+    public function addOrder(QueryBuilder $qb, $dql, $direction, ClassMetadata $metadata)
+    {
+        $alias = str_replace(".", "_", $dql);
+
+        // sub query must be placed in select area but as hidden attribute
+        // the count_$alias can then be used to order
+        // sub query must be in brackets but not the alias
+        $subQuery = $this->createSubQuery($qb, $metadata, $dql);
+        $qb->addSelect("(" . $subQuery->getDQL() . ") AS HIDDEN count_$alias");
+        $qb->addOrderBy("count_$alias", $direction);
+    }
+
+    public function addExpression(Composite $composite, QueryBuilder $qb, $dql, $search, $key, ClassMetadata $metadata)
+    {
+        if (!is_numeric($search)) {
+            return;
+        }
+
+        $subQuery = $this->createSubQuery($qb, $metadata, $dql);
+
+        // sub query must be in brackets
+        $composite->add($qb->expr()->{$this->options['condition']}("(" . $subQuery->getDQL() . ")", '?' . $key));
+        $qb->setParameter($key, $search);
+    }
+
+    private function createSubQuery(QueryBuilder $qb, ClassMetadata $metadata, $dql)
+    {
+        self::$subQueryCounter++;
+
+        // split dql
+        // e.g. dql is "user.someAttributes". user is the entity short name and someAttributes the property name.
+        $parts = explode(".", $dql);
+        $countParts = count($parts);
+        $property = $parts[$countParts - 1];
+        $entityShortName = $parts[$countParts - 2];
+
+        // get information about (class) names of the ArrayCollection field type
+        $subQueryEntityClass = $metadata->getAssociationMapping($property)['targetEntity'];
+        $subQueryMappedBy = $metadata->getAssociationMapping($property)['mappedBy'];
+
+        // to ensure sub query alias are unique
+        $alias = $property . "_" . self::$subQueryCounter;
+
+        // create sub query builder with target entity class and unique alias
+        // COUNT attribute can be managed by option "primaryKey" (default is id)
+        return $qb->getEntityManager()->getRepository($subQueryEntityClass)->createQueryBuilder($alias)
+            ->select("COUNT($alias.{$this->options['primaryKey']})")
+            ->where("$alias.$subQueryMappedBy = $entityShortName");
+    }
+
+}