Merge #459 - Add native return types

williamdes · williamdes · commit 568e3c8e5822 · 2023-06-01T10:42:49.000+02:00
Pull-request: #459 Signed-off-by: William Desportes <williamdes@wdes.fr>
diff --git a/src/Components/AlterOperation.php b/src/Components/AlterOperation.php
@@ -553,10 +553,8 @@ public static function build($component, array $options = []): string
      * between column and table alteration
      *
      * @param string $tokenValue Value of current token
-     *
-     * @return bool
      */
-    private static function checkIfColumnDefinitionKeyword($tokenValue)
+    private static function checkIfColumnDefinitionKeyword($tokenValue): bool
     {
         $commonOptions = [
             'AUTO_INCREMENT',
@@ -579,10 +577,8 @@ private static function checkIfColumnDefinitionKeyword($tokenValue)
      * Check if token is symbol and quoted with backtick
      *
      * @param Token $token token to check
-     *
-     * @return bool
      */
-    private static function checkIfTokenQuotedSymbol($token)
+    private static function checkIfTokenQuotedSymbol($token): bool
     {
         return $token->type === Token::TYPE_SYMBOL && $token->flags === Token::FLAG_SYMBOL_BACKTICK;
     }
diff --git a/src/Components/Array2d.php b/src/Components/Array2d.php
@@ -25,7 +25,7 @@ final class Array2d implements Component
      *
      * @return ArrayObj[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/Condition.php b/src/Components/Condition.php
@@ -95,7 +95,7 @@ public function __construct($expr = null)
      *
      * @return Condition[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/ExpressionArray.php b/src/Components/ExpressionArray.php
@@ -31,7 +31,7 @@ final class ExpressionArray implements Component
      *
      * @throws ParserException
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/GroupKeyword.php b/src/Components/GroupKeyword.php
@@ -43,7 +43,7 @@ public function __construct($expr = null)
      *
      * @return GroupKeyword[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/IndexHint.php b/src/Components/IndexHint.php
@@ -68,9 +68,9 @@ public function __construct(
      * @param TokensList           $list    the list of tokens that are being parsed
      * @param array<string, mixed> $options parameters for parsing
      *
-     * @return IndexHint|Component[]
+     * @return IndexHint[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
         $expr = new static();
diff --git a/src/Components/JoinKeyword.php b/src/Components/JoinKeyword.php
@@ -93,7 +93,7 @@ public function __construct($type = null, $expr = null, $on = null, $using = nul
      *
      * @return JoinKeyword[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/OptionsArray.php b/src/Components/OptionsArray.php
@@ -329,7 +329,7 @@ public function has($key, $getExpr = false)
      *
      * @return bool whether the key was found and deleted or not
      */
-    public function remove($key)
+    public function remove($key): bool
     {
         foreach ($this->options as $idx => $option) {
             if (is_array($option)) {
@@ -367,10 +367,8 @@ public function merge($options)
 
     /**
      * Checks tf there are no options set.
-     *
-     * @return bool
      */
-    public function isEmpty()
+    public function isEmpty(): bool
     {
         return empty($this->options);
     }
diff --git a/src/Components/OrderKeyword.php b/src/Components/OrderKeyword.php
@@ -48,7 +48,7 @@ public function __construct($expr = null, $type = 'ASC')
      *
      * @return OrderKeyword[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/ParameterDefinition.php b/src/Components/ParameterDefinition.php
@@ -59,7 +59,7 @@ public function __construct($name = null, $inOut = null, $type = null)
      *
      * @return ParameterDefinition[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/RenameOperation.php b/src/Components/RenameOperation.php
@@ -48,7 +48,7 @@ public function __construct($old = null, $new = null)
      *
      * @return RenameOperation[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Components/SetOperation.php b/src/Components/SetOperation.php
@@ -49,7 +49,7 @@ public function __construct($column = '', $value = '')
      *
      * @return SetOperation[]
      */
-    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    public static function parse(Parser $parser, TokensList $list, array $options = []): array
     {
         $ret = [];
 
diff --git a/src/Statements/AlterStatement.php b/src/Statements/AlterStatement.php
@@ -134,10 +134,7 @@ public function parse(Parser $parser, TokensList $list)
         }
     }
 
-    /**
-     * @return string
-     */
-    public function build()
+    public function build(): string
     {
         $tmp = [];
         foreach ($this->altered as $altered) {
diff --git a/src/Statements/LockStatement.php b/src/Statements/LockStatement.php
@@ -120,10 +120,7 @@ public function parse(Parser $parser, TokensList $list)
         $parser->error('Unexpected end of LOCK statement.', $prevToken);
     }
 
-    /**
-     * @return string
-     */
-    public function build()
+    public function build(): string
     {
         return trim(($this->isLock ? 'LOCK' : 'UNLOCK')
             . ' TABLES ' . LockExpression::build($this->locked));
diff --git a/src/Statements/PurgeStatement.php b/src/Statements/PurgeStatement.php
@@ -42,10 +42,7 @@ class PurgeStatement extends Statement
      */
     public $endExpr;
 
-    /**
-     * @return string
-     */
-    public function build()
+    public function build(): string
     {
         $ret = 'PURGE ' . $this->logType . ' LOGS '
             . ($this->endOption !== null ? ($this->endOption . ' ' . $this->endExpr) : '');
diff --git a/src/Statements/SetStatement.php b/src/Statements/SetStatement.php
@@ -102,10 +102,7 @@ class SetStatement extends Statement
      */
     public $set;
 
-    /**
-     * @return string
-     */
-    public function build()
+    public function build(): string
     {
         $ret = 'SET ' . OptionsArray::build($this->options)
             . ' ' . SetOperation::build($this->set)
diff --git a/src/Statements/WithStatement.php b/src/Statements/WithStatement.php
@@ -294,10 +294,8 @@ public function build()
 
     /**
      * Get tokens within the WITH expression to use them in another parser
-     *
-     * @return ParserException|TokensList
      */
-    private function getSubTokenList(TokensList $list)
+    private function getSubTokenList(TokensList $list): ParserException|TokensList
     {
         $idx = $list->idx;
         $token = $list->tokens[$list->idx];
diff --git a/src/Token.php b/src/Token.php
@@ -321,10 +321,8 @@ public function extract()
 
     /**
      * Converts the token into an inline token by replacing tabs and new lines.
-     *
-     * @return string
      */
-    public function getInlineToken()
+    public function getInlineToken(): string
     {
         return str_replace(
             [
diff --git a/src/Tools/ContextGenerator.php b/src/Tools/ContextGenerator.php
@@ -210,10 +210,8 @@ public static function readWords(array $files)
      * @param array<int, array<int, array<int, string>>> $words  the list of words to be formatted
      * @param int                                        $spaces the number of spaces that starts every line
      * @param int                                        $line   the length of a line
-     *
-     * @return string
      */
-    public static function printWords($words, $spaces = 8, $line = 140)
+    public static function printWords($words, $spaces = 8, $line = 140): string
     {
         $typesCount = count($words);
         $ret = '';
@@ -266,10 +264,8 @@ public static function printWords($words, $spaces = 8, $line = 140)
      *   link: string,
      *   keywords: array<int, array<int, array<int, string>>>
      * } $options
-     *
-     * @return string
      */
-    public static function generate($options)
+    public static function generate($options): string
     {
         if (isset($options['keywords'])) {
             $options['keywords'] = static::printWords($options['keywords']);
diff --git a/src/Tools/CustomJsonSerializer.php b/src/Tools/CustomJsonSerializer.php
@@ -55,7 +55,7 @@ class CustomJsonSerializer extends JsonSerializer
      *
      * @return array<string,mixed>
      */
-    protected function extractObjectData($value, $ref, $properties)
+    protected function extractObjectData($value, $ref, $properties): array
     {
         $data = [];
         foreach ($properties as $property) {
diff --git a/src/Tools/TestGenerator.php b/src/Tools/TestGenerator.php
@@ -48,7 +48,7 @@ class TestGenerator
      *
      * @return array<string, string|Lexer|Parser|array<string, array<int, array<int, int|string|Token>>>|null>
      */
-    public static function generate($query, $type = 'parser')
+    public static function generate($query, $type = 'parser'): array
     {
         /**
          * Lexer used for tokenizing the query.
diff --git a/src/UtfString.php b/src/UtfString.php
@@ -201,11 +201,9 @@ public function __construct($str)
      * Checks if the given offset exists.
      *
      * @param int $offset the offset to be checked
-     *
-     * @return bool
      */
     #[\ReturnTypeWillChange]
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         return ($offset >= 0) && ($offset < $this->charLen);
     }
diff --git a/src/Utils/CLI.php b/src/Utils/CLI.php
@@ -62,7 +62,7 @@ public function usageHighlight()
      *
      * @return string[]|false[]|false
      */
-    public function getopt($opt, $long)
+    public function getopt($opt, $long): array|false
     {
         return getopt($opt, $long);
     }
diff --git a/src/Utils/Error.php b/src/Utils/Error.php
@@ -29,7 +29,7 @@ class Error
      *               `$err[3]` holds the position of the string.
      *               (i.e. `[$msg, $code, $str, $pos]`)
      */
-    public static function get($objs)
+    public static function get($objs): array
     {
         $ret = [];
 
@@ -77,7 +77,7 @@ public static function get($objs)
     public static function format(
         $errors,
         $format = '#%1$d: %2$s (near "%4$s" at position %5$d)'
-    ) {
+    ): array {
         $ret = [];
 
         $i = 0;
diff --git a/src/Utils/Formatter.php b/src/Utils/Formatter.php
@@ -133,7 +133,7 @@ protected function getMergedOptions(array $options)
      *   indent_parts: true
      * }
      */
-    protected function getDefaultOptions()
+    protected function getDefaultOptions(): array
     {
         return [
             /*
@@ -196,7 +196,7 @@ protected function getDefaultOptions()
      * @return array<int, array<string, int|string>>
      * @psalm-return list<array{type: int, flags: int, html: string, cli: string, function: string}>
      */
-    protected function getDefaultFormats()
+    protected function getDefaultFormats(): array
     {
         return [
             [
diff --git a/src/Utils/Query.php b/src/Utils/Query.php
@@ -611,10 +611,8 @@ public static function getTables($statement)
      *                              If string, the name of the first clause that
      *                              should not be included.
      * @param bool       $skipFirst whether to skip the first keyword in clause
-     *
-     * @return string
      */
-    public static function getClause($statement, $list, $clause, $type = 0, $skipFirst = true)
+    public static function getClause($statement, $list, $clause, $type = 0, $skipFirst = true): string
     {
         /**
          * The index of the current clause.
@@ -823,7 +821,7 @@ public static function replaceClauses($statement, $list, array $ops)
      *                                 the remaining part of the query and the last delimiter
      * @psalm-return array{string|null, string, string|null}
      */
-    public static function getFirstStatement($query, $delimiter = null)
+    public static function getFirstStatement($query, $delimiter = null): array
     {
         $lexer = new Lexer($query, false, $delimiter);
         $list = $lexer->list;
diff --git a/src/Utils/Routine.php b/src/Utils/Routine.php
@@ -25,7 +25,7 @@ class Routine
      *
      * @return string[]
      */
-    public static function getReturnType($param)
+    public static function getReturnType($param): array
     {
         $lexer = new Lexer($param);
 
@@ -63,7 +63,7 @@ public static function getReturnType($param)
      *
      * @return string[]
      */
-    public static function getParameter($param)
+    public static function getParameter($param): array
     {
         $lexer = new Lexer('(' . $param . ')');
 
@@ -103,7 +103,7 @@ public static function getParameter($param)
      *
      * @return array<string, int|array<int, mixed[]|string|null>>
      */
-    public static function getParameters($statement)
+    public static function getParameters($statement): array
     {
         $retval = [
             'num' => 0,
diff --git a/src/Utils/Tokens.php b/src/Utils/Tokens.php
@@ -22,10 +22,8 @@ class Tokens
      *
      * @param Token                          $token   the token to be matched
      * @param array<string, int|string|null> $pattern the pattern to be matches
-     *
-     * @return bool
      */
-    public static function match(Token $token, array $pattern)
+    public static function match(Token $token, array $pattern): bool
     {
         // Token.
         if (isset($pattern['token']) && ($pattern['token'] !== $token->token)) {

Original file line number	Diff line number	Diff line change
`@@ -553,10 +553,8 @@ public static function build($component, array $options = []): string`
`553`	`553`	`* between column and table alteration`
`554`	`554`	`*`
`555`	`555`	`* @param string $tokenValue Value of current token`
`556`		`- *`
`557`		`- * @return bool`
`558`	`556`	`*/`
`559`		`- private static function checkIfColumnDefinitionKeyword($tokenValue)`
	`557`	`+ private static function checkIfColumnDefinitionKeyword($tokenValue): bool`
`560`	`558`	`{`
`561`	`559`	`$commonOptions = [`
`562`	`560`	`'AUTO_INCREMENT',`
`@@ -579,10 +577,8 @@ private static function checkIfColumnDefinitionKeyword($tokenValue)`
`579`	`577`	`* Check if token is symbol and quoted with backtick`
`580`	`578`	`*`
`581`	`579`	`* @param Token $token token to check`
`582`		`- *`
`583`		`- * @return bool`
`584`	`580`	`*/`
`585`		`- private static function checkIfTokenQuotedSymbol($token)`
	`581`	`+ private static function checkIfTokenQuotedSymbol($token): bool`
`586`	`582`	`{`
`587`	`583`	`return $token->type === Token::TYPE_SYMBOL && $token->flags === Token::FLAG_SYMBOL_BACKTICK;`
`588`	`584`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ final class Array2d implements Component`
`25`	`25`	`*`
`26`	`26`	`* @return ArrayObj[]`
`27`	`27`	`*/`
`28`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`28`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`29`	`29`	`{`
`30`	`30`	`$ret = [];`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public function __construct($expr = null)`
`95`	`95`	`*`
`96`	`96`	`* @return Condition[]`
`97`	`97`	`*/`
`98`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`98`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`99`	`99`	`{`
`100`	`100`	`$ret = [];`
`101`	`101`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ final class ExpressionArray implements Component`
`31`	`31`	`*`
`32`	`32`	`* @throws ParserException`
`33`	`33`	`*/`
`34`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`34`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`35`	`35`	`{`
`36`	`36`	`$ret = [];`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function __construct($expr = null)`
`43`	`43`	`*`
`44`	`44`	`* @return GroupKeyword[]`
`45`	`45`	`*/`
`46`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`46`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`47`	`47`	`{`
`48`	`48`	`$ret = [];`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -68,9 +68,9 @@ public function __construct(`
`68`	`68`	`* @param TokensList $list the list of tokens that are being parsed`
`69`	`69`	`* @param array<string, mixed> $options parameters for parsing`
`70`	`70`	`*`
`71`		`- * @return IndexHint\|Component[]`
	`71`	`+ * @return IndexHint[]`
`72`	`72`	`*/`
`73`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`73`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`74`	`74`	`{`
`75`	`75`	`$ret = [];`
`76`	`76`	`$expr = new static();`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public function __construct($type = null, $expr = null, $on = null, $using = nul`
`93`	`93`	`*`
`94`	`94`	`* @return JoinKeyword[]`
`95`	`95`	`*/`
`96`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`96`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`97`	`97`	`{`
`98`	`98`	`$ret = [];`
`99`	`99`
Original file line number	Diff line number	Diff line change
`@@ -329,7 +329,7 @@ public function has($key, $getExpr = false)`
`329`	`329`	`*`
`330`	`330`	`* @return bool whether the key was found and deleted or not`
`331`	`331`	`*/`
`332`		`- public function remove($key)`
	`332`	`+ public function remove($key): bool`
`333`	`333`	`{`
`334`	`334`	`foreach ($this->options as $idx => $option) {`
`335`	`335`	`if (is_array($option)) {`
`@@ -367,10 +367,8 @@ public function merge($options)`
`367`	`367`
`368`	`368`	`/**`
`369`	`369`	`* Checks tf there are no options set.`
`370`		`- *`
`371`		`- * @return bool`
`372`	`370`	`*/`
`373`		`- public function isEmpty()`
	`371`	`+ public function isEmpty(): bool`
`374`	`372`	`{`
`375`	`373`	`return empty($this->options);`
`376`	`374`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function __construct($expr = null, $type = 'ASC')`
`48`	`48`	`*`
`49`	`49`	`* @return OrderKeyword[]`
`50`	`50`	`*/`
`51`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`51`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`52`	`52`	`{`
`53`	`53`	`$ret = [];`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public function __construct($name = null, $inOut = null, $type = null)`
`59`	`59`	`*`
`60`	`60`	`* @return ParameterDefinition[]`
`61`	`61`	`*/`
`62`		`- public static function parse(Parser $parser, TokensList $list, array $options = [])`
	`62`	`+ public static function parse(Parser $parser, TokensList $list, array $options = []): array`
`63`	`63`	`{`
`64`	`64`	`$ret = [];`
`65`	`65`