Add missing PhpDoc

beberlei · Mar 7, 2024 · 174a80d · 174a80d
1 parent 808cb4a
commit 174a80d
Show file tree

Hide file tree

Showing 135 changed files with 1,191 additions and 90 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,20 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Lag\\:\\:\\$aggregateExpression \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\AggregateExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
-			count: 1
-			path: src/Query/Mysql/Lag.php
-
-		-
-			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Lag\\:\\:\\$defaultValue \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\SimpleArithmeticExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
-			count: 1
-			path: src/Query/Mysql/Lag.php
-
-		-
-			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Lag\\:\\:\\$offset \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\ArithmeticExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
-			count: 1
-			path: src/Query/Mysql/Lag.php
-
 		-
 			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Lead\\:\\:\\$aggregateExpression \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\AggregateExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
 			count: 1
@@ -29,13 +14,3 @@ parameters:
 			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Lead\\:\\:\\$offset \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\ArithmeticExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
 			count: 1
 			path: src/Query/Mysql/Lead.php
-
-		-
-			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Rand\\:\\:\\$expression \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\SimpleArithmeticExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
-			count: 1
-			path: src/Query/Mysql/Rand.php
-
-		-
-			message: "#^Property DoctrineExtensions\\\\Query\\\\Mysql\\\\Variance\\:\\:\\$arithmeticExpression \\(Doctrine\\\\ORM\\\\Query\\\\AST\\\\SimpleArithmeticExpression\\) does not accept Doctrine\\\\ORM\\\\Query\\\\AST\\\\Node\\|string\\.$#"
-			count: 1
-			path: src/Query/Mysql/Variance.php
diff --git a/src/Query/Mysql/Acos.php b/src/Query/Mysql/Acos.php
@@ -3,12 +3,22 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * AcosFunction ::= "ACOS" "(" SimpleArithmeticExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/mathematical-functions.html#function_acos
+ *
+ * @example SELECT ACOS(2)
+ * @example SELECT ACOS(foo.bar) FROM entity
+ */
 class Acos extends FunctionNode
 {
+    /** @var Node|string */
     public $arithmeticExpression;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/AddTime.php b/src/Query/Mysql/AddTime.php
@@ -3,15 +3,26 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
-/** @author Pascal Wacker <hello@pascalwacker.ch> */
+/**
+ * AddTimeFunction ::= "ADDTIME" "(" ArithmeticPrimary "," ArithmeticPrimary ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/date-and-time-functions.html#function_addtime
+ *
+ * @author Pascal Wacker <hello@pascalwacker.ch>
+ * @example SELECT ADDTIME('2019-03-01 14:35:00', '01:02:03')
+ * @example SELECT ADDTIME(foo.bar, '01:02:03') FROM entity
+ */
 class AddTime extends FunctionNode
 {
+    /** @var Node|string */
     public $date;
 
+    /** @var Node|string */
     public $time;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/AesDecrypt.php b/src/Query/Mysql/AesDecrypt.php
@@ -3,16 +3,27 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
+use Doctrine\ORM\Query\AST\Subselect;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
 use function sprintf;
 
+/**
+ * AesDecryptFunction ::= "AES_DECRYPT" "(" StringExpression "," StringExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/encryption-functions.html#function_aes-decrypt
+ *
+ * @example SELECT AES_DECRYPT(foo.crypt, foo.key) FROM entity
+ */
 class AesDecrypt extends FunctionNode
 {
+    /** @var Node|Subselect|string */
     public $field = '';
 
+    /** @var Node|Subselect|string */
     public $key = '';
 
     public function parse(Parser $parser): void

diff --git a/src/Query/Mysql/AesEncrypt.php b/src/Query/Mysql/AesEncrypt.php
@@ -3,16 +3,27 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
+use Doctrine\ORM\Query\AST\Subselect;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
 use function sprintf;
 
+/**
+ * AesEncryptFunction ::= "AES_ENCRYPT" "(" StringExpression "," StringExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/encryption-functions.html#function_aes-encrypt
+ *
+ * @example SELECT AES_ENCRYPT(foo.to_crypt, foo.key) FROM entity
+ */
 class AesEncrypt extends FunctionNode
 {
+    /** @var Node|Subselect|string */
     public $field = '';
 
+    /** @var Node|Subselect|string */
     public $key = '';
 
     public function parse(Parser $parser): void

diff --git a/src/Query/Mysql/AnyValue.php b/src/Query/Mysql/AnyValue.php
@@ -3,14 +3,23 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
 use function sprintf;
 
+/**
+ * AnyValueFunction ::= "ANY_VALUE" "(" StringPrimary ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/miscellaneous-functions.html#function_any-value
+ *
+ * @example SELECT ANY_VALUE(foo.bar) FROM entity
+ */
 class AnyValue extends FunctionNode
 {
+    /** @var Node */
     public $value;
 
     public function parse(Parser $parser): void

diff --git a/src/Query/Mysql/Ascii.php b/src/Query/Mysql/Ascii.php
@@ -2,13 +2,24 @@
 
 namespace DoctrineExtensions\Query\Mysql;
 
+use Doctrine\ORM\Query\AST\ArithmeticExpression;
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * AsciiFunction ::= "ASCII" "(" ArithmeticExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/string-functions.html#function_ascii
+ *
+ * @example SELECT ASCII(foo.bar) FROM entity
+ * @example SELECT ASCII('2')
+ * @example SELECT ASCII(2)
+ */
 class Ascii extends FunctionNode
 {
+    /** @var ArithmeticExpression */
     private $string;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/Asin.php b/src/Query/Mysql/Asin.php
@@ -3,12 +3,22 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * AsinFunction ::= "ASIN" "(" SimpleArithmeticExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/mathematical-functions.html#function_asin
+ *
+ * @example SELECT ASIN(foo.bar) FROM entity
+ * @example SELECT ASIN(0.2)
+ */
 class Asin extends FunctionNode
 {
+    /** @var Node|string */
     public $arithmeticExpression;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/Atan.php b/src/Query/Mysql/Atan.php
@@ -3,15 +3,27 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\QueryException;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * AtanFunction ::= "ATAN" "(" SimpleArithmeticExpression [ "," SimpleArithmeticExpression ] ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/mathematical-functions.html#function_atan
+ *
+ * @example SELECT ATAN(foo.bar) FROM entity
+ * @example SELECT ATAN(-2, 2)
+ * @example SELECT ATAN(PI(), 2)
+ */
 class Atan extends FunctionNode
 {
+    /** @var Node|string */
     public $arithmeticExpression;
 
+    /** @var Node|string */
     public $optionalSecondExpression;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/Atan2.php b/src/Query/Mysql/Atan2.php
@@ -3,14 +3,26 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * Atan2Function ::= "ATAN2" "(" SimpleArithmeticExpression "," SimpleArithmeticExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/mathematical-functions.html#function_atan2
+ *
+ * @example SELECT ATAN2(-2, 2)
+ * @example SELECT ATAN2(PI(), 2)
+ * @example SELECT ATAN2(foo.bar, 2) FROM entity
+ */
 class Atan2 extends FunctionNode
 {
+    /** @var Node|string */
     public $firstExpression;
 
+    /** @var Node|string */
     public $secondExpression;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/Binary.php b/src/Query/Mysql/Binary.php
@@ -3,13 +3,24 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
-/** @author Sarjono Mukti Aji <me@simukti.net> */
+/**
+ * BinaryFunction ::= "BINARY" "(" StringPrimary ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/cast-functions.html#operator_binary
+ *
+ * @author Sarjono Mukti Aji <me@simukti.net>
+ * @example SELECT BINARY(foo.bar) FROM entity
+ * @example SELECT BINARY("string")
+ * @example SELECT BINARY(2)
+ */
 class Binary extends FunctionNode
 {
+    /** @var Node */
     private $stringPrimary;
 
     public function parse(Parser $parser): void

diff --git a/src/Query/Mysql/BitCount.php b/src/Query/Mysql/BitCount.php
@@ -3,12 +3,22 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * BitCountFunction ::= "BIT_COUNT" "(" SimpleArithmeticExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/bit-functions.html#function_bit-count
+ *
+ * @example SELECT BIT_COUNT(foo.bar) FROM entity
+ * @example SELECT BIT_COUNT(2)
+ */
 class BitCount extends FunctionNode
 {
+    /** @var Node|string */
     public $arithmeticExpression;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/BitXor.php b/src/Query/Mysql/BitXor.php
@@ -3,17 +3,25 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
 /**
- * "BIT_XOR" "(" ArithmeticPrimary "," ArithmeticPrimary ")"
+ * BitXorFunction ::= "BIT_XOR" "(" ArithmeticPrimary "," ArithmeticPrimary ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/aggregate-functions.html#function_bit-xor
+ *
+ * @example SELECT BIT_XOR(foo.bar, 2) FROM entity
+ * @example SELECT BIT_XOR(2, 2)
  */
 class BitXor extends FunctionNode
 {
+    /** @var Node|string */
     public $firstArithmetic;
 
+    /** @var Node|string */
     public $secondArithmetic;
 
     public function getSql(SqlWalker $sqlWalker): string

diff --git a/src/Query/Mysql/Cast.php b/src/Query/Mysql/Cast.php
@@ -15,15 +15,17 @@
 use function sprintf;
 
 /**
- * "CAST" "(" "$fieldIdentifierExpression" "AS" "$castingTypeExpression" ")"
+ * "CAST" "(" SimpleArithmeticExpression "AS" Identifier [ "(" Literal { "," Literal }* ")" ] ")"
  *
  * @link https://dev.mysql.com/doc/refman/en/cast-functions.html#function_cast
  *
- * @example SELECT CAST(foo.bar AS SIGNED) FROM dual;
+ * @example SELECT CAST(foo.bar AS SIGNED) FROM entity
+ * @example SELECT CAST(foo.bar AS UNSIGNED) FROM entity
+ * @example SELECT CAST(foo.bar AS DECIMAL(2, 2)) FROM entity
  */
 class Cast extends FunctionNode
 {
-    /** @var Node */
+    /** @var Node|string */
     protected $fieldIdentifierExpression;
 
     /** @var string */

diff --git a/src/Query/Mysql/Ceil.php b/src/Query/Mysql/Ceil.php
@@ -3,12 +3,22 @@
 namespace DoctrineExtensions\Query\Mysql;
 
 use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Node;
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
+/**
+ * CeilFunction ::= "CEIL" "(" SimpleArithmeticExpression ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/mathematical-functions.html#function_ceil
+ *
+ * @example SELECT CEIL(foo.bar) FROM entity
+ * @example SELECT CEIL(2)
+ */
 class Ceil extends FunctionNode
 {
+    /** @var Node|string */
     private $arithmeticExpression;
 
     public function getSql(SqlWalker $sqlWalker): string