Propaganistas\LaravelPhone\PhoneValidator

Complexity

Total Complexity

37

Size/Duplication

Total Lines	250
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

98.53%

Importance

Changes	24
Bugs	6	Features	6

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	validatePhone()	0	23	6
C	assignParameters()	0	28	7
B	checkCountries()	0	10	6
C	isValidNumber()	0	35	7
A	parseTypes()	0	14	2
A	isInputField()	0	4	2
A	isPhoneCountry()	0	4	4
A	isPhoneType()	0	7	2

<?php namespace Propaganistas\LaravelPhone;

use libphonenumber\NumberParseException;
use libphonenumber\PhoneNumberType;
use libphonenumber\PhoneNumberUtil;
use Propaganistas\LaravelPhone\Exceptions\NoValidCountryFoundException;
use Propaganistas\LaravelPhone\Exceptions\InvalidParameterException;

class PhoneValidator
{

	/**
	 * @var \libphonenumber\PhoneNumberUtil
	 */
	protected $lib;

	/**
	 * Dotted validator data.
	 *
	 * @var array
	 */
	protected $data;

	/**
	 * Whether the country should be auto-detected.
	 *
	 * @var bool
	 */
	protected $autodetect = false;

	/**
	 * Whether to allow lenient checking of numbers (i.e. landline without area codes).
	 *
	 * @var bool
	 */
	protected $lenient = false;

	/**
	 * The field to use for country if not passed as a parameter.
	 *
	 * @var string|null
	 */
	protected $countryField = null;

	/**
	 * Countries to validate against.
	 *
	 * @var array
	 */
	protected $countries = [];

	/**
	 * Transformed phone number types to validate against.
	 *
	 * @var array
	 */
	protected $types = [];

	/**
	 * PhoneValidator constructor.
	 */
	public function __construct(PhoneNumberUtil $lib)
	{
		$this->lib = $lib;
	}

	/**
	 * Validates a phone number.
	 *
	 * @param  string $attribute
	 * @param  mixed  $value
	 * @param  array  $parameters
	 * @param  object $validator
	 * @return bool
	 * @throws \Propaganistas\LaravelPhone\Exceptions\InvalidParameterException
	 * @throws \Propaganistas\LaravelPhone\Exceptions\NoValidCountryFoundException
	 */
	public function validatePhone($attribute, $value, array $parameters, $validator)
	{
		$this->data = array_dot($validator->getData());

		$this->assignParameters($parameters);

		$this->checkCountries($attribute);

		// If autodetecting, let's first try without a country.
		// Otherwise use provided countries as default.
		if ($this->autodetect || ($this->lenient && empty($this->countries))) {
			array_unshift($this->countries, null);
		}

		foreach ($this->countries as $country) {
			if ($this->isValidNumber($value, $country)) {
				return true;
			}
		}

		// All specified country validations have failed.
		return false;
	}

	/**
	 * Parses the supplied validator parameters.
	 *
	 * @param array $parameters
	 * @throws \Propaganistas\LaravelPhone\Exceptions\InvalidParameterException
	 */
	protected function assignParameters(array $parameters)
	{
		$types = array();

		foreach ($parameters as $parameter) {
			if ($this->isInputField($parameter)) {
				$this->countryField = $parameter;
			} else {
				$parameter = strtoupper($parameter);

				if ($this->isPhoneCountry($parameter)) {
					$this->countries[] = $parameter;
				} elseif ($this->isPhoneType($parameter)) {
					$types[] = $parameter;
				} elseif ($parameter == 'AUTO') {
					$this->autodetect = true;
				} elseif ($parameter == 'LENIENT') {
					$this->lenient = true;
				} else {
					// Force developers to write proper code.
					throw new InvalidParameterException($parameter);
				}
			}
		}

		$this->types = $this->parseTypes($types);

	}

	/**
	 * Checks the detected countries. Overrides countries if a country field is present.
	 * When using a country field, we should validate to false if country is empty so no exception
	 * will be thrown.
	 *
	 * @param string $attribute
	 * @throws \Propaganistas\LaravelPhone\Exceptions\NoValidCountryFoundException
	 */
	protected function checkCountries($attribute)
	{
		$countryField = (is_null($this->countryField) ? $attribute . '_country' : $this->countryField);

		if ($value = $this->isInputField($countryField)) {
			$this->countries = array($value);
		} elseif (!$this->autodetect && !$this->lenient && empty($this->countries)) {
			throw new NoValidCountryFoundException;
		}
	}

	/**
	 * Performs the actual validation of the phone number.
	 *
	 * @param mixed $number
	 * @param null  $country
	 * @return bool
	 */
	protected function isValidNumber($number, $country = null)
	{
		try {
			// Throws NumberParseException if not parsed correctly against the supplied country.
			// If no country was given, tries to discover the country code from the number itself.
			$phoneNumber = $this->lib->parse($number, $country);

			// Check if type is allowed.
			if (empty($this->types) || in_array($this->lib->getNumberType($phoneNumber), $this->types)) {

				// Lenient validation.
				if ($this->lenient) {
					return $this->lib->isPossibleNumber($phoneNumber, $country);
				}

				// For automatic detection, the number should have a country code.
				if ($phoneNumber->hasCountryCode()) {

					// Automatic detection:
					if ($this->autodetect) {
						// Validate if the international phone number is valid for its contained country.
						return $this->lib->isValidNumber($phoneNumber);
					}

					// Validate number against the specified country.
					return $this->lib->isValidNumberForRegion($phoneNumber, $country);
				}
			}

		} catch (NumberParseException $e) {
			// Proceed to default validation error.
		}

		return false;
	}

	/**
	 * Parses the supplied phone number types.
	 *
	 * @param array $types
	 * @return array
	 */
	protected function parseTypes(array $types)
	{
		// Transform types to their namespaced class constant.
		array_walk($types, function(&$type) {
			$type = constant('\libphonenumber\PhoneNumberType::' . $type);
		});

		// Add in the unsure number type if applicable.
		if (array_intersect([PhoneNumberType::FIXED_LINE, PhoneNumberType::MOBILE], $types)) {
			$types[] = PhoneNumberType::FIXED_LINE_OR_MOBILE;
		}

		return $types;
	}

	/**
	 * Checks if the given field is an actual input field and returns the value if applicable.
	 * Null otherwise.
	 *
	 * @param string $field
	 * @return mixed|null
	 */
	public function isInputField($field)
	{
		return isset($this->data[$field]) ? $this->data[$field] : null;
	}

	/**
	 * Checks if the supplied string is a valid country code using some arbitrary country validation.
	 * If using a package based on umpirsky/country-list, invalidate the option 'ZZ => Unknown or invalid region'.
	 *
	 * @param  string $country
	 * @return bool
	 */
	public function isPhoneCountry($country)
	{
		return (strlen($country) === 2 && ctype_alpha($country) && ctype_upper($country) && $country != 'ZZ');
	}

	/**
	 * Checks if the supplied string is a valid phone number type.
	 *
	 * @param  string $type
	 * @return bool
	 */
	public function isPhoneType($type)
	{
		// Legacy support.
		$type = ($type == 'LANDLINE' ? 'FIXED_LINE' : $type);

		return defined('\libphonenumber\PhoneNumberType::' . $type);
	}

}