Add PHP types to private methods and functions

wouterj · nicolas-grekas · commit 75eea25ccba6 · 2023-02-13T10:14:48.000+01:00
diff --git a/Node/ArgumentsNode.php b/Node/ArgumentsNode.php
@@ -20,12 +20,12 @@
  */
 class ArgumentsNode extends ArrayNode
 {
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $this->compileArguments($compiler, false);
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         $array = [];
 
diff --git a/Node/ArrayNode.php b/Node/ArrayNode.php
@@ -27,7 +27,7 @@ public function __construct()
         $this->index = -1;
     }
 
-    public function addElement(Node $value, Node $key = null)
+    public function addElement(Node $value, Node $key = null): void
     {
         $key ??= new ConstantNode(++$this->index);
 
@@ -37,14 +37,14 @@ public function addElement(Node $value, Node $key = null)
     /**
      * Compiles the node to PHP.
      */
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler->raw('[');
         $this->compileArguments($compiler);
         $compiler->raw(']');
     }
 
-    public function evaluate(array $functions, array $values)
+    public function evaluate(array $functions, array $values): array
     {
         $result = [];
         foreach ($this->getKeyValuePairs() as $pair) {
@@ -54,7 +54,7 @@ public function evaluate(array $functions, array $values)
         return $result;
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         $value = [];
         foreach ($this->getKeyValuePairs() as $pair) {
@@ -84,7 +84,7 @@ public function toArray()
         return $array;
     }
 
-    protected function getKeyValuePairs()
+    protected function getKeyValuePairs(): array
     {
         $pairs = [];
         foreach (array_chunk($this->nodes, 2) as $pair) {
@@ -94,7 +94,7 @@ protected function getKeyValuePairs()
         return $pairs;
     }
 
-    protected function compileArguments(Compiler $compiler, bool $withKeys = true)
+    protected function compileArguments(Compiler $compiler, bool $withKeys = true): void
     {
         $first = true;
         foreach ($this->getKeyValuePairs() as $pair) {
diff --git a/Node/BinaryNode.php b/Node/BinaryNode.php
@@ -45,7 +45,7 @@ public function __construct(string $operator, Node $left, Node $right)
         );
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $operator = $this->attributes['operator'];
 
@@ -92,7 +92,7 @@ public function compile(Compiler $compiler)
         ;
     }
 
-    public function evaluate(array $functions, array $values)
+    public function evaluate(array $functions, array $values): mixed
     {
         $operator = $this->attributes['operator'];
         $left = $this->nodes['left']->evaluate($functions, $values);
@@ -171,7 +171,7 @@ public function evaluate(array $functions, array $values)
         }
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return ['(', $this->nodes['left'], ' '.$this->attributes['operator'].' ', $this->nodes['right'], ')'];
     }
diff --git a/Node/ConditionalNode.php b/Node/ConditionalNode.php
@@ -27,7 +27,7 @@ public function __construct(Node $expr1, Node $expr2, Node $expr3)
         );
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler
             ->raw('((')
@@ -49,7 +49,7 @@ public function evaluate(array $functions, array $values)
         return $this->nodes['expr3']->evaluate($functions, $values);
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return ['(', $this->nodes['expr1'], ' ? ', $this->nodes['expr2'], ' : ', $this->nodes['expr3'], ')'];
     }
diff --git a/Node/ConstantNode.php b/Node/ConstantNode.php
@@ -33,17 +33,17 @@ public function __construct(mixed $value, bool $isIdentifier = false, bool $isNu
         );
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler->repr($this->attributes['value']);
     }
 
-    public function evaluate(array $functions, array $values)
+    public function evaluate(array $functions, array $values): mixed
     {
         return $this->attributes['value'];
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         $array = [];
         $value = $this->attributes['value'];
diff --git a/Node/GetAttrNode.php b/Node/GetAttrNode.php
@@ -24,6 +24,9 @@ class GetAttrNode extends Node
     public const METHOD_CALL = 2;
     public const ARRAY_CALL = 3;
 
+    /**
+     * @param self::* $type
+     */
     public function __construct(Node $node, Node $attribute, ArrayNode $arguments, int $type)
     {
         parent::__construct(
@@ -32,7 +35,7 @@ public function __construct(Node $node, Node $attribute, ArrayNode $arguments, i
         );
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $nullSafe = $this->nodes['attribute'] instanceof ConstantNode && $this->nodes['attribute']->isNullSafe;
         switch ($this->attributes['type']) {
@@ -65,7 +68,7 @@ public function compile(Compiler $compiler)
         }
     }
 
-    public function evaluate(array $functions, array $values)
+    public function evaluate(array $functions, array $values): mixed
     {
         switch ($this->attributes['type']) {
             case self::PROPERTY_CALL:
@@ -136,7 +139,7 @@ private function isShortCircuited(): bool
         return $this->attributes['is_short_circuited'] || ($this->nodes['node'] instanceof self && $this->nodes['node']->isShortCircuited());
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         switch ($this->attributes['type']) {
             case self::PROPERTY_CALL:
diff --git a/Node/NameNode.php b/Node/NameNode.php
@@ -28,17 +28,17 @@ public function __construct(string $name)
         );
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler->raw('$'.$this->attributes['name']);
     }
 
-    public function evaluate(array $functions, array $values)
+    public function evaluate(array $functions, array $values): mixed
     {
         return $values[$this->attributes['name']];
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return [$this->attributes['name']];
     }
diff --git a/Node/NullCoalesceNode.php b/Node/NullCoalesceNode.php
@@ -25,7 +25,7 @@ public function __construct(Node $expr1, Node $expr2)
         parent::__construct(['expr1' => $expr1, 'expr2' => $expr2]);
     }
 
-    public function compile(Compiler $compiler)
+    public function compile(Compiler $compiler): void
     {
         $compiler
             ->raw('((')
@@ -36,7 +36,7 @@ public function compile(Compiler $compiler)
         ;
     }
 
-    public function evaluate(array $functions, array $values)
+    public function evaluate(array $functions, array $values): mixed
     {
         if ($this->nodes['expr1'] instanceof GetAttrNode) {
             $this->nodes['expr1']->attributes['is_null_coalesce'] = true;
@@ -45,7 +45,7 @@ public function evaluate(array $functions, array $values)
         return $this->nodes['expr1']->evaluate($functions, $values) ?? $this->nodes['expr2']->evaluate($functions, $values);
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return ['(', $this->nodes['expr1'], ') ?? (', $this->nodes['expr2'], ')'];
     }

Original file line number	Diff line number	Diff line change
`@@ -20,12 +20,12 @@`
`20`	`20`	`*/`
`21`	`21`	`class ArgumentsNode extends ArrayNode`
`22`	`22`	`{`
`23`		`- public function compile(Compiler $compiler)`
	`23`	`+ public function compile(Compiler $compiler): void`
`24`	`24`	`{`
`25`	`25`	`$this->compileArguments($compiler, false);`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function toArray()`
	`28`	`+ public function toArray(): array`
`29`	`29`	`{`
`30`	`30`	`$array = [];`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function __construct()`
`27`	`27`	`$this->index = -1;`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function addElement(Node $value, Node $key = null)`
	`30`	`+ public function addElement(Node $value, Node $key = null): void`
`31`	`31`	`{`
`32`	`32`	`$key ??= new ConstantNode(++$this->index);`
`33`	`33`
`@@ -37,14 +37,14 @@ public function addElement(Node $value, Node $key = null)`
`37`	`37`	`/**`
`38`	`38`	`* Compiles the node to PHP.`
`39`	`39`	`*/`
`40`		`- public function compile(Compiler $compiler)`
	`40`	`+ public function compile(Compiler $compiler): void`
`41`	`41`	`{`
`42`	`42`	`$compiler->raw('[');`
`43`	`43`	`$this->compileArguments($compiler);`
`44`	`44`	`$compiler->raw(']');`
`45`	`45`	`}`
`46`	`46`
`47`		`- public function evaluate(array $functions, array $values)`
	`47`	`+ public function evaluate(array $functions, array $values): array`
`48`	`48`	`{`
`49`	`49`	`$result = [];`
`50`	`50`	`foreach ($this->getKeyValuePairs() as $pair) {`
`@@ -54,7 +54,7 @@ public function evaluate(array $functions, array $values)`
`54`	`54`	`return $result;`
`55`	`55`	`}`
`56`	`56`
`57`		`- public function toArray()`
	`57`	`+ public function toArray(): array`
`58`	`58`	`{`
`59`	`59`	`$value = [];`
`60`	`60`	`foreach ($this->getKeyValuePairs() as $pair) {`
`@@ -84,7 +84,7 @@ public function toArray()`
`84`	`84`	`return $array;`
`85`	`85`	`}`
`86`	`86`
`87`		`- protected function getKeyValuePairs()`
	`87`	`+ protected function getKeyValuePairs(): array`
`88`	`88`	`{`
`89`	`89`	`$pairs = [];`
`90`	`90`	`foreach (array_chunk($this->nodes, 2) as $pair) {`
`@@ -94,7 +94,7 @@ protected function getKeyValuePairs()`
`94`	`94`	`return $pairs;`
`95`	`95`	`}`
`96`	`96`
`97`		`- protected function compileArguments(Compiler $compiler, bool $withKeys = true)`
	`97`	`+ protected function compileArguments(Compiler $compiler, bool $withKeys = true): void`
`98`	`98`	`{`
`99`	`99`	`$first = true;`
`100`	`100`	`foreach ($this->getKeyValuePairs() as $pair) {`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function __construct(string $operator, Node $left, Node $right)`
`45`	`45`	`);`
`46`	`46`	`}`
`47`	`47`
`48`		`- public function compile(Compiler $compiler)`
	`48`	`+ public function compile(Compiler $compiler): void`
`49`	`49`	`{`
`50`	`50`	`$operator = $this->attributes['operator'];`
`51`	`51`
`@@ -92,7 +92,7 @@ public function compile(Compiler $compiler)`
`92`	`92`	`;`
`93`	`93`	`}`
`94`	`94`
`95`		`- public function evaluate(array $functions, array $values)`
	`95`	`+ public function evaluate(array $functions, array $values): mixed`
`96`	`96`	`{`
`97`	`97`	`$operator = $this->attributes['operator'];`
`98`	`98`	`$left = $this->nodes['left']->evaluate($functions, $values);`
`@@ -171,7 +171,7 @@ public function evaluate(array $functions, array $values)`
`171`	`171`	`}`
`172`	`172`	`}`
`173`	`173`
`174`		`- public function toArray()`
	`174`	`+ public function toArray(): array`
`175`	`175`	`{`
`176`	`176`	`return ['(', $this->nodes['left'], ' '.$this->attributes['operator'].' ', $this->nodes['right'], ')'];`
`177`	`177`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,17 +33,17 @@ public function __construct(mixed $value, bool $isIdentifier = false, bool $isNu`
`33`	`33`	`);`
`34`	`34`	`}`
`35`	`35`
`36`		`- public function compile(Compiler $compiler)`
	`36`	`+ public function compile(Compiler $compiler): void`
`37`	`37`	`{`
`38`	`38`	`$compiler->repr($this->attributes['value']);`
`39`	`39`	`}`
`40`	`40`
`41`		`- public function evaluate(array $functions, array $values)`
	`41`	`+ public function evaluate(array $functions, array $values): mixed`
`42`	`42`	`{`
`43`	`43`	`return $this->attributes['value'];`
`44`	`44`	`}`
`45`	`45`
`46`		`- public function toArray()`
	`46`	`+ public function toArray(): array`
`47`	`47`	`{`
`48`	`48`	`$array = [];`
`49`	`49`	`$value = $this->attributes['value'];`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,9 @@ class GetAttrNode extends Node`
`24`	`24`	`public const METHOD_CALL = 2;`
`25`	`25`	`public const ARRAY_CALL = 3;`
`26`	`26`
	`27`	`+ /**`
	`28`	`+ * @param self::* $type`
	`29`	`+ */`
`27`	`30`	`public function __construct(Node $node, Node $attribute, ArrayNode $arguments, int $type)`
`28`	`31`	`{`
`29`	`32`	`parent::__construct(`
`@@ -32,7 +35,7 @@ public function __construct(Node $node, Node $attribute, ArrayNode $arguments, i`
`32`	`35`	`);`
`33`	`36`	`}`
`34`	`37`
`35`		`- public function compile(Compiler $compiler)`
	`38`	`+ public function compile(Compiler $compiler): void`
`36`	`39`	`{`
`37`	`40`	`$nullSafe = $this->nodes['attribute'] instanceof ConstantNode && $this->nodes['attribute']->isNullSafe;`
`38`	`41`	`switch ($this->attributes['type']) {`
`@@ -65,7 +68,7 @@ public function compile(Compiler $compiler)`
`65`	`68`	`}`
`66`	`69`	`}`
`67`	`70`
`68`		`- public function evaluate(array $functions, array $values)`
	`71`	`+ public function evaluate(array $functions, array $values): mixed`
`69`	`72`	`{`
`70`	`73`	`switch ($this->attributes['type']) {`
`71`	`74`	`case self::PROPERTY_CALL:`
`@@ -136,7 +139,7 @@ private function isShortCircuited(): bool`
`136`	`139`	`return $this->attributes['is_short_circuited'] \|\| ($this->nodes['node'] instanceof self && $this->nodes['node']->isShortCircuited());`
`137`	`140`	`}`
`138`	`141`
`139`		`- public function toArray()`
	`142`	`+ public function toArray(): array`
`140`	`143`	`{`
`141`	`144`	`switch ($this->attributes['type']) {`
`142`	`145`	`case self::PROPERTY_CALL:`
Original file line number	Diff line number	Diff line change
`@@ -28,17 +28,17 @@ public function __construct(string $name)`
`28`	`28`	`);`
`29`	`29`	`}`
`30`	`30`
`31`		`- public function compile(Compiler $compiler)`
	`31`	`+ public function compile(Compiler $compiler): void`
`32`	`32`	`{`
`33`	`33`	`$compiler->raw('$'.$this->attributes['name']);`
`34`	`34`	`}`
`35`	`35`
`36`		`- public function evaluate(array $functions, array $values)`
	`36`	`+ public function evaluate(array $functions, array $values): mixed`
`37`	`37`	`{`
`38`	`38`	`return $values[$this->attributes['name']];`
`39`	`39`	`}`
`40`	`40`
`41`		`- public function toArray()`
	`41`	`+ public function toArray(): array`
`42`	`42`	`{`
`43`	`43`	`return [$this->attributes['name']];`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public function __construct(Node $expr1, Node $expr2)`
`25`	`25`	`parent::__construct(['expr1' => $expr1, 'expr2' => $expr2]);`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function compile(Compiler $compiler)`
	`28`	`+ public function compile(Compiler $compiler): void`
`29`	`29`	`{`
`30`	`30`	`$compiler`
`31`	`31`	`->raw('((')`
`@@ -36,7 +36,7 @@ public function compile(Compiler $compiler)`
`36`	`36`	`;`
`37`	`37`	`}`
`38`	`38`
`39`		`- public function evaluate(array $functions, array $values)`
	`39`	`+ public function evaluate(array $functions, array $values): mixed`
`40`	`40`	`{`
`41`	`41`	`if ($this->nodes['expr1'] instanceof GetAttrNode) {`
`42`	`42`	`$this->nodes['expr1']->attributes['is_null_coalesce'] = true;`
`@@ -45,7 +45,7 @@ public function evaluate(array $functions, array $values)`
`45`	`45`	`return $this->nodes['expr1']->evaluate($functions, $values) ?? $this->nodes['expr2']->evaluate($functions, $values);`
`46`	`46`	`}`
`47`	`47`
`48`		`- public function toArray()`
	`48`	`+ public function toArray(): array`
`49`	`49`	`{`
`50`	`50`	`return ['(', $this->nodes['expr1'], ') ?? (', $this->nodes['expr2'], ')'];`
`51`	`51`	`}`