enable strict_types in generator (#481)

(Continuing with pulling the changes from shish/safe into tcm/safe in small hopefully easy-to-review chunks)
thecodingmachine · Dec 2, 2024 · b35aab3 · b35aab3
1 parent 6343b3e
commit b35aab3
Show file tree

Hide file tree

Showing 32 changed files with 101 additions and 99 deletions.
diff --git a/generator/src/ComposerJsonEditor.php b/generator/src/ComposerJsonEditor.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe;
 

diff --git a/generator/src/DeprecateCommand.php b/generator/src/DeprecateCommand.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe;
 
@@ -23,7 +24,7 @@ protected function configure(): void
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         /** @var string $moduleName */
         $moduleName = $input->getArgument('module');

diff --git a/generator/src/DocPage.php b/generator/src/DocPage.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Safe;
 
 use function explode;
@@ -226,8 +228,6 @@ public function getMethodSynopsis(): array
 
     /**
      * Loads the XML file, resolving all DTD declared entities.
-     *
-     * @return \SimpleXMLElement
      */
     public function loadAndResolveFile(): \SimpleXMLElement
     {
@@ -258,8 +258,6 @@ public function loadAndResolveFile(): \SimpleXMLElement
 
     /**
      * Returns the module name in Camelcase.
-     *
-     * @return string
      */
     public function getModule(): string
     {

diff --git a/generator/src/EmptyTypeException.php b/generator/src/EmptyTypeException.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe;
 

diff --git a/generator/src/FileCreator.php b/generator/src/FileCreator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Safe;
 
 use Rector\Config\RectorConfig;
@@ -14,7 +16,6 @@ class FileCreator
      * This function generate an improved php lib function in a php file
      *
      * @param Method[] $functions
-     * @param string $path
      */
     public function generatePhpFile(array $functions, string $path): void
     {
@@ -64,7 +65,6 @@ private function getFunctionsNameList(array $functions): array
      * This function generate a PHP file containing the list of functions we can handle.
      *
      * @param Method[] $functions
-     * @param string $path
      */
     public function generateFunctionsList(array $functions, string $path): void
     {
@@ -86,7 +86,6 @@ public function generateFunctionsList(array $functions, string $path): void
      * Generates a configuration file for replacing all functions when using rector/rector.
      *
      * @param Method[] $functions
-     * @param string $path
      */
     public function generateRectorFile(array $functions, string $path): void
     {
@@ -148,9 +147,6 @@ public static function createFromPhpError(): self
 
     /**
      * Generates the name of the exception class
-     *
-     * @param string $moduleName
-     * @return string
      */
     public static function toExceptionName(string $moduleName): string
     {

diff --git a/generator/src/GenerateCommand.php b/generator/src/GenerateCommand.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe;
 
@@ -18,7 +19,7 @@ protected function configure(): void
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
 
         $this->rmGenerated();

diff --git a/generator/src/Method.php b/generator/src/Method.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Safe;
 
 use Safe\PhpStanFunctions\PhpStanFunction;
@@ -11,35 +13,19 @@ class Method
     const FALSY_TYPE = 1;
     const NULLSY_TYPE = 2;
     const EMPTY_TYPE = 3;
-    /**
-     * @var \SimpleXMLElement
-     */
-    private $functionObject;
-    /**
-     * @var \SimpleXMLElement
-     */
-    private $rootEntity;
-    /**
-     * @var string
-     */
-    private $moduleName;
+    private \SimpleXMLElement $functionObject;
+    private \SimpleXMLElement $rootEntity;
+    private string $moduleName;
     /**
      * @var Parameter[]|null
      */
-    private $params = null;
-    /**
-     * @var int
-     */
-    private $errorType;
+    private ?array $params = null;
+    private int $errorType;
     /**
      * The function prototype from the phpstan internal documentation (functionMap.php)
-     * @var PhpStanFunction|null
-     */
-    private $phpstanSignarure;
-    /**
-     * @var PhpStanType
      */
-    private $returnType;
+    private ?PhpStanFunction $phpstanSignarure;
+    private PhpStanType $returnType;
 
     public function __construct(\SimpleXMLElement $_functionObject, \SimpleXMLElement $rootEntity, string $moduleName, PhpStanFunctionMapReader $phpStanFunctionMapReader, int $errorType)
     {
@@ -225,8 +211,6 @@ public function getModuleName(): string
 
     /**
      * The function is overloaded if at least one parameter is optional with no default value and this parameter is not by reference.
-     *
-     * @return bool
      */
     public function isOverloaded(): bool
     {

diff --git a/generator/src/Parameter.php b/generator/src/Parameter.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Safe;
 
 use Safe\PhpStanFunctions\PhpStanFunction;
@@ -53,8 +56,6 @@ public function isByReference(): bool
     /**
      * Some parameters can be optional with no default value. In this case, the function is "overloaded" (which is not
      * possible in user-land but possible in core...)
-     *
-     * @return bool
      */
     public function isOptionalWithNoDefault(): bool
     {

diff --git a/generator/src/PhpStanFunctions/PhpStanFunction.php b/generator/src/PhpStanFunctions/PhpStanFunction.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe\PhpStanFunctions;
 
@@ -13,7 +14,7 @@ class PhpStanFunction
     /**
      * @var PhpStanParameter[]
      */
-    private $parameters = [];
+    private array $parameters = [];
 
     /**
      * @param string[] $signature

diff --git a/generator/src/PhpStanFunctions/PhpStanFunctionMapReader.php b/generator/src/PhpStanFunctions/PhpStanFunctionMapReader.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe\PhpStanFunctions;
 

diff --git a/generator/src/PhpStanFunctions/PhpStanParameter.php b/generator/src/PhpStanFunctions/PhpStanParameter.php
@@ -1,20 +1,15 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe\PhpStanFunctions;
 
 use Safe\Type;
 
 class PhpStanParameter
 {
-    /**
-     * @var string
-     */
-    private $name;
-    /**
-     * @var PhpStanType
-     */
-    private $type;
+    private string $name;
+    private PhpStanType $type;
 
     public function __construct(string $name, string $type)
     {
@@ -29,9 +24,6 @@ public function __construct(string $name, string $type)
         $this->type = new PhpStanType($type, $writeOnly);
     }
 
-    /**
-     * @return string
-     */
     public function getName(): string
     {
         return $this->name;

diff --git a/generator/src/PhpStanFunctions/PhpStanType.php b/generator/src/PhpStanFunctions/PhpStanType.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe\PhpStanFunctions;
 
@@ -11,24 +12,21 @@
  */
 class PhpStanType
 {
-    const NO_SIGNATURE_TYPES = [
+    public const NO_SIGNATURE_TYPES = [
         'resource',
         'mixed',
         '\OCI-Lob',
         '\OCI-Collection',
     ];
-    /**
-     * @var bool
-     */
-    private $nullable;
-    /**
-     * @var bool
-     */
-    private $falsable;
+
+    private bool $nullable;
+
+    private bool $falsable;
+
     /**
      * @var string[]
      */
-    private $types;
+    private array $types;
 
     public function __construct(string $data, bool $writeOnly = false)
     {
@@ -49,12 +47,12 @@ public function __construct(string $data, bool $writeOnly = false)
 
         $returnTypes = $this->explodeTypes($data);
         //remove 'null' from the list to identify if the signature type should be nullable
-        if (($nullablePosition = \array_search('null', $returnTypes)) !== false) {
+        if (($nullablePosition = \array_search('null', $returnTypes, true)) !== false) {
             $nullable = true;
             \array_splice($returnTypes, (int) $nullablePosition, 1);
         }
         //remove 'false' from the list to identify if the function return false on error
-        if (($falsablePosition = \array_search('false', $returnTypes)) !== false) {
+        if (($falsablePosition = \array_search('false', $returnTypes, true)) !== false) {
             $falsable = true;
             \array_splice($returnTypes, (int) $falsablePosition, 1);
         }

diff --git a/generator/src/ScanObjectsCommand.php b/generator/src/ScanObjectsCommand.php
@@ -1,5 +1,6 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe;
 
@@ -17,7 +18,7 @@ protected function configure(): void
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $scanner = new Scanner(__DIR__ . '/../doc/doc-en/en/reference/');
 

diff --git a/generator/src/Scanner.php b/generator/src/Scanner.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Safe;
 
 use function array_merge;
@@ -13,7 +15,7 @@ class Scanner
     /**
      * @var string[]
      */
-    private $ignoredFunctions;
+    private ?array $ignoredFunctions = null;
 
     /**
      * @var string[]

diff --git a/generator/src/ScannerResponse.php b/generator/src/ScannerResponse.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Safe;
 
 class ScannerResponse

diff --git a/generator/src/Type.php b/generator/src/Type.php
@@ -1,15 +1,13 @@
 <?php
 
+declare(strict_types=1);
 
 namespace Safe;
 
 class Type
 {
     /**
      * Returns true if the type passed in parameter is a class, false if it is scalar or resource
-     *
-     * @param string $type
-     * @return bool
      */
     private static function isClass(string $type): bool
     {

diff --git a/generator/src/WritePhpFunction.php b/generator/src/WritePhpFunction.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Safe;
 
 class WritePhpFunction
@@ -128,7 +130,6 @@ private function generateExceptionCode(string $moduleName, Method $method) : str
 
     /**
      * @param Parameter[] $params
-     * @return string
      */
     private function displayParamsWithType(array $params): string
     {