4.0 | Tokenizers: add parameter types

Author: jrfnl

src/Tokenizers/Comment.php

@@ -25,7 +25,7 @@ class Comment
      *
      * @return array<int, array<string, string|int|array<int>>>
      */
-    public function tokenizeString($comment, $eolChar, $stackPtr)
+    public function tokenizeString(string $comment, string $eolChar, int $stackPtr)
     {
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
             StatusWriter::write('*** START COMMENT TOKENIZING ***', 2);
@@ -188,7 +188,7 @@ public function tokenizeString($comment, $eolChar, $stackPtr)
      *
      * @return array<int, array<string, string|int>>
      */
-    private function processLine($comment, $eolChar, $start, $end)
+    private function processLine(string $comment, string $eolChar, int $start, int $end)
     {
         $tokens = [];
 
@@ -263,7 +263,7 @@ private function processLine($comment, $eolChar, $start, $end)
      *
      * @return array<string, string|int>|null
      */
-    private function collectWhitespace($comment, $start, $end)
+    private function collectWhitespace(string $comment, int $start, int $end)
     {
         $space = '';
         for ($start; $start < $end; $start++) {

src/Tokenizers/PHP.php

@@ -535,7 +535,7 @@ class PHP extends Tokenizer
      *
      * @return array
      */
-    protected function tokenize($code)
+    protected function tokenize(string $code)
     {
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
             StatusWriter::write('*** START PHP TOKENIZING ***', 1);
@@ -3847,7 +3847,7 @@ public static function standardiseToken($token)
      *
      * @return array The new token in array format.
      */
-    public static function resolveSimpleToken($token)
+    public static function resolveSimpleToken(string $token)
     {
         $newToken = [];
 
@@ -3955,7 +3955,7 @@ public static function resolveSimpleToken($token)
      *
      * @return int|null The position of the closing token, if found. NULL otherwise.
      */
-    private function findCloser(array &$tokens, $start, $openerTokens, $closerChar)
+    private function findCloser(array &$tokens, int $start, $openerTokens, string $closerChar)
     {
         $numTokens    = count($tokens);
         $stack        = [0];
@@ -3990,7 +3990,7 @@ private function findCloser(array &$tokens, $start, $openerTokens, $closerChar)
      *
      * @return array|null The array of parsed attribute tokens
      */
-    private function parsePhpAttribute(array &$tokens, $stackPtr)
+    private function parsePhpAttribute(array &$tokens, int $stackPtr)
     {
 
         $token = $tokens[$stackPtr];

src/Tokenizers/Tokenizer.php

@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Tokenizers;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Exceptions\TokenizerException;
 use PHP_CodeSniffer\Util\Common;
 use PHP_CodeSniffer\Util\IgnoreList;
@@ -108,7 +109,7 @@ abstract class Tokenizer
      * @return void
      * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the file appears to be minified.
      */
-    public function __construct($content, $config, $eolChar='\n')
+    public function __construct(string $content, ?Config $config, string $eolChar='\n')
     {
         $this->eolChar = $eolChar;
 
@@ -139,7 +140,7 @@ public function __construct($content, $config, $eolChar='\n')
      *
      * @return boolean
      */
-    protected function isMinifiedContent($content, $eolChar='\n')
+    protected function isMinifiedContent(string $content, string $eolChar='\n')
     {
         // Minified files often have a very large number of characters per line
         // and cause issues when tokenizing.
@@ -174,7 +175,7 @@ public function getTokens()
      *
      * @return array
      */
-    abstract protected function tokenize($code);
+    abstract protected function tokenize(string $code);
 
 
     /**
@@ -500,7 +501,7 @@ private function createPositionMap()
      *
      * @return void
      */
-    public function replaceTabsInToken(&$token, $prefix=' ', $padding=' ', $tabWidth=null)
+    public function replaceTabsInToken(array &$token, string $prefix=' ', string $padding=' ', ?int $tabWidth=null)
     {
         $checkEncoding = false;
         if (function_exists('iconv_strlen') === true) {
@@ -840,7 +841,7 @@ private function createScopeMap()
      * @return int The position in the stack that closed the scope.
      * @throws \PHP_CodeSniffer\Exceptions\TokenizerException If the nesting level gets too deep.
      */
-    private function recurseScopeMap($stackPtr, $depth=1, &$ignore=0)
+    private function recurseScopeMap(int $stackPtr, int $depth=1, int &$ignore=0)
     {
         if (PHP_CODESNIFFER_VERBOSITY > 1) {
             StatusWriter::write("=> Begin scope map recursion at token $stackPtr with depth $depth", $depth);