[TASK] Use more PHP 7.4 language features

Also use more specific PHPDoc type annotations.
martin-helmich · May 31, 2023 · 31b8d19 · 31b8d19
1 parent a3f48a3
commit 31b8d19
Show file tree

Hide file tree

Showing 23 changed files with 89 additions and 122 deletions.
diff --git a/src/Linter/Configuration/ConfigurationLocator.php b/src/Linter/Configuration/ConfigurationLocator.php
@@ -17,11 +17,9 @@
 class ConfigurationLocator
 {
 
-    /** @var LoaderInterface */
-    private $loader;
+    private LoaderInterface $loader;
 
-    /** @var Processor */
-    private $processor;
+    private Processor $processor;
 
     /**
      * Constructs a new configuration locator.
@@ -64,7 +62,7 @@ public function loadConfiguration(
             $configs[] = $loadedConfig;
         }
 
-        $configuration = $configuration ?? new LinterConfiguration();
+        $configuration ??= new LinterConfiguration();
 
         $processedConfiguration = $this->processor->processConfiguration(
             $configuration,

diff --git a/src/Linter/Configuration/YamlConfigurationLoader.php b/src/Linter/Configuration/YamlConfigurationLoader.php
@@ -21,11 +21,9 @@
 class YamlConfigurationLoader extends FileLoader
 {
 
-    /** @var YamlParser */
-    private $yamlParser;
+    private YamlParser $yamlParser;
 
-    /** @var Filesystem */
-    private $filesystem;
+    private Filesystem $filesystem;
 
     /**
      * Constructs a new YAML-based configuration loader.

diff --git a/src/Linter/Linter.php b/src/Linter/Linter.php
@@ -17,14 +17,11 @@
 class Linter implements LinterInterface
 {
 
-    /** @var TokenizerInterface */
-    private $tokenizer;
+    private TokenizerInterface $tokenizer;
 
-    /** @var ParserInterface */
-    private $parser;
+    private ParserInterface $parser;
 
-    /** @var SniffLocator */
-    private $sniffLocator;
+    private SniffLocator $sniffLocator;
 
     public function __construct(TokenizerInterface $tokenizer, ParserInterface $parser, SniffLocator $sniffLocator)
     {

diff --git a/src/Linter/LinterConfiguration.php b/src/Linter/LinterConfiguration.php
@@ -8,9 +8,11 @@
 class LinterConfiguration implements ConfigurationInterface
 {
 
-    /** @var array */
-    private $configuration = [];
+    private array $configuration = [];
 
+    /**
+     * @param mixed[] $configuration
+     */
     public function setConfiguration(array $configuration): void
     {
         $this->configuration = $configuration;

diff --git a/src/Linter/Report/File.php b/src/Linter/Report/File.php
@@ -13,11 +13,10 @@
 class File
 {
 
-    /** @var string */
-    private $filename;
+    private string $filename;
 
     /** @var Issue[] */
-    private $issues = [];
+    private array $issues = [];
 
     /**
      * Constructs a new file report.
@@ -61,9 +60,7 @@ public function getIssues(): array
     {
         usort(
             $this->issues,
-            function (Issue $a, Issue $b): int {
-                return ($a->getLine() ?? 0) - ($b->getLine() ?? 0);
-            }
+            fn(Issue $a, Issue $b): int => ($a->getLine() ?? 0) - ($b->getLine() ?? 0)
         );
         return $this->issues;
     }
@@ -77,9 +74,7 @@ function (Issue $a, Issue $b): int {
      */
     public function getIssuesBySeverity(string $severity): array
     {
-        return array_values(array_filter($this->getIssues(), function (Issue $i) use ($severity): bool {
-            return $i->getSeverity() === $severity;
-        }));
+        return array_values(array_filter($this->getIssues(), fn(Issue $i): bool => $i->getSeverity() === $severity));
     }
 
     /**

diff --git a/src/Linter/Report/Issue.php b/src/Linter/Report/Issue.php
@@ -16,24 +16,19 @@
 class Issue
 {
 
-    const SEVERITY_INFO = "info";
-    const SEVERITY_WARNING = "warning";
-    const SEVERITY_ERROR = "error";
+    public const SEVERITY_INFO = "info";
+    public const SEVERITY_WARNING = "warning";
+    public const SEVERITY_ERROR = "error";
 
-    /** @var int|null */
-    private $line;
+    private ?int $line = null;
 
-    /** @var int|null */
-    private $column;
+    private ?int $column = null;
 
-    /** @var string */
-    private $message;
+    private string $message;
 
-    /** @var string */
-    private $severity;
+    private string $severity;
 
-    /** @var string */
-    private $source;
+    private string $source;
 
     /**
      * Creates a new warning from a parse error.

diff --git a/src/Linter/Report/Report.php b/src/Linter/Report/Report.php
@@ -14,7 +14,7 @@ class Report
 {
 
     /** @var File[] */
-    private $files = [];
+    private array $files = [];
 
     /**
      * Adds a sub-report for a specific file.

diff --git a/src/Linter/ReportPrinter/CheckstyleReportPrinter.php b/src/Linter/ReportPrinter/CheckstyleReportPrinter.php
@@ -22,8 +22,7 @@
 class CheckstyleReportPrinter implements Printer
 {
 
-    /** @var OutputInterface */
-    private $output;
+    private OutputInterface $output;
 
     /**
      * Constructs a new checkstyle report printer.

diff --git a/src/Linter/ReportPrinter/ConsoleReportPrinter.php b/src/Linter/ReportPrinter/ConsoleReportPrinter.php
@@ -19,8 +19,7 @@
 class ConsoleReportPrinter implements Printer
 {
 
-    /** @var OutputInterface */
-    private $output;
+    private OutputInterface $output;
 
     /**
      * Constructs a new console report printer.

diff --git a/src/Linter/ReportPrinter/GccReportPrinter.php b/src/Linter/ReportPrinter/GccReportPrinter.php
@@ -18,8 +18,7 @@
 class GccReportPrinter implements Printer
 {
 
-    /** @var OutputInterface */
-    private $output;
+    private OutputInterface $output;
 
     /**
      * Constructs a new GCC report printer.

diff --git a/src/Linter/Sniff/DeadCodeSniff.php b/src/Linter/Sniff/DeadCodeSniff.php
@@ -12,7 +12,7 @@
 class DeadCodeSniff implements TokenStreamSniffInterface
 {
 
-    const ANNOTATION_COMMENT = '/^\s*([a-z0-9]+=(.*?))(;\s*[a-z0-9]+=(.*?))*\s*$/';
+    public const ANNOTATION_COMMENT = '/^\s*([a-z0-9]+=(.*?))(;\s*[a-z0-9]+=(.*?))*\s*$/';
 
     /**
      * @param array $parameters
@@ -51,7 +51,7 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
                             0,
                             'Found commented code (' . $matches[0] . ').',
                             Issue::SEVERITY_INFO,
-                            __CLASS__
+                            self::class
                         ));
                     } catch (\Exception $e) {
                         // pass

diff --git a/src/Linter/Sniff/IndentationSniff.php b/src/Linter/Sniff/IndentationSniff.php
@@ -15,25 +15,19 @@ class IndentationSniff implements TokenStreamSniffInterface
 {
     use TokenInspections;
 
-    /** @var bool */
-    private $useSpaces = true;
+    private bool $useSpaces = true;
 
-    /** @var int */
-    private $indentPerLevel = 4;
+    private int $indentPerLevel = 4;
 
     /**
      * Defines whether code inside conditions should be indented by one level.
-     *
-     * @var bool
      */
-    private $indentConditions = false;
+    private bool $indentConditions = false;
 
     /**
      * Track whether we are inside a condition.
-     *
-     * @var bool
      */
-    private $insideCondition = false;
+    private bool $insideCondition = false;
 
     /**
      * @param array $parameters
@@ -77,9 +71,12 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
                 $expectedIndentationCharacterCount
             );
 
-            $tokensInLine = array_values(array_filter($tokensInLine, function (TokenInterface $token): bool {
-                return $token->getType() !== TokenInterface::TYPE_RIGHTVALUE_MULTILINE;
-            }));
+            $tokensInLine = array_values(
+                array_filter(
+                    $tokensInLine,
+                    fn(TokenInterface $token): bool => $token->getType() !== TokenInterface::TYPE_RIGHTVALUE_MULTILINE
+                )
+            );
 
             // Skip empty lines and conditions inside conditions.
             if ($this->isEmptyLine($tokensInLine) || ($this->insideCondition && self::isCondition($tokensInLine[0]))) {
@@ -112,9 +109,12 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
      */
     private function isEmptyLine(array $tokensInLine): bool
     {
-        $tokensInLine = array_values(array_filter($tokensInLine, function (TokenInterface $t): bool {
-            return $t->getType() !== TokenInterface::TYPE_EMPTY_LINE;
-        }));
+        $tokensInLine = array_values(
+            array_filter(
+                $tokensInLine,
+                fn(TokenInterface $t): bool => $t->getType() !== TokenInterface::TYPE_EMPTY_LINE
+            )
+        );
 
         if (count($tokensInLine) === 0) {
             return true;
@@ -199,6 +199,6 @@ private function createIssue(int $line, int $expectedLevel, string $actual): Iss
 
         $expectedMessage = "Expected indent of {$indentCharacterCount} {$indentCharacterDescription}.";
 
-        return new Issue($line, strlen($actual), $expectedMessage, Issue::SEVERITY_WARNING, __CLASS__);
+        return new Issue($line, strlen($actual), $expectedMessage, Issue::SEVERITY_WARNING, self::class);
     }
 }
diff --git a/src/Linter/Sniff/OperatorWhitespaceSniff.php b/src/Linter/Sniff/OperatorWhitespaceSniff.php
@@ -47,15 +47,15 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
                         null,
                         'No whitespace after object accessor.',
                         Issue::SEVERITY_WARNING,
-                        __CLASS__
+                        self::class
                     ));
                 } elseif (!self::isWhitespaceOfLength($tokensInLine[$i + 1], 1)) {
                     $file->addIssue(new Issue(
                         $tokensInLine[$i]->getLine(),
                         null,
                         'Accessor should be followed by single space.',
                         Issue::SEVERITY_WARNING,
-                        __CLASS__
+                        self::class
                     ));
                 }
 
@@ -72,15 +72,15 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
                             null,
                             'No whitespace after operator.',
                             Issue::SEVERITY_WARNING,
-                            __CLASS__
+                            self::class
                         ));
                     } elseif (!self::isWhitespaceOfLength($tokensInLine[$j + 1], 1)) {
                         $file->addIssue(new Issue(
                             $tokensInLine[$j]->getLine(),
                             null,
                             'Operator should be followed by single space.',
                             Issue::SEVERITY_WARNING,
-                            __CLASS__
+                            self::class
                         ));
                     }
                 }

diff --git a/src/Linter/Sniff/RepeatingRValueSniff.php b/src/Linter/Sniff/RepeatingRValueSniff.php
@@ -10,16 +10,15 @@
 class RepeatingRValueSniff implements TokenStreamSniffInterface
 {
 
-    const CONSTANT_EXPRESSION = ',\{\$[a-zA-Z0-9_\.]+\},';
+    public const CONSTANT_EXPRESSION = ',\{\$[a-zA-Z0-9_\.]+\},';
 
     /** @var array<string, int> */
-    private $knownRightValues = [];
+    private array $knownRightValues = [];
 
     /** @var string[] */
-    private $allowedRightValues = [];
+    private array $allowedRightValues = [];
 
-    /** @var int */
-    private $valueLengthThreshold = 8;
+    private int $valueLengthThreshold = 8;
 
     /**
      * @param array $parameters
@@ -75,7 +74,7 @@ public function sniff(array $tokens, File $file, LinterConfiguration $configurat
                     null,
                     'Duplicated value "' . $token->getValue() . '". Consider extracting it into a constant.',
                     Issue::SEVERITY_WARNING,
-                    __CLASS__
+                    self::class
                 ));
             }
         }

diff --git a/src/Linter/Sniff/SniffLocator.php b/src/Linter/Sniff/SniffLocator.php
@@ -9,7 +9,7 @@ class SniffLocator
 {
 
     /** @var SniffInterface[]|null */
-    private $sniffs = null;
+    private ?array $sniffs = null;
 
     /**
      * @param LinterConfiguration $configuration
@@ -29,11 +29,11 @@ private function loadSniffs(LinterConfiguration $configuration): array
         foreach ($configuration->getSniffConfigurations() as $sniffConfiguration) {
             if (!class_exists($sniffConfiguration['class'])) {
                 throw new Exception(
-                    'Class "' . $sniffConfiguration['class'] . '" could not be loaded!', 1402948667
+                    'Class "' . $sniffConfiguration['class'] . '" could not be loaded!', 1_402_948_667
                 );
             }
 
-            $parameters = isset($sniffConfiguration['parameters']) ? $sniffConfiguration['parameters'] : [];
+            $parameters = $sniffConfiguration['parameters'] ?? [];
 
             /** @var SniffInterface $sniff */
             $sniff = new $sniffConfiguration['class']($parameters);

diff --git a/src/Linter/Sniff/Visitor/ConfigNoCacheVisitor.php b/src/Linter/Sniff/Visitor/ConfigNoCacheVisitor.php
@@ -10,7 +10,7 @@
 class ConfigNoCacheVisitor implements SniffVisitor
 {
     /** @var Issue[] */
-    private $issues = [];
+    private array $issues = [];
 
     /**
      * @return Issue[]

diff --git a/src/Linter/Sniff/Visitor/DuplicateAssignmentVisitor.php b/src/Linter/Sniff/Visitor/DuplicateAssignmentVisitor.php
@@ -12,13 +12,12 @@ class DuplicateAssignmentVisitor implements SniffVisitor
 {
 
     /** @var Assignment[] */
-    private $assignments = [];
+    private array $assignments = [];
 
     /** @var Issue[] */
-    private $issues = [];
+    private array $issues = [];
 
-    /** @var bool */
-    private $inCondition = false;
+    private bool $inCondition = false;
 
     /**
      * @return Issue[]