Merge pull request #120 from Nek-/feat/add-return-types

odolbeau · Jul 4, 2022 · 6e68ad2 · 6e68ad2
2 parents dce640b + fd66fee
commit 6e68ad2
Show file tree

Hide file tree

Showing 16 changed files with 131 additions and 85 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Maintenance: added return types on methods, avoid deprecation trigger, make the bundle future-proof
+
 ### Fixed
 
 - Name of the catalan translation file is now accurate #116

diff --git a/src/DependencyInjection/Compiler/FormTwigTemplateCompilerPass.php b/src/DependencyInjection/Compiler/FormTwigTemplateCompilerPass.php
@@ -26,10 +26,8 @@ class FormTwigTemplateCompilerPass implements CompilerPassInterface
 
     /**
      * {@inheritdoc}
-     *
-     * @return void
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasParameter('twig.form.resources')) {
             return;
@@ -58,7 +56,7 @@ public function process(ContainerBuilder $container)
             array_splice($parameter, ++$key, 0, [$this->phoneNumberLayout]);
         } else {
             // Put it in first position.
-            array_unshift($parameter, [$this->phoneNumberLayout]);
+            array_unshift($parameter, $this->phoneNumberLayout);
         }
 
         $container->setParameter('twig.form.resources', $parameter);

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -22,10 +22,7 @@
 
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * @return TreeBuilder
-     */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('misd_phone_number');
         $rootNode = $treeBuilder->getRootNode();

diff --git a/src/DependencyInjection/MisdPhoneNumberExtension.php b/src/DependencyInjection/MisdPhoneNumberExtension.php
@@ -23,10 +23,8 @@ class MisdPhoneNumberExtension extends Extension
 {
     /**
      * {@inheritdoc}
-     *
-     * @return void
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);

diff --git a/src/Doctrine/DBAL/Types/PhoneNumberType.php b/src/Doctrine/DBAL/Types/PhoneNumberType.php
@@ -31,30 +31,24 @@ class PhoneNumberType extends Type
 
     /**
      * {@inheritdoc}
-     *
-     * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return self::NAME;
     }
 
     /**
      * {@inheritdoc}
-     *
-     * @return mixed
      */
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
     {
         return $platform->getVarcharTypeDeclarationSQL(['length' => 35]);
     }
 
     /**
      * {@inheritdoc}
-     *
-     * @return mixed
      */
-    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {
         if (null === $value) {
             return null;
@@ -71,10 +65,8 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
 
     /**
      * {@inheritdoc}
-     *
-     * @return mixed
      */
-    public function convertToPHPValue($value, AbstractPlatform $platform)
+    public function convertToPHPValue($value, AbstractPlatform $platform): ?PhoneNumber
     {
         if (null === $value || $value instanceof PhoneNumber) {
             return $value;
@@ -91,10 +83,8 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
-    public function requiresSQLCommentHint(AbstractPlatform $platform)
+    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
     {
         return true;
     }

diff --git a/src/Form/DataTransformer/PhoneNumberToArrayTransformer.php b/src/Form/DataTransformer/PhoneNumberToArrayTransformer.php
@@ -38,10 +38,8 @@ public function __construct(array $countryChoices)
 
     /**
      * {@inheritdoc}
-     *
-     * @return array
      */
-    public function transform($phoneNumber)
+    public function transform($phoneNumber): array
     {
         if (null === $phoneNumber) {
             return ['country' => '', 'number' => ''];
@@ -63,10 +61,8 @@ public function transform($phoneNumber)
 
     /**
      * {@inheritdoc}
-     *
-     * @return ?PhoneNumber
      */
-    public function reverseTransform($value)
+    public function reverseTransform($value): ?PhoneNumber
     {
         if (!$value) {
             return null;

diff --git a/src/Form/DataTransformer/PhoneNumberToStringTransformer.php b/src/Form/DataTransformer/PhoneNumberToStringTransformer.php
@@ -53,10 +53,8 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     *
-     * @return string
      */
-    public function transform($phoneNumber)
+    public function transform($phoneNumber): string
     {
         if (null === $phoneNumber) {
             return '';
@@ -75,10 +73,8 @@ public function transform($phoneNumber)
 
     /**
      * {@inheritdoc}
-     *
-     * @return ?PhoneNumber
      */
-    public function reverseTransform($string)
+    public function reverseTransform($string): ?PhoneNumber
     {
         if (!$string && '0' !== $string) {
             return null;

diff --git a/src/Form/Type/PhoneNumberType.php b/src/Form/Type/PhoneNumberType.php
@@ -36,7 +36,7 @@ class PhoneNumberType extends AbstractType
     /**
      * {@inheritdoc}
      */
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         if (self::WIDGET_COUNTRY_CHOICE === $options['widget']) {
             $util = PhoneNumberUtil::getInstance();
@@ -106,7 +106,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     /**
      * {@inheritdoc}
      */
-    public function buildView(FormView $view, FormInterface $form, array $options)
+    public function buildView(FormView $view, FormInterface $form, array $options): void
     {
         $view->vars['type'] = 'tel';
         $view->vars['widget'] = $options['widget'];
@@ -115,7 +115,7 @@ public function buildView(FormView $view, FormInterface $form, array $options)
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'widget' => self::WIDGET_SINGLE_TEXT,
@@ -145,20 +145,16 @@ public function configureOptions(OptionsResolver $resolver)
 
     /**
      * {@inheritdoc}
-     *
-     * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->getBlockPrefix();
     }
 
     /**
      * {@inheritdoc}
-     *
-     * @return string
      */
-    public function getBlockPrefix()
+    public function getBlockPrefix(): string
     {
         return 'phone_number';
     }

diff --git a/src/MisdPhoneNumberBundle.php b/src/MisdPhoneNumberBundle.php
@@ -23,7 +23,7 @@ class MisdPhoneNumberBundle extends Bundle
     /**
      * {@inheritdoc}
      */
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

diff --git a/src/Serializer/Normalizer/PhoneNumberNormalizer.php b/src/Serializer/Normalizer/PhoneNumberNormalizer.php
@@ -64,10 +64,8 @@ public function __construct(PhoneNumberUtil $phoneNumberUtil, $region = PhoneNum
      * {@inheritdoc}
      *
      * @throws InvalidArgumentException
-     *
-     * @return array|string|int|float|bool|\ArrayObject|null
      */
-    public function normalize($object, $format = null, array $context = [])
+    public function normalize($object, $format = null, array $context = []): string
     {
         return $this->phoneNumberUtil->format($object, $this->format);
     }
@@ -84,13 +82,11 @@ public function supportsNormalization($data, $format = null, array $context = []
      * {@inheritdoc}
      *
      * @throws UnexpectedValueException
-     *
-     * @return mixed
      */
-    public function denormalize($data, $class, $format = null, array $context = [])
+    public function denormalize($data, $class, $format = null, array $context = []): ?PhoneNumber
     {
         if (null === $data) {
-            return;
+            return null;
         }
 
         try {
@@ -102,10 +98,8 @@ public function denormalize($data, $class, $format = null, array $context = [])
 
     /**
      * {@inheritdoc}
-     *
-     * @return bool
      */
-    public function supportsDenormalization($data, $type, $format = null, array $context = [])
+    public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
     {
         return 'libphonenumber\PhoneNumber' === $type && \is_string($data);
     }

diff --git a/src/Templating/Helper/PhoneNumberHelper.php b/src/Templating/Helper/PhoneNumberHelper.php
@@ -49,7 +49,7 @@ public function __construct(PhoneNumberUtil $phoneNumberUtil)
      *
      * @throws InvalidArgumentException if an argument is invalid
      */
-    public function format(PhoneNumber $phoneNumber, $format = PhoneNumberFormat::INTERNATIONAL)
+    public function format(PhoneNumber $phoneNumber, $format = PhoneNumberFormat::INTERNATIONAL): string
     {
         if (true === \is_string($format)) {
             $constant = '\libphonenumber\PhoneNumberFormat::'.$format;
@@ -69,10 +69,8 @@ public function format(PhoneNumber $phoneNumber, $format = PhoneNumberFormat::IN
      *
      * @param PhoneNumber $phoneNumber phone number
      * @param string|null $regionCode  The ISO 3166-1 alpha-2 country code
-     *
-     * @return string
      */
-    public function formatOutOfCountryCallingNumber(PhoneNumber $phoneNumber, $regionCode)
+    public function formatOutOfCountryCallingNumber(PhoneNumber $phoneNumber, $regionCode): string
     {
         return $this->phoneNumberUtil->formatOutOfCountryCallingNumber($phoneNumber, $regionCode);
     }
@@ -81,11 +79,9 @@ public function formatOutOfCountryCallingNumber(PhoneNumber $phoneNumber, $regio
      * @param PhoneNumber $phoneNumber phone number
      * @param int|string  $type        phoneNumberType, or PhoneNumberType constant name
      *
-     * @return bool
-     *
      * @throws InvalidArgumentException if type argument is invalid
      */
-    public function isType(PhoneNumber $phoneNumber, $type = PhoneNumberType::UNKNOWN)
+    public function isType(PhoneNumber $phoneNumber, $type = PhoneNumberType::UNKNOWN): bool
     {
         if (true === \is_string($type)) {
             $constant = '\libphonenumber\PhoneNumberType::'.$type;
@@ -97,6 +93,6 @@ public function isType(PhoneNumber $phoneNumber, $type = PhoneNumberType::UNKNOW
             $type = \constant('\libphonenumber\PhoneNumberType::'.$type);
         }
 
-        return $this->phoneNumberUtil->getNumberType($phoneNumber) === $type ? true : false;
+        return $this->phoneNumberUtil->getNumberType($phoneNumber) === $type;
     }
 }
diff --git a/src/Twig/Extension/PhoneNumberHelperExtension.php b/src/Twig/Extension/PhoneNumberHelperExtension.php
@@ -41,10 +41,8 @@ public function __construct(PhoneNumberHelper $helper)
 
     /**
      * {@inheritdoc}
-     *
-     * @return array
      */
-    public function getFunctions()
+    public function getFunctions(): array
     {
         return [
             // Deprecated in favor of the phone_number_format filter
@@ -55,10 +53,8 @@ public function getFunctions()
 
     /**
      * {@inheritdoc}
-     *
-     * @return array
      */
-    public function getFilters()
+    public function getFilters(): array
     {
         return [
             new TwigFilter('phone_number_format', [$this->helper, 'format']),
@@ -68,10 +64,8 @@ public function getFilters()
 
     /**
      * {@inheritdoc}
-     *
-     * @return array
      */
-    public function getTests()
+    public function getTests(): array
     {
         return [
             new TwigTest('phone_number_of_type', [$this->helper, 'isType']),

diff --git a/src/Validator/Constraints/PhoneNumberValidator.php b/src/Validator/Constraints/PhoneNumberValidator.php
@@ -59,10 +59,8 @@ public function __construct(PhoneNumberUtil $phoneUtil = null, string $defaultRe
 
     /**
      * {@inheritdoc}
-     *
-     * @return void
      */
-    public function validate($value, Constraint $constraint)
+    public function validate($value, Constraint $constraint): void
     {
         if (null === $value || '' === $value) {
             return;
@@ -138,8 +136,6 @@ public function validate($value, Constraint $constraint)
 
             if (!\in_array($type, $validTypes, true)) {
                 $this->addViolation($value, $constraint);
-
-                return;
             }
         }
     }
@@ -185,10 +181,8 @@ private function getPropertyAccessor(): PropertyAccessorInterface
      *
      * @param mixed      $value      the value that should be validated
      * @param Constraint $constraint the constraint for the validation
-     *
-     * @return void
      */
-    private function addViolation($value, Constraint $constraint)
+    private function addViolation($value, Constraint $constraint): void
     {
         $this->context->buildViolation($constraint->getMessage())
             ->setParameter('{{ types }}', implode(', ', $constraint->getTypeNames()))