Apply ECS

Author: BenMorel

src/PhoneNumber.php

@@ -5,14 +5,17 @@
 namespace Brick\PhoneNumber;
 
 use JsonSerializable;
-use Override;
-use Stringable;
 use libphonenumber;
 use libphonenumber\geocoding\PhoneNumberOfflineGeocoder;
+use libphonenumber\NumberParseException;
 use libphonenumber\PhoneNumberToCarrierMapper;
 use libphonenumber\PhoneNumberToTimeZonesMapper;
-use libphonenumber\NumberParseException;
 use libphonenumber\PhoneNumberUtil;
+use Override;
+use Stringable;
+
+use function assert;
+use function substr;
 
 /**
  * A phone number.
@@ -38,15 +41,13 @@ private function __construct(libphonenumber\PhoneNumber $phoneNumber)
      * @param string      $phoneNumber The phone number to parse.
      * @param string|null $regionCode  The region code to assume, if the number is not in international format.
      *
-     * @return PhoneNumber
-     *
      * @throws PhoneNumberParseException
      */
-    public static function parse(string $phoneNumber, ?string $regionCode = null) : PhoneNumber
+    public static function parse(string $phoneNumber, ?string $regionCode = null): PhoneNumber
     {
         try {
             return new PhoneNumber(
-                PhoneNumberUtil::getInstance()->parse($phoneNumber, $regionCode)
+                PhoneNumberUtil::getInstance()->parse($phoneNumber, $regionCode),
             );
         } catch (NumberParseException $e) {
             throw new PhoneNumberParseException($e);
@@ -57,11 +58,9 @@ public static function parse(string $phoneNumber, ?string $regionCode = null) :
      * @param string          $regionCode      The region code.
      * @param PhoneNumberType $phoneNumberType The phone number type, defaults to a fixed line.
      *
-     * @return PhoneNumber
-     *
      * @throws PhoneNumberException If no example number is available for this region and type.
      */
-    public static function getExampleNumber(string $regionCode, PhoneNumberType $phoneNumberType = PhoneNumberType::FIXED_LINE) : PhoneNumber
+    public static function getExampleNumber(string $regionCode, PhoneNumberType $phoneNumberType = PhoneNumberType::FIXED_LINE): PhoneNumber
     {
         $phoneNumber = PhoneNumberUtil::getInstance()->getExampleNumberForType(
             $regionCode,
@@ -79,10 +78,8 @@ public static function getExampleNumber(string $regionCode, PhoneNumberType $pho
      * Returns the country code of this PhoneNumber.
      *
      * The country code is a series of 1 to 3 digits, as defined per the E.164 recommendation.
-     *
-     * @return string
      */
-    public function getCountryCode() : string
+    public function getCountryCode(): string
     {
         $countryCode = $this->phoneNumber->getCountryCode();
         assert($countryCode !== null);
@@ -101,10 +98,8 @@ public function getCountryCode() : string
      *  - some geographical numbers have no area codes.
      *
      * If this number has no area code, an empty string is returned.
-     *
-     * @return string
      */
-    public function getGeographicalAreaCode() : string
+    public function getGeographicalAreaCode(): string
     {
         $phoneNumberUtil = PhoneNumberUtil::getInstance();
 
@@ -119,10 +114,8 @@ public function getGeographicalAreaCode() : string
      * Returns the national number of this PhoneNumber.
      *
      * The national number is a series of digits.
-     *
-     * @return string
      */
-    public function getNationalNumber() : string
+    public function getNationalNumber(): string
     {
         $nationalNumber = $this->phoneNumber->getNationalNumber();
         assert($nationalNumber !== null);
@@ -140,7 +133,7 @@ public function getNationalNumber() : string
      *
      * @return string|null The region code, or null if the number does not map to a geographic region.
      */
-    public function getRegionCode() : ?string
+    public function getRegionCode(): ?string
     {
         $regionCode = PhoneNumberUtil::getInstance()->getRegionCodeForNumber($this->phoneNumber);
 
@@ -155,10 +148,8 @@ public function getRegionCode() : ?string
      * Returns whether this phone number is a possible number.
      *
      * Note this provides a more lenient and faster check than `isValidNumber()`.
-     *
-     * @return bool
      */
-    public function isPossibleNumber() : bool
+    public function isPossibleNumber(): bool
     {
         return PhoneNumberUtil::getInstance()->isPossibleNumber($this->phoneNumber);
     }
@@ -168,18 +159,16 @@ public function isPossibleNumber() : bool
      *
      * Note this doesn't verify the number is actually in use,
      * which is impossible to tell by just looking at a number itself.
-     *
-     * @return bool
      */
-    public function isValidNumber() : bool
+    public function isValidNumber(): bool
     {
         return PhoneNumberUtil::getInstance()->isValidNumber($this->phoneNumber);
     }
 
     /**
      * Returns the type of this phone number.
      */
-    public function getNumberType() : PhoneNumberType
+    public function getNumberType(): PhoneNumberType
     {
         return PhoneNumberType::from(
             PhoneNumberUtil::getInstance()->getNumberType($this->phoneNumber)->value,
@@ -189,7 +178,7 @@ public function getNumberType() : PhoneNumberType
     /**
      * Returns a formatted string representation of this phone number.
      */
-    public function format(PhoneNumberFormat $format) : string
+    public function format(PhoneNumberFormat $format): string
     {
         return PhoneNumberUtil::getInstance()->format(
             $this->phoneNumber,
@@ -200,11 +189,9 @@ public function format(PhoneNumberFormat $format) : string
     /**
      * Formats this phone number for out-of-country dialing purposes.
      *
-     * @param string $regionCode The ISO 3166-1 alpha-2 country code
-     *
-     * @return string
+     * @param string $regionCode The ISO 3166-1 alpha-2 country code.
      */
-    public function formatForCallingFrom(string $regionCode) : string
+    public function formatForCallingFrom(string $regionCode): string
     {
         return PhoneNumberUtil::getInstance()->formatOutOfCountryCallingNumber($this->phoneNumber, $regionCode);
     }
@@ -259,15 +246,13 @@ public function jsonSerialize(): string
      * @param string|null $userRegion The region code for a given user. This region will be omitted from the description
      *                                if the phone number comes from this region. It is a two-letter uppercase CLDR
      *                                region code.
-     *
-     * @return string|null
      */
-    public function getDescription(string $locale, ?string $userRegion = null) : ?string
+    public function getDescription(string $locale, ?string $userRegion = null): ?string
     {
         $description = PhoneNumberOfflineGeocoder::getInstance()->getDescriptionForNumber(
             $this->phoneNumber,
             $locale,
-            $userRegion
+            $userRegion,
         );
 
         if ($description === '') {
@@ -327,11 +312,9 @@ public function getTimeZones(): array
 
     /**
      * Returns a string representation of this phone number in international E164 format.
-     *
-     * @return string
      */
     #[Override]
-    public function __toString() : string
+    public function __toString(): string
     {
         return $this->format(PhoneNumberFormat::E164);
     }

src/PhoneNumberException.php

@@ -4,9 +4,11 @@
 
 namespace Brick\PhoneNumber;
 
+use Exception;
+
 /**
  * Base class for phone number exceptions.
  */
-class PhoneNumberException extends \Exception
+class PhoneNumberException extends Exception
 {
 }

tests/EnumTest.php

@@ -8,18 +8,35 @@
 use Brick\PhoneNumber\PhoneNumberFormat;
 use Brick\PhoneNumber\PhoneNumberParseErrorType;
 use Brick\PhoneNumber\PhoneNumberType;
+use libphonenumber\NumberParseException;
 use PHPUnit\Framework\TestCase;
+use ReflectionClass;
 
 /**
  * Tests that enums are up-to-date with libphonenumber constants.
  */
 class EnumTest extends TestCase
 {
+    public function testPhoneNumberFormats(): void
+    {
+        self::assertEnumEqualsEnum(\libphonenumber\PhoneNumberFormat::class, PhoneNumberFormat::class);
+    }
+
+    public function testPhoneNumberTypes(): void
+    {
+        self::assertEnumEqualsEnum(\libphonenumber\PhoneNumberType::class, PhoneNumberType::class);
+    }
+
+    public function testPhoneNumberParseErrorTypes(): void
+    {
+        self::assertEnumEqualsConstants(NumberParseException::class, PhoneNumberParseErrorType::class);
+    }
+
     /**
      * @param class-string<BackedEnum> $enumClassExpected The name or the reference libphonenumber enum class.
      * @param class-string<BackedEnum> $enumClassActual   The name of the enum class to test against the reference class.
      */
-    private static function assertEnumEqualsEnum(string $enumClassExpected, string $enumClassActual) : void
+    private static function assertEnumEqualsEnum(string $enumClassExpected, string $enumClassActual): void
     {
         self::assertSame(
             self::enumToMap($enumClassExpected),
@@ -31,9 +48,9 @@ private static function assertEnumEqualsEnum(string $enumClassExpected, string $
      * @param class-string             $classExpected   The name or the reference libphonenumber class.
      * @param class-string<BackedEnum> $enumClassActual The name of the enum class to test against the reference class.
      */
-    private static function assertEnumEqualsConstants(string $classExpected, string $enumClassActual) : void
+    private static function assertEnumEqualsConstants(string $classExpected, string $enumClassActual): void
     {
-        $expected = (new \ReflectionClass($classExpected))->getConstants();
+        $expected = (new ReflectionClass($classExpected))->getConstants();
         $actual = self::enumToMap($enumClassActual);
 
         self::assertSame($expected, $actual);
@@ -54,19 +71,4 @@ private static function enumToMap(string $enumClass): array
 
         return $values;
     }
-
-    public function testPhoneNumberFormats() : void
-    {
-        self::assertEnumEqualsEnum(\libphonenumber\PhoneNumberFormat::class, PhoneNumberFormat::class);
-    }
-
-    public function testPhoneNumberTypes() : void
-    {
-        self::assertEnumEqualsEnum(\libphonenumber\PhoneNumberType::class, PhoneNumberType::class);
-    }
-
-    public function testPhoneNumberParseErrorTypes() : void
-    {
-        self::assertEnumEqualsConstants(\libphonenumber\NumberParseException::class, PhoneNumberParseErrorType::class);
-    }
 }