Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
93.10%
27 / 29
87.50%
7 / 8
 CRAP
0.00%
0 / 1
PhoneNumber
93.10%
27 / 29
87.50%
7 / 8
 14.06
0.00%
0 / 1
 fromCountry
n/a
0 / 0
n/a
0 / 0
 0
 getUtil
100.00%
3 / 3
100.00%
1 / 1
 2
 toE164
100.00%
1 / 1
100.00%
1 / 1
 1
 toInternational
100.00%
1 / 1
100.00%
1 / 1
 1
 toNational
100.00%
1 / 1
100.00%
1 / 1
 1
 toRFC3966
100.00%
1 / 1
100.00%
1 / 1
 1
 convert
100.00%
5 / 5
100.00%
1 / 1
 2
 validate
66.67%
4 / 6
0.00%
0 / 1
 4.59
 createRandom
100.00%
11 / 11
100.00%
1 / 1
 2
1<?php
2namespace Apie\CountryAndPhoneNumber;
3
4use Apie\Core\Attributes\FakeMethod;
5use Apie\Core\ValueObjects\Exceptions\InvalidStringForValueObjectException;
6use Apie\Core\ValueObjects\Interfaces\StringValueObjectInterface;
7use Apie\Core\ValueObjects\IsStringValueObject;
8use Apie\CountryAndPhoneNumber\Factories\PhoneNumberFactory;
9use Faker\Generator;
10use libphonenumber\NumberParseException;
11use libphonenumber\PhoneNumber as LibPhoneNumber;
12use libphonenumber\PhoneNumberFormat;
13use libphonenumber\PhoneNumberUtil;
14use PrinsFrank\Standards\Country\CountryAlpha2;
15use ReflectionClass;
16
17#[FakeMethod('createRandom')]
18abstract class PhoneNumber implements StringValueObjectInterface
19{
20    use IsStringValueObject;
21
22    private static PhoneNumberUtil $util;
23
24    private LibPhoneNumber $phoneNumber;
25
26    abstract public static function fromCountry(): CountryAlpha2;
27
28    final protected static function getUtil(): PhoneNumberUtil
29    {
30        if (!isset(self::$util)) {
31            self::$util = PhoneNumberUtil::getInstance();
32        }
33        return self::$util;
34    }
35
36    final public function toE164(): string
37    {
38        return self::getUtil()->format($this->phoneNumber, PhoneNumberFormat::E164);
39    }
40
41    final public function toInternational(): string
42    {
43        return self::getUtil()->format($this->phoneNumber, PhoneNumberFormat::INTERNATIONAL);
44    }
45
46    final public function toNational(): string
47    {
48        return self::getUtil()->format($this->phoneNumber, PhoneNumberFormat::NATIONAL);
49    }
50
51    final public function toRFC3966(): string
52    {
53        return self::getUtil()->format($this->phoneNumber, PhoneNumberFormat::RFC3966);
54    }
55
56    final protected function convert(string $input): string
57    {
58        $phoneNumberUtil = self::getUtil();
59        try {
60            $this->phoneNumber = $phoneNumberUtil->parse($input, static::fromCountry()->value);
61        } catch (NumberParseException $error) {
62            throw new InvalidStringForValueObjectException($input, new ReflectionClass(static::class), $error);
63        }
64        return $phoneNumberUtil->format($this->phoneNumber, PhoneNumberFormat::E164);
65    }
66
67    public static function validate(string $input): void
68    {
69        $phoneNumberUtil = self::getUtil();
70        try {
71            $phoneNumber = $phoneNumberUtil->parse($input, static::class === PhoneNumber::class ? null : static::fromCountry()->value);
72        } catch (NumberParseException $error) {
73            throw new InvalidStringForValueObjectException($input, new ReflectionClass(static::class), $error);
74        }
75        if (!$phoneNumberUtil->isValidNumberForRegion($phoneNumber, static::fromCountry()->value)) {
76            throw new InvalidStringForValueObjectException($input, new ReflectionClass(static::class));
77        }
78    }
79
80    public static function createRandom(Generator $generator): self
81    {
82        $phoneNumber = '';
83        do {
84            $country = $generator->randomElement(CountryAlpha2::cases());
85            $phoneNumberUtil = self::getUtil();
86            $phoneNumberObject = $phoneNumberUtil->getExampleNumber($country->value);
87            if ($phoneNumberObject) {
88                $phoneNumber = $phoneNumberUtil->format($phoneNumberObject, PhoneNumberFormat::E164);
89            }
90        } while ($phoneNumber === '');
91        return PhoneNumberFactory::createFrom(
92            $phoneNumber,
93            $country
94        );
95    }
96}