[ExpressionLanguage] [5.0] add type-hints whenever possible

Simperfit · Simperfit · commit 143b616e7272 · 2019-07-04T08:57:25.000+02:00
diff --git a/src/Symfony/Component/ExpressionLanguage/Compiler.php b/src/Symfony/Component/ExpressionLanguage/Compiler.php
@@ -78,11 +78,9 @@ public function subcompile(Node\Node $node)
     /**
      * Adds a raw string to the compiled code.
      *
-     * @param string $string The string
-     *
      * @return $this
      */
-    public function raw($string)
+    public function raw(string $string)
     {
         $this->source .= $string;
 
@@ -92,11 +90,9 @@ public function raw($string)
     /**
      * Adds a quoted string to the compiled code.
      *
-     * @param string $value The string
-     *
      * @return $this
      */
-    public function string($value)
+    public function string(string $value)
     {
         $this->source .= sprintf('"%s"', addcslashes($value, "\0\t\"\$\\"));
 
diff --git a/src/Symfony/Component/ExpressionLanguage/ExpressionFunction.php b/src/Symfony/Component/ExpressionLanguage/ExpressionFunction.php
@@ -64,7 +64,6 @@ public function getEvaluator()
     /**
      * Creates an ExpressionFunction from a PHP function name.
      *
-     * @param string      $phpFunctionName        The PHP function name
      * @param string|null $expressionFunctionName The expression function name (default: same than the PHP function name)
      *
      * @return self
@@ -73,7 +72,7 @@ public function getEvaluator()
      * @throws \InvalidArgumentException if given PHP function name is in namespace
      *                                   and expression function name is not defined
      */
-    public static function fromPhp($phpFunctionName, $expressionFunctionName = null)
+    public static function fromPhp(string $phpFunctionName, string $expressionFunctionName = null)
     {
         $phpFunctionName = ltrim($phpFunctionName, '\\');
         if (!\function_exists($phpFunctionName)) {
diff --git a/src/Symfony/Component/ExpressionLanguage/ExpressionLanguage.php b/src/Symfony/Component/ExpressionLanguage/ExpressionLanguage.php
@@ -45,11 +45,10 @@ public function __construct(CacheItemPoolInterface $cache = null, array $provide
      * Compiles an expression source code.
      *
      * @param Expression|string $expression The expression to compile
-     * @param array             $names      An array of valid names
      *
      * @return string The compiled PHP source code
      */
-    public function compile($expression, $names = [])
+    public function compile($expression, array $names = [])
     {
         return $this->getCompiler()->compile($this->parse($expression, $names)->getNodes())->getSource();
     }
@@ -58,11 +57,10 @@ public function compile($expression, $names = [])
      * Evaluate an expression.
      *
      * @param Expression|string $expression The expression to compile
-     * @param array             $values     An array of values
      *
      * @return mixed The result of the evaluation of the expression
      */
-    public function evaluate($expression, $values = [])
+    public function evaluate($expression, array $values = [])
     {
         return $this->parse($expression, array_keys($values))->getNodes()->evaluate($this->functions, $values);
     }
@@ -71,11 +69,10 @@ public function evaluate($expression, $values = [])
      * Parses an expression.
      *
      * @param Expression|string $expression The expression to parse
-     * @param array             $names      An array of valid names
      *
      * @return ParsedExpression A ParsedExpression instance
      */
-    public function parse($expression, $names)
+    public function parse($expression, array $names)
     {
         if ($expression instanceof ParsedExpression) {
             return $expression;
@@ -104,15 +101,14 @@ public function parse($expression, $names)
     /**
      * Registers a function.
      *
-     * @param string   $name      The function name
      * @param callable $compiler  A callable able to compile the function
      * @param callable $evaluator A callable able to evaluate the function
      *
      * @throws \LogicException when registering a function after calling evaluate(), compile() or parse()
      *
      * @see ExpressionFunction
      */
-    public function register($name, callable $compiler, callable $evaluator)
+    public function register(string $name, callable $compiler, callable $evaluator)
     {
         if (null !== $this->parser) {
             throw new \LogicException('Registering functions after calling evaluate(), compile() or parse() is not supported.');
diff --git a/src/Symfony/Component/ExpressionLanguage/Lexer.php b/src/Symfony/Component/ExpressionLanguage/Lexer.php
@@ -21,13 +21,11 @@ class Lexer
     /**
      * Tokenizes an expression.
      *
-     * @param string $expression The expression to tokenize
-     *
      * @return TokenStream A token stream instance
      *
      * @throws SyntaxError
      */
-    public function tokenize($expression)
+    public function tokenize(string $expression)
     {
         $expression = str_replace(["\r", "\n", "\t", "\v", "\f"], ' ', $expression);
         $cursor = 0;
diff --git a/src/Symfony/Component/ExpressionLanguage/Parser.php b/src/Symfony/Component/ExpressionLanguage/Parser.php
@@ -85,14 +85,11 @@ public function __construct(array $functions)
      * variable 'container' can be used in the expression
      * but the compiled code will use 'this'.
      *
-     * @param TokenStream $stream A token stream instance
-     * @param array       $names  An array of valid names
-     *
      * @return Node\Node A node tree
      *
      * @throws SyntaxError
      */
-    public function parse(TokenStream $stream, $names = [])
+    public function parse(TokenStream $stream, array $names = [])
     {
         $this->stream = $stream;
         $this->names = $names;
@@ -105,7 +102,7 @@ public function parse(TokenStream $stream, $names = [])
         return $node;
     }
 
-    public function parseExpression($precedence = 0)
+    public function parseExpression(int $precedence = 0)
     {
         $expr = $this->getPrimary();
         $token = $this->stream->current;
diff --git a/src/Symfony/Component/ExpressionLanguage/Token.php b/src/Symfony/Component/ExpressionLanguage/Token.php
@@ -54,12 +54,11 @@ public function __toString()
     /**
      * Tests the current token for a type and/or a value.
      *
-     * @param array|int   $type  The type to test
-     * @param string|null $value The token value
+     * @param array|int $type The type to test
      *
      * @return bool
      */
-    public function test($type, $value = null)
+    public function test($type, string $value = null)
     {
         return $this->type === $type && (null === $value || $this->value == $value);
     }
diff --git a/src/Symfony/Component/ExpressionLanguage/TokenStream.php b/src/Symfony/Component/ExpressionLanguage/TokenStream.php
@@ -58,11 +58,10 @@ public function next()
     /**
      * Tests a token.
      *
-     * @param array|int   $type    The type to test
-     * @param string|null $value   The token value
+     * @param array|int $type The type to test
      * @param string|null $message The syntax error message
      */
-    public function expect($type, $value = null, $message = null)
+    public function expect($type, string $value = null, string $message = null)
     {
         $token = $this->current;
         if (!$token->test($type, $value)) {

Original file line number	Diff line number	Diff line change
`@@ -78,11 +78,9 @@ public function subcompile(Node\Node $node)`
`78`	`78`	`/**`
`79`	`79`	`* Adds a raw string to the compiled code.`
`80`	`80`	`*`
`81`		`- * @param string $string The string`
`82`		`- *`
`83`	`81`	`* @return $this`
`84`	`82`	`*/`
`85`		`- public function raw($string)`
	`83`	`+ public function raw(string $string)`
`86`	`84`	`{`
`87`	`85`	`$this->source .= $string;`
`88`	`86`
`@@ -92,11 +90,9 @@ public function raw($string)`
`92`	`90`	`/**`
`93`	`91`	`* Adds a quoted string to the compiled code.`
`94`	`92`	`*`
`95`		`- * @param string $value The string`
`96`		`- *`
`97`	`93`	`* @return $this`
`98`	`94`	`*/`
`99`		`- public function string($value)`
	`95`	`+ public function string(string $value)`
`100`	`96`	`{`
`101`	`97`	`$this->source .= sprintf('"%s"', addcslashes($value, "\0\t\"\$\\"));`
`102`	`98`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,6 @@ public function getEvaluator()`
`64`	`64`	`/**`
`65`	`65`	`* Creates an ExpressionFunction from a PHP function name.`
`66`	`66`	`*`
`67`		`- * @param string $phpFunctionName The PHP function name`
`68`	`67`	`* @param string\|null $expressionFunctionName The expression function name (default: same than the PHP function name)`
`69`	`68`	`*`
`70`	`69`	`* @return self`
`@@ -73,7 +72,7 @@ public function getEvaluator()`
`73`	`72`	`* @throws \InvalidArgumentException if given PHP function name is in namespace`
`74`	`73`	`* and expression function name is not defined`
`75`	`74`	`*/`
`76`		`- public static function fromPhp($phpFunctionName, $expressionFunctionName = null)`
	`75`	`+ public static function fromPhp(string $phpFunctionName, string $expressionFunctionName = null)`
`77`	`76`	`{`
`78`	`77`	`$phpFunctionName = ltrim($phpFunctionName, '\\');`
`79`	`78`	`if (!\function_exists($phpFunctionName)) {`
Original file line number	Diff line number	Diff line change
`@@ -45,11 +45,10 @@ public function __construct(CacheItemPoolInterface $cache = null, array $provide`
`45`	`45`	`* Compiles an expression source code.`
`46`	`46`	`*`
`47`	`47`	`* @param Expression\|string $expression The expression to compile`
`48`		`- * @param array $names An array of valid names`
`49`	`48`	`*`
`50`	`49`	`* @return string The compiled PHP source code`
`51`	`50`	`*/`
`52`		`- public function compile($expression, $names = [])`
	`51`	`+ public function compile($expression, array $names = [])`
`53`	`52`	`{`
`54`	`53`	`return $this->getCompiler()->compile($this->parse($expression, $names)->getNodes())->getSource();`
`55`	`54`	`}`
`@@ -58,11 +57,10 @@ public function compile($expression, $names = [])`
`58`	`57`	`* Evaluate an expression.`
`59`	`58`	`*`
`60`	`59`	`* @param Expression\|string $expression The expression to compile`
`61`		`- * @param array $values An array of values`
`62`	`60`	`*`
`63`	`61`	`* @return mixed The result of the evaluation of the expression`
`64`	`62`	`*/`
`65`		`- public function evaluate($expression, $values = [])`
	`63`	`+ public function evaluate($expression, array $values = [])`
`66`	`64`	`{`
`67`	`65`	`return $this->parse($expression, array_keys($values))->getNodes()->evaluate($this->functions, $values);`
`68`	`66`	`}`
`@@ -71,11 +69,10 @@ public function evaluate($expression, $values = [])`
`71`	`69`	`* Parses an expression.`
`72`	`70`	`*`
`73`	`71`	`* @param Expression\|string $expression The expression to parse`
`74`		`- * @param array $names An array of valid names`
`75`	`72`	`*`
`76`	`73`	`* @return ParsedExpression A ParsedExpression instance`
`77`	`74`	`*/`
`78`		`- public function parse($expression, $names)`
	`75`	`+ public function parse($expression, array $names)`
`79`	`76`	`{`
`80`	`77`	`if ($expression instanceof ParsedExpression) {`
`81`	`78`	`return $expression;`
`@@ -104,15 +101,14 @@ public function parse($expression, $names)`
`104`	`101`	`/**`
`105`	`102`	`* Registers a function.`
`106`	`103`	`*`
`107`		`- * @param string $name The function name`
`108`	`104`	`* @param callable $compiler A callable able to compile the function`
`109`	`105`	`* @param callable $evaluator A callable able to evaluate the function`
`110`	`106`	`*`
`111`	`107`	`* @throws \LogicException when registering a function after calling evaluate(), compile() or parse()`
`112`	`108`	`*`
`113`	`109`	`* @see ExpressionFunction`
`114`	`110`	`*/`
`115`		`- public function register($name, callable $compiler, callable $evaluator)`
	`111`	`+ public function register(string $name, callable $compiler, callable $evaluator)`
`116`	`112`	`{`
`117`	`113`	`if (null !== $this->parser) {`
`118`	`114`	`throw new \LogicException('Registering functions after calling evaluate(), compile() or parse() is not supported.');`
Original file line number	Diff line number	Diff line change
`@@ -21,13 +21,11 @@ class Lexer`
`21`	`21`	`/**`
`22`	`22`	`* Tokenizes an expression.`
`23`	`23`	`*`
`24`		`- * @param string $expression The expression to tokenize`
`25`		`- *`
`26`	`24`	`* @return TokenStream A token stream instance`
`27`	`25`	`*`
`28`	`26`	`* @throws SyntaxError`
`29`	`27`	`*/`
`30`		`- public function tokenize($expression)`
	`28`	`+ public function tokenize(string $expression)`
`31`	`29`	`{`
`32`	`30`	`$expression = str_replace(["\r", "\n", "\t", "\v", "\f"], ' ', $expression);`
`33`	`31`	`$cursor = 0;`
Original file line number	Diff line number	Diff line change
`@@ -85,14 +85,11 @@ public function __construct(array $functions)`
`85`	`85`	`* variable 'container' can be used in the expression`
`86`	`86`	`* but the compiled code will use 'this'.`
`87`	`87`	`*`
`88`		`- * @param TokenStream $stream A token stream instance`
`89`		`- * @param array $names An array of valid names`
`90`		`- *`
`91`	`88`	`* @return Node\Node A node tree`
`92`	`89`	`*`
`93`	`90`	`* @throws SyntaxError`
`94`	`91`	`*/`
`95`		`- public function parse(TokenStream $stream, $names = [])`
	`92`	`+ public function parse(TokenStream $stream, array $names = [])`
`96`	`93`	`{`
`97`	`94`	`$this->stream = $stream;`
`98`	`95`	`$this->names = $names;`
`@@ -105,7 +102,7 @@ public function parse(TokenStream $stream, $names = [])`
`105`	`102`	`return $node;`
`106`	`103`	`}`
`107`	`104`
`108`		`- public function parseExpression($precedence = 0)`
	`105`	`+ public function parseExpression(int $precedence = 0)`
`109`	`106`	`{`
`110`	`107`	`$expr = $this->getPrimary();`
`111`	`108`	`$token = $this->stream->current;`
Original file line number	Diff line number	Diff line change
`@@ -54,12 +54,11 @@ public function __toString()`
`54`	`54`	`/**`
`55`	`55`	`* Tests the current token for a type and/or a value.`
`56`	`56`	`*`
`57`		`- * @param array\|int $type The type to test`
`58`		`- * @param string\|null $value The token value`
	`57`	`+ * @param array\|int $type The type to test`
`59`	`58`	`*`
`60`	`59`	`* @return bool`
`61`	`60`	`*/`
`62`		`- public function test($type, $value = null)`
	`61`	`+ public function test($type, string $value = null)`
`63`	`62`	`{`
`64`	`63`	`return $this->type === $type && (null === $value \|\| $this->value == $value);`
`65`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,11 +58,10 @@ public function next()`
`58`	`58`	`/**`
`59`	`59`	`* Tests a token.`
`60`	`60`	`*`
`61`		`- * @param array\|int $type The type to test`
`62`		`- * @param string\|null $value The token value`
	`61`	`+ * @param array\|int $type The type to test`
`63`	`62`	`* @param string\|null $message The syntax error message`
`64`	`63`	`*/`
`65`		`- public function expect($type, $value = null, $message = null)`
	`64`	`+ public function expect($type, string $value = null, string $message = null)`
`66`	`65`	`{`
`67`	`66`	`$token = $this->current;`
`68`	`67`	`if (!$token->test($type, $value)) {`