🎨 CS Changes

giggsey · Apr 29, 2024 · 7e31d93 · 7e31d93
1 parent 20ffd64
commit 7e31d93
Show file tree

Hide file tree

Showing 18 changed files with 26 additions and 161 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -12,5 +12,12 @@
         '@PSR12' => true,
         '@PHP81Migration' => true,
         'single_quote' => true,
+        'no_unused_imports' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_hidden_params' => true,
+            'allow_mixed' => true,
+            'remove_inheritdoc' => true,
+        ],
+        'phpdoc_trim' => true,
     ]
 )->setFinder($finder);
diff --git a/build/BuildMetadataFromXml.php b/build/BuildMetadataFromXml.php
@@ -79,12 +79,8 @@ public static function validateRE(string $regex, bool $removeWhitespace = false)
     }
 
     /**
-     *
-     * @param DOMElement|string $inputXmlFile
      * @param boolean $liteBuild
      * @param boolean $specialBuild
-     * @param bool $isShortNumberMetadata
-     * @param bool $isAlternateFormatsMetadata
      * @return PhoneMetadata[]
      */
     public static function buildPhoneMetadataCollection(
@@ -127,11 +123,6 @@ public static function buildPhoneMetadataCollection(
     }
 
     /**
-     * @param string $regionCode
-     * @param DOMElement $element
-     * @param bool $isShortNumberMetadata
-     * @param bool $isAlternateFormatsMetadata
-     * @return PhoneMetadata
      */
     public static function loadCountryMetadata(string $regionCode, DOMElement $element, bool $isShortNumberMetadata, bool $isAlternateFormatsMetadata): PhoneMetadata
     {
@@ -150,11 +141,8 @@ public static function loadCountryMetadata(string $regionCode, DOMElement $eleme
     /**
      * Processes the custom build flags and gets a MetadataFilter which may be used to
      * filter PhoneMetadata objects. Incompatible flag combinations throw RuntimeException.
-     * @param bool $liteBuild
-     * @param bool $specialBuild
-     * @return MetadataFilter
      */
-    public static function getMetadataFilter($liteBuild, $specialBuild): MetadataFilter
+    public static function getMetadataFilter(bool $liteBuild, bool $specialBuild): MetadataFilter
     {
         if ($specialBuild) {
             if ($liteBuild) {
@@ -172,42 +160,27 @@ public static function getMetadataFilter($liteBuild, $specialBuild): MetadataFil
     /**
      * Returns the national prefix of the provided country element.
      * @internal
-     * @return string
      */
     public static function getNationalPrefix(DOMElement $element): string
     {
         return $element->hasAttribute(self::NATIONAL_PREFIX) ? $element->getAttribute(self::NATIONAL_PREFIX) : '';
     }
 
-    /**
-     *
-     * @internal
-     * @param string $nationalPrefix
-     * @return string
-     */
-    public static function getNationalPrefixFormattingRuleFromElement(DOMElement $element, $nationalPrefix): string
+    public static function getNationalPrefixFormattingRuleFromElement(DOMElement $element, string $nationalPrefix): string
     {
         $nationalPrefixFormattingRule = $element->getAttribute(self::NATIONAL_PREFIX_FORMATTING_RULE);
         // Replace $NP with national prefix and $FG with the first group ($1).
-        $nationalPrefixFormattingRule = \str_replace(
+        return \str_replace(
             ['$NP', '$FG'],
             [$nationalPrefix, '$1'],
             $nationalPrefixFormattingRule
         );
-        return $nationalPrefixFormattingRule;
     }
 
-    /**
-     *
-     * @internal
-     * @param string $regionCode
-     * @param string $nationalPrefix
-     * @return PhoneMetadata
-     */
     public static function loadTerritoryTagMetadata(
-        $regionCode,
+        string $regionCode,
         DOMElement $element,
-        $nationalPrefix
+        string $nationalPrefix
     ): PhoneMetadata {
         $metadata = new PhoneMetadata();
         $metadata->setId($regionCode);
@@ -228,7 +201,7 @@ public static function loadTerritoryTagMetadata(
                 $metadata->setNationalPrefixTransformRule(self::validateRE($element->getAttribute(self::NATIONAL_PREFIX_TRANSFORM_RULE)));
             }
         }
-        if ($nationalPrefix != '') {
+        if ($nationalPrefix !== '') {
             $metadata->setNationalPrefix($nationalPrefix);
             if (!$metadata->hasNationalPrefixForParsing()) {
                 $metadata->setNationalPrefixForParsing($nationalPrefix);
@@ -252,16 +225,13 @@ public static function loadTerritoryTagMetadata(
      * nationalPrefixOptionalWhenFormatting. The nationalPrefix, nationalPrefixFormattingRule and
      * nationalPrefixOptionalWhenFormatting values are provided from the parent (territory) element.
      * @internal
-     * @param string $nationalPrefix
-     * @param string $nationalPrefixFormattingRule
-     * @param bool $nationalPrefixOptionalWhenFormatting
      */
     public static function loadAvailableFormats(
         PhoneMetadata $metadata,
         DOMElement $element,
-        $nationalPrefix,
-        $nationalPrefixFormattingRule,
-        $nationalPrefixOptionalWhenFormatting
+        string $nationalPrefix,
+        string $nationalPrefixFormattingRule,
+        bool $nationalPrefixOptionalWhenFormatting
     ): void {
         $carrierCodeFormattingRule = '';
         if ($element->hasAttribute(self::CARRIER_CODE_FORMATTING_RULE)) {
@@ -285,7 +255,7 @@ public static function loadAvailableFormats(
                     $format->setNationalPrefixFormattingRule($nationalPrefixFormattingRule);
                 }
                 if ($numberFormatElement->hasAttribute(self::NATIONAL_PREFIX_OPTIONAL_WHEN_FORMATTING)) {
-                    $format->setNationalPrefixOptionalWhenFormatting($numberFormatElement->getAttribute(self::NATIONAL_PREFIX_OPTIONAL_WHEN_FORMATTING) === 'true' ? true : false);
+                    $format->setNationalPrefixOptionalWhenFormatting($numberFormatElement->getAttribute(self::NATIONAL_PREFIX_OPTIONAL_WHEN_FORMATTING) === 'true');
                 } else {
                     $format->setNationalPrefixOptionalWhenFormatting($nationalPrefixOptionalWhenFormatting);
                 }
@@ -314,20 +284,16 @@ public static function loadAvailableFormats(
     }
 
     /**
-     * @internal
-     * @param string $nationalPrefix
-     * @return string
      */
-    public static function getDomesticCarrierCodeFormattingRuleFromElement(DOMElement $element, $nationalPrefix): string
+    public static function getDomesticCarrierCodeFormattingRuleFromElement(DOMElement $element, string $nationalPrefix): string
     {
         $carrierCodeFormattingRule = $element->getAttribute(self::CARRIER_CODE_FORMATTING_RULE);
         // Replace $FG with the first group ($1) and $NP with the national prefix.
-        $carrierCodeFormattingRule = \str_replace(
+        return \str_replace(
             ['$NP', '$FG'],
             [$nationalPrefix, '$1'],
             $carrierCodeFormattingRule
         );
-        return $carrierCodeFormattingRule;
     }
 
     /**
@@ -345,8 +311,8 @@ public static function loadNationalFormat(
         $format->setPattern(self::validateRE($numberFormatElement->getAttribute(self::PATTERN)));
 
         $formatPattern = $numberFormatElement->getElementsByTagName(self::FORMAT);
-        if ($formatPattern->length != 1) {
-            $countryId = $metadata->getId() != '' ? $metadata->getId() : $metadata->getCountryCode();
+        if ($formatPattern->length !== 1) {
+            $countryId = $metadata->getId() !== '' ? $metadata->getId() : $metadata->getCountryCode();
             throw new \RuntimeException('Invalid number of format patterns for country: ' . $countryId);
         }
         $nationalFormat = $formatPattern->item(0)->firstChild->nodeValue;
@@ -410,7 +376,6 @@ public static function loadInternationalFormat(
 
     /**
      * @internal
-     * @param bool $isShortNumberMetadata
      */
     public static function setRelevantDescPatterns(PhoneMetadata $metadata, DOMElement $element, bool $isShortNumberMetadata): void
     {
@@ -744,8 +709,6 @@ public static function processPhoneNumberDescElement(
 
     /**
      * @param int[] $possibleLengths
-     * @param PhoneNumberDesc $desc
-     * @return bool
      */
     private static function arePossibleLengthsEqual(array $possibleLengths, PhoneNumberDesc $desc): bool
     {

diff --git a/build/BuildMetadataPHPFromXml.php b/build/BuildMetadataPHPFromXml.php
@@ -48,7 +48,6 @@ public function start(string $inputFile, string $outputDir, string $filePrefix,
 
     /**
      * @param PhoneMetadata[] $metadataCollection
-     * @param string $filePrefix
      */
     private function writeMetadataToFile(array $metadataCollection, string $filePrefix): void
     {
@@ -70,9 +69,6 @@ private function writeMetadataToFile(array $metadataCollection, string $filePref
 
     /**
      * @param array<int,array<string>> $countryCodeToRegionCodeMap
-     * @param string $outputDir
-     * @param string $mappingClass
-     * @return void
      */
     private function writeCountryCallingCodeMappingToFile(array $countryCodeToRegionCodeMap, string $outputDir, string $mappingClass): void
     {

diff --git a/build/Commands/BuildMetadataPHPFromXMLCommand.php b/build/Commands/BuildMetadataPHPFromXMLCommand.php
@@ -3,7 +3,6 @@
 namespace libphonenumber\buildtools\Commands;
 
 use libphonenumber\buildtools\BuildMetadataPHPFromXml;
-use PHPStan\Parallel\Process;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -36,7 +35,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $input->getArgument('DataPrefix'),
             $input->getArgument('MappingClass'),
             $input->getArgument('MappingClassLocation'),
-            ($input->getArgument('LiteBuild') === 'true') ? true : false
+            $input->getArgument('LiteBuild') === 'true'
         );
 
         return self::SUCCESS;

diff --git a/build/MetadataFilter.php b/build/MetadataFilter.php
@@ -73,7 +73,6 @@ public static function forLiteBuild(): static
      * duplicates, malformed strings, or strings where field tokens do not correspond to strings in
      * the sets of excludable fields. We also throw RuntimeException for empty strings since such
      * strings should be treated as a special case by the flag checking code and not passed here.
-     * @param string $string
      * @return array<string,string[]>
      */
     public static function parseFieldMapFromString(string $string): array
@@ -319,7 +318,6 @@ public function filterMetadata(PhoneMetadata $metadata): void
 
     /**
      * @param string $type
-     * @return PhoneNumberDesc
      */
     private function getFiltered($type, PhoneNumberDesc $desc): PhoneNumberDesc
     {
@@ -346,9 +344,6 @@ private function getFiltered($type, PhoneNumberDesc $desc): PhoneNumberDesc
     }
 
     /**
-     * @param $parent
-     * @param $child
-     * @return bool
      */
     public function shouldDrop(string $parent, ?string $child = null): bool
     {

diff --git a/src/Matcher.php b/src/Matcher.php
@@ -26,8 +26,6 @@ class Matcher
     private int $searchIndex = 0;
 
     /**
-     * @param string $pattern
-     * @param string $subject
      */
     public function __construct(string $pattern, string $subject)
     {
@@ -36,9 +34,6 @@ public function __construct(string $pattern, string $subject)
     }
 
     /**
-     * @param string $type
-     * @param int $offset
-     * @return bool
      */
     protected function doMatch(string $type = 'find', int $offset = 0): bool
     {

diff --git a/src/MultiFileMetadataSourceImpl.php b/src/MultiFileMetadataSourceImpl.php
@@ -40,7 +40,7 @@ public function __construct(protected MetadataLoaderInterface $metadataLoader, ?
     }
 
     /**
-     * @inheritdoc
+     *
      */
     public function getMetadataForRegion(string $regionCode): PhoneMetadata
     {
@@ -56,7 +56,7 @@ public function getMetadataForRegion(string $regionCode): PhoneMetadata
     }
 
     /**
-     * @inheritdoc
+     *
      */
     public function getMetadataForNonGeographicalRegion(int $countryCallingCode): PhoneMetadata
     {
@@ -68,10 +68,6 @@ public function getMetadataForNonGeographicalRegion(int $countryCallingCode): Ph
     }
 
     /**
-     * @param string $filePrefix
-     * @param string $regionCode
-     * @param int $countryCallingCode
-     * @param MetadataLoaderInterface $metadataLoader
      */
     public function loadMetadataFromFile(string $filePrefix, string $regionCode, int $countryCallingCode, MetadataLoaderInterface $metadataLoader): void
     {

diff --git a/src/NumberFormat.php b/src/NumberFormat.php
@@ -32,7 +32,6 @@ public function __construct()
     }
 
     /**
-     * @return NumberFormat
      */
     public function clear(): NumberFormat
     {

diff --git a/src/PhoneMetadata.php b/src/PhoneMetadata.php
@@ -90,8 +90,6 @@ public function numberFormatSize(): int
     }
 
     /**
-     * @param int $index
-     * @return NumberFormat
      */
     public function getNumberFormat(int $index): NumberFormat
     {

diff --git a/src/PhoneNumber.php b/src/PhoneNumber.php
@@ -9,7 +9,6 @@ class PhoneNumber implements \Serializable, \Stringable
     /**
      * The country calling code for this number, as defined by the International Telecommunication Union
      * (ITU). For example, this would be 1 for NANPA countries, and 33 for France.
-
      */
     protected ?int $countryCode = null;
     /**
@@ -322,8 +321,6 @@ public function setExtension(string $value): PhoneNumber
 
     /**
      * Returns whether this phone number has the italian leading zero information set.
-     *
-     * @return bool
      */
     public function hasItalianLeadingZero(): bool
     {
@@ -506,7 +503,6 @@ public function equals(PhoneNumber $other): bool
 
     /**
      * Returns a string representation of this phone number.
-     * @return string
      */
     public function __toString(): string
     {
@@ -531,7 +527,7 @@ public function __toString(): string
     }
 
     /**
-     * @inheritDoc
+     *
      */
     public function serialize(): ?string
     {
@@ -556,7 +552,7 @@ public function __serialize(): array
     }
 
     /**
-     * @inheritDoc
+     *
      */
     public function unserialize($data)
     {

diff --git a/src/PhoneNumberMatch.php b/src/PhoneNumberMatch.php
@@ -35,7 +35,6 @@ public function __construct(int $start, string $rawString, private PhoneNumber $
 
     /**
      * Returns the phone number matched by the receiver.
-     * @return PhoneNumber
      */
     public function number(): PhoneNumber
     {
@@ -44,7 +43,6 @@ public function number(): PhoneNumber
 
     /**
      * Returns the start index of the matched phone number within the searched text.
-     * @return int
      */
     public function start(): int
     {
@@ -53,7 +51,6 @@ public function start(): int
 
     /**
      * Returns the exclusive end index of the matched phone number within the searched text.
-     * @return int
      */
     public function end(): int
     {
@@ -62,7 +59,6 @@ public function end(): int
 
     /**
      * Returns the raw string matched as a phone number in the searched text.
-     * @return string
      */
     public function rawString(): string
     {