Add Phpdoc to CharLength

beberlei · Mar 1, 2024 · 705a032 · 705a032
1 parent a34ae02
commit 705a032
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/Query/Mysql/CharLength.php b/src/Query/Mysql/CharLength.php
@@ -2,18 +2,25 @@
 
 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;
 
 /**
- * "CHAR_LENGTH" "(" ArithmeticExpression ")"
+ * CharLengthFunction ::= "CHAR_LENGTH" "(" ArithmeticExpression ")"
  *
  * @author Metod <metod@simpel.si>
+ *
+ * @link https://dev.mysql.com/doc/refman/8.0/en/string-functions.html#function_char-length
+ *
+ * @example SELECT CHAR_LENGTH(foo.bar) FROM entity
+ * @example SELECT CHAR_LENGTH("string") FROM entity
  */
 class CharLength extends FunctionNode
 {
+    /** @var ArithmeticExpression */
     private $expr1;
 
     public function getSql(SqlWalker $sqlWalker): string