Merge pull request #162 from odolbeau/increase-phptan-level

Increase PHPStan level
odolbeau · Dec 6, 2023 · e922fd5 · e922fd5
2 parents 802fd7b + f5770c3
commit e922fd5
Show file tree

Hide file tree

Showing 30 changed files with 504 additions and 494 deletions.
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -14,6 +14,7 @@
         '@Symfony' => true,
         '@Symfony:risky' => true,
         'array_syntax' => ['syntax' => 'short'],
+        'declare_strict_types' => true,
     ])
     ->setFinder($finder)
 ;
diff --git a/Makefile b/Makefile
@@ -14,11 +14,11 @@ help:
 
 cs-lint: ## Verify check styles
 	composer install --working-dir=tools/php-cs-fixer
-	tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff --config=.php_cs.dist.php
+	tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff
 
 cs-fix: ## Apply Check styles
 	composer install --working-dir=tools/php-cs-fixer
-	tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff --config=.php_cs.dist.php
+	tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff
 
 phpstan: ## Run PHPStan
 	composer install --working-dir=tools/phpstan

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#2 \\$regionCallingFrom of method libphonenumber\\\\PhoneNumberUtil\\:\\:formatOutOfCountryCallingNumber\\(\\) expects string, string\\|null given\\.$#"
+			count: 1
+			path: src/Templating/Helper/PhoneNumberHelper.php
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,6 +1,12 @@
+includes:
+    - phpstan-baseline.neon
+    - tools/phpstan/vendor/jangregor/phpstan-prophecy/extension.neon
+
 parameters:
-    level: 1
+    level: 8
     paths:
       - src
       - tests
-    inferPrivatePropertyTypeFromConstructor: true
+
+    ignoreErrors:
+    - '#Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::children\(\).#'
diff --git a/src/DependencyInjection/Compiler/FormTwigTemplateCompilerPass.php b/src/DependencyInjection/Compiler/FormTwigTemplateCompilerPass.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *
@@ -19,17 +21,20 @@
  */
 class FormTwigTemplateCompilerPass implements CompilerPassInterface
 {
-    private $phoneNumberLayout = '@MisdPhoneNumber/Form/phone_number.html.twig';
-    private $phoneNumberBootstrapLayout = '@MisdPhoneNumber/Form/phone_number_bootstrap.html.twig';
-    private $phoneNumberBootstrap4Layout = '@MisdPhoneNumber/Form/phone_number_bootstrap_4.html.twig';
-    private $phoneNumberBootstrap5Layout = '@MisdPhoneNumber/Form/phone_number_bootstrap_5.html.twig';
+    private string $phoneNumberLayout = '@MisdPhoneNumber/Form/phone_number.html.twig';
+    private string $phoneNumberBootstrapLayout = '@MisdPhoneNumber/Form/phone_number_bootstrap.html.twig';
+    private string $phoneNumberBootstrap4Layout = '@MisdPhoneNumber/Form/phone_number_bootstrap_4.html.twig';
+    private string $phoneNumberBootstrap5Layout = '@MisdPhoneNumber/Form/phone_number_bootstrap_5.html.twig';
 
     public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasParameter('twig.form.resources')) {
             return;
         }
 
+        /**
+         * @var string[] $parameter
+         */
         $parameter = $container->getParameter('twig.form.resources');
 
         if (\in_array($this->phoneNumberLayout, $parameter)) {

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *

diff --git a/src/DependencyInjection/MisdPhoneNumberExtension.php b/src/DependencyInjection/MisdPhoneNumberExtension.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *

diff --git a/src/Doctrine/DBAL/Types/PhoneNumberType.php b/src/Doctrine/DBAL/Types/PhoneNumberType.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *

diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *

diff --git a/src/Form/DataTransformer/PhoneNumberToArrayTransformer.php b/src/Form/DataTransformer/PhoneNumberToArrayTransformer.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *
@@ -19,30 +21,33 @@
 use Symfony\Component\Form\Exception\TransformationFailedException;
 
 /**
- * Phone number to array transformer.
+ * @implements DataTransformerInterface<PhoneNumber, array{country: string, number: string}>
  */
 class PhoneNumberToArrayTransformer implements DataTransformerInterface
 {
     /**
-     * @var array
+     * @var string[]
      */
-    private $countryChoices;
+    private array $countryChoices;
 
     /**
-     * Constructor.
+     * @param string[] $countryChoices
      */
     public function __construct(array $countryChoices)
     {
         $this->countryChoices = $countryChoices;
     }
 
-    public function transform($value): array
+    /**
+     * @return array{country: string, number: string}
+     */
+    public function transform(mixed $value): array
     {
         if (null === $value) {
             return ['country' => '', 'number' => ''];
         }
 
-        if (false === $value instanceof PhoneNumber) {
+        if (!$value instanceof PhoneNumber) {
             throw new TransformationFailedException('Expected a \libphonenumber\PhoneNumber.');
         }
 
@@ -53,12 +58,12 @@ public function transform($value): array
         }
 
         return [
-            'country' => $util->getRegionCodeForNumber($value),
+            'country' => (string) $util->getRegionCodeForNumber($value),
             'number' => $util->format($value, PhoneNumberFormat::NATIONAL),
         ];
     }
 
-    public function reverseTransform($value): ?PhoneNumber
+    public function reverseTransform(mixed $value): ?PhoneNumber
     {
         if (!$value) {
             return null;
@@ -68,6 +73,7 @@ public function reverseTransform($value): ?PhoneNumber
             throw new TransformationFailedException('Expected an array.');
         }
 
+        /* @phpstan-ignore-next-line */
         if ('' === trim($value['number'] ?? '')) {
             return null;
         }

diff --git a/src/Form/DataTransformer/PhoneNumberToStringTransformer.php b/src/Form/DataTransformer/PhoneNumberToStringTransformer.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *
@@ -19,33 +21,16 @@
 use Symfony\Component\Form\Exception\TransformationFailedException;
 
 /**
- * Phone number to string transformer.
+ * @implements DataTransformerInterface<PhoneNumber, string>
  */
 class PhoneNumberToStringTransformer implements DataTransformerInterface
 {
-    /**
-     * Default region code.
-     *
-     * @var string
-     */
-    private $defaultRegion;
-
-    /**
-     * Display format.
-     *
-     * @var int
-     */
-    private $format;
+    private string $defaultRegion;
+    private int $format;
 
-    /**
-     * Constructor.
-     *
-     * @param string $defaultRegion default region code
-     * @param int    $format        display format
-     */
     public function __construct(
-        $defaultRegion = PhoneNumberUtil::UNKNOWN_REGION,
-        $format = PhoneNumberFormat::INTERNATIONAL
+        string $defaultRegion = PhoneNumberUtil::UNKNOWN_REGION,
+        int $format = PhoneNumberFormat::INTERNATIONAL
     ) {
         $this->defaultRegion = $defaultRegion;
         $this->format = $format;
@@ -57,7 +42,7 @@ public function transform($value): string
             return '';
         }
 
-        if (false === $value instanceof PhoneNumber) {
+        if (!$value instanceof PhoneNumber) {
             throw new TransformationFailedException('Expected a \libphonenumber\PhoneNumber.');
         }
 

diff --git a/src/Form/Type/PhoneNumberType.php b/src/Form/Type/PhoneNumberType.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *
@@ -67,10 +69,20 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                     continue;
                 }
 
-                $label = $this->formatDisplayChoice($options['country_display_type'], $intlCountries[$regionCode], $regionCode, $countryCode, $options['country_display_emoji_flag']);
+                $label = $this->formatDisplayChoice(
+                    $options['country_display_type'],
+                    $intlCountries[$regionCode],
+                    (string) $regionCode,
+                    (string) $countryCode,
+                    $options['country_display_emoji_flag']
+                );
+
                 $countryChoices[$label] = $regionCode;
             }
 
+            /**
+             * @var string[] $transformerChoices
+             */
             $transformerChoices = array_values($countryChoices);
 
             $countryOptions = array_replace([

diff --git a/src/MisdPhoneNumberBundle.php b/src/MisdPhoneNumberBundle.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *

diff --git a/src/Serializer/Normalizer/PhoneNumberNormalizer.php b/src/Serializer/Normalizer/PhoneNumberNormalizer.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the Symfony2 PhoneNumberBundle.
  *
@@ -25,58 +27,46 @@
  */
 class PhoneNumberNormalizer implements NormalizerInterface, DenormalizerInterface
 {
-    /**
-     * Region code.
-     *
-     * @var string
-     */
-    private $region;
-
-    /**
-     * Display format.
-     *
-     * @var int
-     */
-    private $format;
+    private PhoneNumberUtil $phoneNumberUtil;
+    private string $region;
+    private int $format;
 
     /**
-     * Display format.
-     *
-     * @var PhoneNumberUtil
-     */
-    private $phoneNumberUtil;
-
-    /**
-     * Constructor.
-     *
      * @param PhoneNumberUtil $phoneNumberUtil phone number utility
      * @param string          $region          region code
      * @param int             $format          display format
      */
-    public function __construct(PhoneNumberUtil $phoneNumberUtil, $region = PhoneNumberUtil::UNKNOWN_REGION, $format = PhoneNumberFormat::E164)
+    public function __construct(PhoneNumberUtil $phoneNumberUtil, string $region = PhoneNumberUtil::UNKNOWN_REGION, int $format = PhoneNumberFormat::E164)
     {
         $this->phoneNumberUtil = $phoneNumberUtil;
         $this->region = $region;
         $this->format = $format;
     }
 
     /**
+     * @param array<mixed> $context
+     *
      * @throws InvalidArgumentException
      */
-    public function normalize($object, $format = null, array $context = []): string
+    public function normalize(mixed $object, string $format = null, array $context = []): string
     {
         return $this->phoneNumberUtil->format($object, $this->format);
     }
 
-    public function supportsNormalization($data, $format = null, array $context = []): bool
+    /**
+     * @param array<mixed> $context
+     */
+    public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
         return $data instanceof PhoneNumber;
     }
 
     /**
+     * @param array<mixed> $context
+     *
      * @throws UnexpectedValueException
      */
-    public function denormalize($data, $type, $format = null, array $context = []): ?PhoneNumber
+    public function denormalize(mixed $data, string $type, string $format = null, array $context = []): ?PhoneNumber
     {
         if (null === $data) {
             return null;
@@ -89,7 +79,10 @@ public function denormalize($data, $type, $format = null, array $context = []):
         }
     }
 
-    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
+    /**
+     * @param array<mixed> $context
+     */
+    public function supportsDenormalization(mixed $data, string $type, string $format = null, array $context = []): bool
     {
         return PhoneNumber::class === $type && \is_string($data);
     }