Add Phpdoc to j* functions

beberlei · Mar 4, 2024 · a414c29 · a414c29
1 parent 820d38b
commit a414c29
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/src/Query/Mysql/JsonContains.php b/src/Query/Mysql/JsonContains.php
@@ -3,22 +3,31 @@
 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;
 
 /**
- * "JSON_CONTAINS" "(" StringPrimary "," StringPrimary ["," StringPrimary] ")"
+ * JsonContainsFunction ::= "JSON_CONTAINS" "(" StringPrimary "," StringPrimary ["," StringPrimary] ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/json-search-functions.html#function_json-contains
+ *
+ * @example SELECT JSON_CONTAINS("{x: 2}", 2, "$.x")
+ * @example SELECT JSON_CONTAINS(foo.bar, "x", "$.bar") FROM entity
  */
 class JsonContains extends FunctionNode
 {
+    /** @var Node */
     protected $target;
 
+    /** @var Node */
     protected $candidate;
 
-    protected $path;
+    /** @var Node|null */
+    protected $path = null;
 
     public function parse(Parser $parser): void
     {

diff --git a/src/Query/Mysql/JsonDepth.php b/src/Query/Mysql/JsonDepth.php
@@ -3,17 +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;
 
 /**
- * "JSON_DEPTH" "(" StringPrimary ")"
+ * JsonDepthFunction ::= "JSON_DEPTH" "(" StringPrimary ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/json-attribute-functions.html#function_json-depth
+ *
+ * @example SELECT JOIN_DEPTH(foo.bar) FROM entity
  */
 class JsonDepth extends FunctionNode
 {
+    /** @var Node */
     protected $target;
 
     public function parse(Parser $parser): void

diff --git a/src/Query/Mysql/JsonLength.php b/src/Query/Mysql/JsonLength.php
@@ -3,20 +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\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
 
 use function sprintf;
 
 /**
- * "JSON_LENGTH" "(" StringPrimary ["," StringPrimary] ")"
+ * JsonLengthFunction ::= "JSON_LENGTH" "(" StringPrimary ["," StringPrimary] ")"
+ *
+ * @link https://dev.mysql.com/doc/refman/en/json-attribute-functions.html#function_json-length
+ *
+ * @example SELECT JSON_LENGTH(foo.bar, "$.low") FROM entity
  */
 class JsonLength extends FunctionNode
 {
+    /** @var Node */
     protected $target;
 
-    protected $path;
+    /** @var Node|null */
+    protected $path = null;
 
     public function parse(Parser $parser): void
     {