Add Phpdoc to CountFilter

beberlei · Mar 1, 2024 · dfb0bd0 · dfb0bd0
1 parent 8406352
commit dfb0bd0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/Query/Postgresql/CountFilterFunction.php b/src/Query/Postgresql/CountFilterFunction.php
@@ -3,6 +3,8 @@
 namespace DoctrineExtensions\Query\Postgresql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
+use Doctrine\ORM\Query\AST\WhereClause;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
@@ -11,11 +13,19 @@
 
 /**
  * CountFilterFunction ::= "COUNT_FILTER" "(" ArithmeticPrimary "," ArithmeticPrimary ")"
+ *
+ * @link https://www.postgresql.org/docs/current/sql-expressions.html#SYNTAX-AGGREGATES
+ *
+ * @example SELECT COUNT(*, WHERE foo.bar < 3) FROM entity
+ *
+ * @todo rename class to CountFilter
  */
 class CountFilterFunction extends FunctionNode
 {
+    /** @var Node|string */
     public $countExpression = null;
 
+    /** @var WhereClause */
     public $whereExpression = null;
 
     public function parse(Parser $parser): void