@@ -7,74 +7,74 @@ |
||
| 7 | 7 | |
| 8 | 8 | trait ParsesTypes |
| 9 | 9 | { |
| 10 | - /** |
|
| 11 | - * Array of available phone types. |
|
| 12 | - * |
|
| 13 | - * @var array |
|
| 14 | - */ |
|
| 15 | - protected static $types; |
|
| 10 | + /** |
|
| 11 | + * Array of available phone types. |
|
| 12 | + * |
|
| 13 | + * @var array |
|
| 14 | + */ |
|
| 15 | + protected static $types; |
|
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Determine whether the given type is valid. |
|
| 19 | - * |
|
| 20 | - * @param string $type |
|
| 21 | - * @return bool |
|
| 22 | - */ |
|
| 23 | - public static function isValidType($type) |
|
| 24 | - { |
|
| 25 | - return ! empty(static::parseTypes($type)); |
|
| 26 | - } |
|
| 17 | + /** |
|
| 18 | + * Determine whether the given type is valid. |
|
| 19 | + * |
|
| 20 | + * @param string $type |
|
| 21 | + * @return bool |
|
| 22 | + */ |
|
| 23 | + public static function isValidType($type) |
|
| 24 | + { |
|
| 25 | + return ! empty(static::parseTypes($type)); |
|
| 26 | + } |
|
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * Parse a phone type into constant's value. |
|
| 30 | - * |
|
| 31 | - * @param string|array $types |
|
| 32 | - * @return array |
|
| 33 | - */ |
|
| 34 | - protected static function parseTypes($types) |
|
| 35 | - { |
|
| 36 | - static::loadTypes(); |
|
| 28 | + /** |
|
| 29 | + * Parse a phone type into constant's value. |
|
| 30 | + * |
|
| 31 | + * @param string|array $types |
|
| 32 | + * @return array |
|
| 33 | + */ |
|
| 34 | + protected static function parseTypes($types) |
|
| 35 | + { |
|
| 36 | + static::loadTypes(); |
|
| 37 | 37 | |
| 38 | - return Collection::make(is_array($types) ? $types : func_get_args()) |
|
| 39 | - ->map(function ($type) { |
|
| 40 | - // If the type equals a constant's value, just return it. |
|
| 41 | - if (is_numeric($type) && in_array($type, static::$types)) { |
|
| 42 | - return (int) $type; |
|
| 43 | - } |
|
| 38 | + return Collection::make(is_array($types) ? $types : func_get_args()) |
|
| 39 | + ->map(function ($type) { |
|
| 40 | + // If the type equals a constant's value, just return it. |
|
| 41 | + if (is_numeric($type) && in_array($type, static::$types)) { |
|
| 42 | + return (int) $type; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - // Otherwise we'll assume the type is the constant's name. |
|
| 46 | - return Arr::get(static::$types, strtoupper($type)); |
|
| 47 | - }) |
|
| 48 | - ->reject(function ($value) { |
|
| 49 | - return is_null($value) || $value === false; |
|
| 50 | - })->toArray(); |
|
| 51 | - } |
|
| 45 | + // Otherwise we'll assume the type is the constant's name. |
|
| 46 | + return Arr::get(static::$types, strtoupper($type)); |
|
| 47 | + }) |
|
| 48 | + ->reject(function ($value) { |
|
| 49 | + return is_null($value) || $value === false; |
|
| 50 | + })->toArray(); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Parse a phone type into its string representation. |
|
| 55 | - * |
|
| 56 | - * @param string|array $types |
|
| 57 | - * @return array |
|
| 58 | - */ |
|
| 59 | - protected static function parseTypesAsStrings($types) |
|
| 60 | - { |
|
| 61 | - static::loadTypes(); |
|
| 53 | + /** |
|
| 54 | + * Parse a phone type into its string representation. |
|
| 55 | + * |
|
| 56 | + * @param string|array $types |
|
| 57 | + * @return array |
|
| 58 | + */ |
|
| 59 | + protected static function parseTypesAsStrings($types) |
|
| 60 | + { |
|
| 61 | + static::loadTypes(); |
|
| 62 | 62 | |
| 63 | - return array_keys( |
|
| 64 | - array_intersect( |
|
| 65 | - static::$types, |
|
| 66 | - static::parseTypes($types) |
|
| 67 | - ) |
|
| 68 | - ); |
|
| 69 | - } |
|
| 63 | + return array_keys( |
|
| 64 | + array_intersect( |
|
| 65 | + static::$types, |
|
| 66 | + static::parseTypes($types) |
|
| 67 | + ) |
|
| 68 | + ); |
|
| 69 | + } |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Load all available formats once. |
|
| 73 | - */ |
|
| 74 | - private static function loadTypes() |
|
| 75 | - { |
|
| 76 | - if (! static::$types) { |
|
| 77 | - static::$types = with(new ReflectionClass(PhoneNumberType::class))->getConstants(); |
|
| 78 | - } |
|
| 79 | - } |
|
| 71 | + /** |
|
| 72 | + * Load all available formats once. |
|
| 73 | + */ |
|
| 74 | + private static function loadTypes() |
|
| 75 | + { |
|
| 76 | + if (! static::$types) { |
|
| 77 | + static::$types = with(new ReflectionClass(PhoneNumberType::class))->getConstants(); |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | 80 | } |
| 81 | 81 | \ No newline at end of file |
@@ -11,135 +11,135 @@ |
||
| 11 | 11 | |
| 12 | 12 | class Phone |
| 13 | 13 | { |
| 14 | - use ParsesCountries, |
|
| 15 | - ParsesTypes; |
|
| 16 | - |
|
| 17 | - /** |
|
| 18 | - * @var \libphonenumber\PhoneNumberUtil |
|
| 19 | - */ |
|
| 20 | - protected $lib; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Phone constructor. |
|
| 24 | - */ |
|
| 25 | - public function __construct() |
|
| 26 | - { |
|
| 27 | - $this->lib = PhoneNumberUtil::getInstance(); |
|
| 28 | - } |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * Validates a phone number. |
|
| 32 | - * |
|
| 33 | - * @param string $attribute |
|
| 34 | - * @param mixed $value |
|
| 35 | - * @param array $parameters |
|
| 36 | - * @param object $validator |
|
| 37 | - * @return bool |
|
| 38 | - */ |
|
| 39 | - public function validate($attribute, $value, array $parameters, $validator) |
|
| 40 | - { |
|
| 41 | - $data = $validator->getData(); |
|
| 42 | - |
|
| 43 | - list( |
|
| 44 | - $countries, |
|
| 45 | - $types, |
|
| 46 | - $detect, |
|
| 47 | - $lenient) = $this->extractParameters($attribute, $parameters, $data); |
|
| 48 | - |
|
| 49 | - // A "null" country is prepended: |
|
| 50 | - // 1. In case of auto-detection to have the validation run first without supplying a country. |
|
| 51 | - // 2. In case of lenient validation without provided countries; we still might have some luck... |
|
| 52 | - if ($detect || ($lenient && empty($countries))) { |
|
| 53 | - array_unshift($countries, null); |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - foreach ($countries as $country) { |
|
| 57 | - try { |
|
| 58 | - // Parsing the phone number also validates the country, so no need to do this explicitly. |
|
| 59 | - // It'll throw a PhoneCountryException upon failure. |
|
| 60 | - $phoneNumber = PhoneNumber::make($value, $country); |
|
| 61 | - |
|
| 62 | - // Type validation. |
|
| 63 | - if (! empty($types) && ! $phoneNumber->isOfType($types)) { |
|
| 64 | - continue; |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - $lenientPhoneNumber = $phoneNumber->lenient()->getPhoneNumberInstance(); |
|
| 68 | - |
|
| 69 | - // Lenient validation. |
|
| 70 | - if ($lenient && $this->lib->isPossibleNumber($lenientPhoneNumber, $country)) { |
|
| 71 | - return true; |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - $phoneNumberInstance = $phoneNumber->getPhoneNumberInstance(); |
|
| 75 | - |
|
| 76 | - // Country detection. |
|
| 77 | - if ($detect && $this->lib->isValidNumber($phoneNumberInstance)) { |
|
| 78 | - return true; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - // Default number+country validation. |
|
| 82 | - if ($this->lib->isValidNumberForRegion($phoneNumberInstance, $country)) { |
|
| 83 | - return true; |
|
| 84 | - } |
|
| 85 | - } catch (NumberParseException $e) { |
|
| 86 | - continue; |
|
| 87 | - } |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - return false; |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * Parse and extract parameters in the appropriate validation arguments. |
|
| 95 | - * |
|
| 96 | - * @param string $attribute |
|
| 97 | - * @param array $parameters |
|
| 98 | - * @param array $data |
|
| 99 | - * @return array |
|
| 100 | - * @throws \Propaganistas\LaravelPhone\Exceptions\InvalidParameterException |
|
| 101 | - */ |
|
| 102 | - protected function extractParameters($attribute, array $parameters, array $data) |
|
| 103 | - { |
|
| 104 | - // Discover if an input field was provided. If not, guess the field's name. |
|
| 105 | - $inputField = Collection::make($parameters) |
|
| 106 | - ->intersect(array_keys(Arr::dot($data))) |
|
| 107 | - ->first() ?: "${attribute}_country"; |
|
| 108 | - |
|
| 109 | - // Attempt to retrieve the field's value. |
|
| 110 | - if ($inputCountry = Arr::get($data, $inputField)) { |
|
| 111 | - |
|
| 112 | - if (static::isValidType($inputField)) { |
|
| 113 | - throw InvalidParameterException::ambiguous($inputField); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - // Invalid country field values should just validate to false, and this is exactly what |
|
| 117 | - // we're getting when simply excluding invalid values. |
|
| 118 | - // This will also prevent parameter hijacking through the country field. |
|
| 119 | - if (static::isValidCountryCode($inputCountry)) { |
|
| 120 | - $parameters[] = $inputCountry; |
|
| 121 | - } |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - $countries = static::parseCountries($parameters); |
|
| 125 | - $types = static::parseTypes($parameters); |
|
| 126 | - |
|
| 127 | - // Force developers to write proper code. |
|
| 128 | - // Since the static parsers return a validated array with preserved keys, we can safely diff against the keys. |
|
| 129 | - // Unfortunately we can't use $collection->diffKeys() as it's not available yet in earlier 5.* versions. |
|
| 130 | - $leftovers = array_diff_key($parameters, $types, $countries); |
|
| 131 | - $leftovers = array_diff($leftovers, ['AUTO', 'LENIENT', $inputField]); |
|
| 132 | - |
|
| 133 | - if (! empty($leftovers)) { |
|
| 134 | - throw InvalidParameterException::parameters($leftovers); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - return [ |
|
| 138 | - $countries, |
|
| 139 | - $types, |
|
| 140 | - in_array('AUTO', $parameters), |
|
| 141 | - in_array('LENIENT', $parameters), |
|
| 142 | - $inputField, |
|
| 143 | - ]; |
|
| 144 | - } |
|
| 14 | + use ParsesCountries, |
|
| 15 | + ParsesTypes; |
|
| 16 | + |
|
| 17 | + /** |
|
| 18 | + * @var \libphonenumber\PhoneNumberUtil |
|
| 19 | + */ |
|
| 20 | + protected $lib; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Phone constructor. |
|
| 24 | + */ |
|
| 25 | + public function __construct() |
|
| 26 | + { |
|
| 27 | + $this->lib = PhoneNumberUtil::getInstance(); |
|
| 28 | + } |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * Validates a phone number. |
|
| 32 | + * |
|
| 33 | + * @param string $attribute |
|
| 34 | + * @param mixed $value |
|
| 35 | + * @param array $parameters |
|
| 36 | + * @param object $validator |
|
| 37 | + * @return bool |
|
| 38 | + */ |
|
| 39 | + public function validate($attribute, $value, array $parameters, $validator) |
|
| 40 | + { |
|
| 41 | + $data = $validator->getData(); |
|
| 42 | + |
|
| 43 | + list( |
|
| 44 | + $countries, |
|
| 45 | + $types, |
|
| 46 | + $detect, |
|
| 47 | + $lenient) = $this->extractParameters($attribute, $parameters, $data); |
|
| 48 | + |
|
| 49 | + // A "null" country is prepended: |
|
| 50 | + // 1. In case of auto-detection to have the validation run first without supplying a country. |
|
| 51 | + // 2. In case of lenient validation without provided countries; we still might have some luck... |
|
| 52 | + if ($detect || ($lenient && empty($countries))) { |
|
| 53 | + array_unshift($countries, null); |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + foreach ($countries as $country) { |
|
| 57 | + try { |
|
| 58 | + // Parsing the phone number also validates the country, so no need to do this explicitly. |
|
| 59 | + // It'll throw a PhoneCountryException upon failure. |
|
| 60 | + $phoneNumber = PhoneNumber::make($value, $country); |
|
| 61 | + |
|
| 62 | + // Type validation. |
|
| 63 | + if (! empty($types) && ! $phoneNumber->isOfType($types)) { |
|
| 64 | + continue; |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + $lenientPhoneNumber = $phoneNumber->lenient()->getPhoneNumberInstance(); |
|
| 68 | + |
|
| 69 | + // Lenient validation. |
|
| 70 | + if ($lenient && $this->lib->isPossibleNumber($lenientPhoneNumber, $country)) { |
|
| 71 | + return true; |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + $phoneNumberInstance = $phoneNumber->getPhoneNumberInstance(); |
|
| 75 | + |
|
| 76 | + // Country detection. |
|
| 77 | + if ($detect && $this->lib->isValidNumber($phoneNumberInstance)) { |
|
| 78 | + return true; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + // Default number+country validation. |
|
| 82 | + if ($this->lib->isValidNumberForRegion($phoneNumberInstance, $country)) { |
|
| 83 | + return true; |
|
| 84 | + } |
|
| 85 | + } catch (NumberParseException $e) { |
|
| 86 | + continue; |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + return false; |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * Parse and extract parameters in the appropriate validation arguments. |
|
| 95 | + * |
|
| 96 | + * @param string $attribute |
|
| 97 | + * @param array $parameters |
|
| 98 | + * @param array $data |
|
| 99 | + * @return array |
|
| 100 | + * @throws \Propaganistas\LaravelPhone\Exceptions\InvalidParameterException |
|
| 101 | + */ |
|
| 102 | + protected function extractParameters($attribute, array $parameters, array $data) |
|
| 103 | + { |
|
| 104 | + // Discover if an input field was provided. If not, guess the field's name. |
|
| 105 | + $inputField = Collection::make($parameters) |
|
| 106 | + ->intersect(array_keys(Arr::dot($data))) |
|
| 107 | + ->first() ?: "${attribute}_country"; |
|
| 108 | + |
|
| 109 | + // Attempt to retrieve the field's value. |
|
| 110 | + if ($inputCountry = Arr::get($data, $inputField)) { |
|
| 111 | + |
|
| 112 | + if (static::isValidType($inputField)) { |
|
| 113 | + throw InvalidParameterException::ambiguous($inputField); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + // Invalid country field values should just validate to false, and this is exactly what |
|
| 117 | + // we're getting when simply excluding invalid values. |
|
| 118 | + // This will also prevent parameter hijacking through the country field. |
|
| 119 | + if (static::isValidCountryCode($inputCountry)) { |
|
| 120 | + $parameters[] = $inputCountry; |
|
| 121 | + } |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + $countries = static::parseCountries($parameters); |
|
| 125 | + $types = static::parseTypes($parameters); |
|
| 126 | + |
|
| 127 | + // Force developers to write proper code. |
|
| 128 | + // Since the static parsers return a validated array with preserved keys, we can safely diff against the keys. |
|
| 129 | + // Unfortunately we can't use $collection->diffKeys() as it's not available yet in earlier 5.* versions. |
|
| 130 | + $leftovers = array_diff_key($parameters, $types, $countries); |
|
| 131 | + $leftovers = array_diff($leftovers, ['AUTO', 'LENIENT', $inputField]); |
|
| 132 | + |
|
| 133 | + if (! empty($leftovers)) { |
|
| 134 | + throw InvalidParameterException::parameters($leftovers); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + return [ |
|
| 138 | + $countries, |
|
| 139 | + $types, |
|
| 140 | + in_array('AUTO', $parameters), |
|
| 141 | + in_array('LENIENT', $parameters), |
|
| 142 | + $inputField, |
|
| 143 | + ]; |
|
| 144 | + } |
|
| 145 | 145 | } |