Propaganistas / Laravel-Phone

src/Validation/Phone.php

Indentation +131 added lines, -131 removed lines

@@ -11,135 +11,135 @@
 
 class Phone
 {
-    use ParsesCountries,
-        ParsesTypes;
-
-    /**
-     * @var \libphonenumber\PhoneNumberUtil
-     */
-    protected $lib;
-
-    /**
-     * Phone constructor.
-     */
-    public function __construct()
-    {
-        $this->lib = PhoneNumberUtil::getInstance();
-    }
-
-    /**
-     * Validates a phone number.
-     *
-     * @param  string $attribute
-     * @param  mixed  $value
-     * @param  array  $parameters
-     * @param  object $validator
-     * @return bool
-     */
-    public function validate($attribute, $value, array $parameters, $validator)
-    {
-        $data = $validator->getData();
-
-        list(
-            $countries,
-            $types,
-            $detect,
-            $lenient) = $this->extractParameters($attribute, $parameters, $data);
-
-        // A "null" country is prepended:
-        // 1. In case of auto-detection to have the validation run first without supplying a country.
-        // 2. In case of lenient validation without provided countries; we still might have some luck...
-        if ($detect || ($lenient && empty($countries))) {
-            array_unshift($countries, null);
-        }
-
-        foreach ($countries as $country) {
-            try {
-                // Parsing the phone number also validates the country, so no need to do this explicitly.
-                // It'll throw a PhoneCountryException upon failure.
-                $phoneNumber = PhoneNumber::make($value, $country);
-
-                // Type validation.
-                if (! empty($types) && ! $phoneNumber->isOfType($types)) {
-                    continue;
-                }
-
-                $lenientPhoneNumber = $phoneNumber->lenient()->getPhoneNumberInstance();
-
-                // Lenient validation.
-                if ($lenient && $this->lib->isPossibleNumber($lenientPhoneNumber, $country)) {
-                    return true;
-                }
-
-                $phoneNumberInstance = $phoneNumber->getPhoneNumberInstance();
-
-                // Country detection.
-                if ($detect && $this->lib->isValidNumber($phoneNumberInstance)) {
-                    return true;
-                }
-
-                // Default number+country validation.
-                if ($this->lib->isValidNumberForRegion($phoneNumberInstance, $country)) {
-                    return true;
-                }
-            } catch (NumberParseException $e) {
-                continue;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Parse and extract parameters in the appropriate validation arguments.
-     *
-     * @param string $attribute
-     * @param array  $parameters
-     * @param array  $data
-     * @return array
-     * @throws \Propaganistas\LaravelPhone\Exceptions\InvalidParameterException
-     */
-    protected function extractParameters($attribute, array $parameters, array $data)
-    {
-        // Discover if an input field was provided. If not, guess the field's name.
-        $inputField = Collection::make($parameters)
-                                ->intersect(array_keys(Arr::dot($data)))
-                                ->first() ?: "${attribute}_country";
-
-        // Attempt to retrieve the field's value.
-        if ($inputCountry = Arr::get($data, $inputField)) {
-
-            if (static::isValidType($inputField)) {
-                throw InvalidParameterException::ambiguous($inputField);
-            }
-
-            // Invalid country field values should just validate to false, and this is exactly what
-            // we're getting when simply excluding invalid values.
-            // This will also prevent parameter hijacking through the country field.
-            if (static::isValidCountryCode($inputCountry)) {
-                $parameters[] = $inputCountry;
-            }
-        }
-
-        $countries = static::parseCountries($parameters);
-        $types = static::parseTypes($parameters);
-
-        // Force developers to write proper code.
-        // Since the static parsers return a validated array with preserved keys, we can safely diff against the keys.
-        // Unfortunately we can't use $collection->diffKeys() as it's not available yet in earlier 5.* versions.
-        $leftovers = array_diff_key($parameters, $types, $countries);
-        $leftovers = array_diff($leftovers, ['AUTO', 'LENIENT', $inputField]);
-
-        if (! empty($leftovers)) {
-            throw InvalidParameterException::parameters($leftovers);
-        }
-
-        return [
-            $countries,
-            $types,
-            in_array('AUTO', $parameters),
-            in_array('LENIENT', $parameters),
-            $inputField,
-        ];
-    }
+	use ParsesCountries,
+		ParsesTypes;
+
+	/**
+	 * @var \libphonenumber\PhoneNumberUtil
+	 */
+	protected $lib;
+
+	/**
+	 * Phone constructor.
+	 */
+	public function __construct()
+	{
+		$this->lib = PhoneNumberUtil::getInstance();
+	}
+
+	/**
+	 * Validates a phone number.
+	 *
+	 * @param  string $attribute
+	 * @param  mixed  $value
+	 * @param  array  $parameters
+	 * @param  object $validator
+	 * @return bool
+	 */
+	public function validate($attribute, $value, array $parameters, $validator)
+	{
+		$data = $validator->getData();
+
+		list(
+			$countries,
+			$types,
+			$detect,
+			$lenient) = $this->extractParameters($attribute, $parameters, $data);
+
+		// A "null" country is prepended:
+		// 1. In case of auto-detection to have the validation run first without supplying a country.
+		// 2. In case of lenient validation without provided countries; we still might have some luck...
+		if ($detect || ($lenient && empty($countries))) {
+			array_unshift($countries, null);
+		}
+
+		foreach ($countries as $country) {
+			try {
+				// Parsing the phone number also validates the country, so no need to do this explicitly.
+				// It'll throw a PhoneCountryException upon failure.
+				$phoneNumber = PhoneNumber::make($value, $country);
+
+				// Type validation.
+				if (! empty($types) && ! $phoneNumber->isOfType($types)) {
+					continue;
+				}
+
+				$lenientPhoneNumber = $phoneNumber->lenient()->getPhoneNumberInstance();
+
+				// Lenient validation.
+				if ($lenient && $this->lib->isPossibleNumber($lenientPhoneNumber, $country)) {
+					return true;
+				}
+
+				$phoneNumberInstance = $phoneNumber->getPhoneNumberInstance();
+
+				// Country detection.
+				if ($detect && $this->lib->isValidNumber($phoneNumberInstance)) {
+					return true;
+				}
+
+				// Default number+country validation.
+				if ($this->lib->isValidNumberForRegion($phoneNumberInstance, $country)) {
+					return true;
+				}
+			} catch (NumberParseException $e) {
+				continue;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Parse and extract parameters in the appropriate validation arguments.
+	 *
+	 * @param string $attribute
+	 * @param array  $parameters
+	 * @param array  $data
+	 * @return array
+	 * @throws \Propaganistas\LaravelPhone\Exceptions\InvalidParameterException
+	 */
+	protected function extractParameters($attribute, array $parameters, array $data)
+	{
+		// Discover if an input field was provided. If not, guess the field's name.
+		$inputField = Collection::make($parameters)
+								->intersect(array_keys(Arr::dot($data)))
+								->first() ?: "${attribute}_country";
+
+		// Attempt to retrieve the field's value.
+		if ($inputCountry = Arr::get($data, $inputField)) {
+
+			if (static::isValidType($inputField)) {
+				throw InvalidParameterException::ambiguous($inputField);
+			}
+
+			// Invalid country field values should just validate to false, and this is exactly what
+			// we're getting when simply excluding invalid values.
+			// This will also prevent parameter hijacking through the country field.
+			if (static::isValidCountryCode($inputCountry)) {
+				$parameters[] = $inputCountry;
+			}
+		}
+
+		$countries = static::parseCountries($parameters);
+		$types = static::parseTypes($parameters);
+
+		// Force developers to write proper code.
+		// Since the static parsers return a validated array with preserved keys, we can safely diff against the keys.
+		// Unfortunately we can't use $collection->diffKeys() as it's not available yet in earlier 5.* versions.
+		$leftovers = array_diff_key($parameters, $types, $countries);
+		$leftovers = array_diff($leftovers, ['AUTO', 'LENIENT', $inputField]);
+
+		if (! empty($leftovers)) {
+			throw InvalidParameterException::parameters($leftovers);
+		}
+
+		return [
+			$countries,
+			$types,
+			in_array('AUTO', $parameters),
+			in_array('LENIENT', $parameters),
+			$inputField,
+		];
+	}
 }

src/PhoneNumber.php

Indentation +374 added lines, -374 removed lines

@@ -19,378 +19,378 @@
 
 class PhoneNumber implements Jsonable, JsonSerializable, Serializable
 {
-    use ParsesCountries,
-        ParsesFormats,
-        ParsesTypes;
-
-    /**
-     * The provided phone number.
-     *
-     * @var string
-     */
-    protected $number;
-
-    /**
-     * The provided phone country.
-     *
-     * @var array
-     */
-    protected $countries = [];
-
-    /**
-     * The detected phone country.
-     *
-     * @var string
-     */
-    protected $country;
-
-    /**
-     * Whether to allow lenient checks (i.e. landline numbers without area codes).
-     *
-     * @var bool
-     */
-    protected $lenient = false;
-
-    /**
-     * @var \libphonenumber\PhoneNumberUtil
-     */
-    protected $lib;
-
-    /**
-     * Phone constructor.
-     *
-     * @param string $number
-     */
-    public function __construct($number)
-    {
-        $this->number = $number;
-        $this->lib = PhoneNumberUtil::getInstance();
-    }
-
-    /**
-     * Create a phone instance.
-     *
-     * @param string       $number
-     * @param string|array $country
-     * @return static
-     */
-    public static function make($number, $country = [])
-    {
-        $instance = new static($number);
-
-        return $instance->ofCountry($country);
-    }
-
-    /**
-     * Set the country to which the phone number belongs to.
-     *
-     * @param string|array $country
-     * @return static
-     */
-    public function ofCountry($country)
-    {
-        $countries = is_array($country) ? $country : func_get_args();
-
-        $instance = clone $this;
-        $instance->countries = array_unique(
-            array_merge($instance->countries, static::parseCountries($countries))
-        );
-
-        return $instance;
-    }
-
-    /**
-     * Format the phone number in international format.
-     *
-     * @return string
-     */
-    public function formatInternational()
-    {
-        return $this->format(PhoneNumberFormat::INTERNATIONAL);
-    }
-
-    /**
-     * Format the phone number in national format.
-     *
-     * @return string
-     */
-    public function formatNational()
-    {
-        return $this->format(PhoneNumberFormat::NATIONAL);
-    }
-
-    /**
-     * Format the phone number in E164 format.
-     *
-     * @return string
-     */
-    public function formatE164()
-    {
-        return $this->format(PhoneNumberFormat::E164);
-    }
-
-    /**
-     * Format the phone number in RFC3966 format.
-     *
-     * @return string
-     */
-    public function formatRFC3966()
-    {
-        return $this->format(PhoneNumberFormat::RFC3966);
-    }
-
-    /**
-     * Format the phone number in a given format.
-     *
-     * @param string $format
-     * @return string
-     * @throws \Propaganistas\LaravelPhone\Exceptions\NumberFormatException
-     */
-    public function format($format)
-    {
-        $parsedFormat = static::parseFormat($format);
-
-        if (is_null($parsedFormat)) {
-            throw NumberFormatException::invalid($format);
-        }
-
-        return $this->lib->format(
-            $this->getPhoneNumberInstance(),
-            $parsedFormat
-        );
-    }
-
-    /**
-     * Format the phone number in a way that it can be dialled from the provided country.
-     *
-     * @param string $country
-     * @return string
-     * @throws \Propaganistas\LaravelPhone\Exceptions\CountryCodeException
-     */
-    public function formatForCountry($country)
-    {
-        if (! static::isValidCountryCode($country)) {
-            throw CountryCodeException::invalid($country);
-        }
-
-        return $this->lib->formatOutOfCountryCallingNumber(
-            $this->getPhoneNumberInstance(),
-            $country
-        );
-    }
-
-    /**
-     * Format the phone number in a way that it can be dialled from the provided country using a cellphone.
-     *
-     * @param string $country
-     * @param bool   $removeFormatting
-     * @return string
-     * @throws \Propaganistas\LaravelPhone\Exceptions\CountryCodeException
-     */
-    public function formatForMobileDialingInCountry($country, $removeFormatting = false)
-    {
-        if (! static::isValidCountryCode($country)) {
-            throw CountryCodeException::invalid($country);
-        }
-
-        return $this->lib->formatNumberForMobileDialing(
-            $this->getPhoneNumberInstance(),
-            $country,
-            $removeFormatting
-        );
-    }
-
-    /**
-     * Get the phone number's country.
-     *
-     * @return string
-     */
-    public function getCountry()
-    {
-        if (! $this->country) {
-            $this->country = $this->filterValidCountry($this->countries);
-        }
-
-        return $this->country;
-    }
-
-    /**
-     * Check if the phone number is of (a) given country(ies).
-     *
-     * @param string|array $country
-     * @return bool
-     */
-    public function isOfCountry($country)
-    {
-        $countries = static::parseCountries($country);
-
-        return in_array($this->getCountry(), $countries);
-    }
-
-    /**
-     * Filter the provided countries to the one that is valid for the number.
-     *
-     * @param string|array $countries
-     * @return string
-     * @throws \Propaganistas\LaravelPhone\Exceptions\NumberParseException
-     */
-    protected function filterValidCountry($countries)
-    {
-        $result = Collection::make($countries)
-                            ->filter(function ($country) {
-                                $instance = $this->lib->parse($this->number, $country);
-
-                                return $this->lenient
-                                    ? $this->lib->isPossibleNumber($instance, $country)
-                                    : $this->lib->isValidNumberForRegion($instance, $country);
-                            })->first();
-
-        // If we got a new result, return it.
-        if ($result) {
-            return $result;
-        }
-
-        // Last resort: try to detect it from an international number.
-        if ($this->numberLooksInternational()) {
-            $countries[] = null;
-        }
-
-        foreach ($countries as $country) {
-            $instance = $this->lib->parse($this->number, $country);
-
-            if ($this->lib->isValidNumber($instance)) {
-                return $this->lib->getRegionCodeForNumber($instance);
-            }
-        }
-
-        throw NumberParseException::countryRequired($this->number);
-    }
-
-    /**
-     * Get the phone number's type.
-     *
-     * @param bool $asConstant
-     * @return string|int|null
-     */
-    public function getType($asConstant = false)
-    {
-        $type = $this->lib->getNumberType($this->getPhoneNumberInstance());
-
-        if ($asConstant) {
-            return $type;
-        }
-
-        $stringType = Arr::get(static::parseTypesAsStrings($type), 0);
-
-        return $stringType ? strtolower($stringType) : null;
-    }
-
-    /**
-     * Check if the phone number is of (a) given type(s).
-     *
-     * @param string $type
-     * @return bool
-     */
-    public function isOfType($type)
-    {
-        $types = static::parseTypes($type);
-
-        // Add the unsure type when applicable.
-        if (array_intersect([PhoneNumberType::FIXED_LINE, PhoneNumberType::MOBILE], $types)) {
-            $types[] = PhoneNumberType::FIXED_LINE_OR_MOBILE;
-        }
-
-        return in_array($this->getType(true), $types, true);
-    }
-
-    /**
-     * Get the PhoneNumber instance of the current number.
-     *
-     * @return \libphonenumber\PhoneNumber
-     */
-    public function getPhoneNumberInstance()
-    {
-        return $this->lib->parse($this->number, $this->getCountry());
-    }
-
-    /**
-     * Determine whether the phone number seems to be in international format.
-     *
-     * @return bool
-     */
-    protected function numberLooksInternational()
-    {
-        return Str::startsWith($this->number, '+');
-    }
-
-    /**
-     * Enable lenient number parsing.
-     *
-     * @return $this
-     */
-    public function lenient()
-    {
-        $this->lenient = true;
-
-        return $this;
-    }
-
-    /**
-     * Convert the phone instance to JSON.
-     *
-     * @param  int $options
-     * @return string
-     */
-    public function toJson($options = 0)
-    {
-        return json_encode($this->jsonSerialize(), $options);
-    }
-
-    /**
-     * Convert the phone instance into something JSON serializable.
-     *
-     * @return string
-     */
-    public function jsonSerialize()
-    {
-        return $this->formatE164();
-    }
-
-    /**
-     * Convert the phone instance into a string representation.
-     *
-     * @return string
-     */
-    public function serialize()
-    {
-        return $this->formatE164();
-    }
-
-    /**
-     * Reconstructs the phone instance from a string representation.
-     *
-     * @param string $serialized
-     */
-    public function unserialize($serialized)
-    {
-        $this->lib = PhoneNumberUtil::getInstance();
-        $this->number = $serialized;
-        $this->country = $this->lib->getRegionCodeForNumber($this->getPhoneNumberInstance());
-    }
-
-    /**
-     * Convert the phone instance to a formatted number.
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        // Formatting the phone number could throw an exception, but __toString() doesn't cope well with that.
-        // Let's just return the original number in that case.
-        try {
-            return $this->formatE164();
-        } catch (Exception $exception) {
-            return $this->number;
-        }
-    }
+	use ParsesCountries,
+		ParsesFormats,
+		ParsesTypes;
+
+	/**
+	 * The provided phone number.
+	 *
+	 * @var string
+	 */
+	protected $number;
+
+	/**
+	 * The provided phone country.
+	 *
+	 * @var array
+	 */
+	protected $countries = [];
+
+	/**
+	 * The detected phone country.
+	 *
+	 * @var string
+	 */
+	protected $country;
+
+	/**
+	 * Whether to allow lenient checks (i.e. landline numbers without area codes).
+	 *
+	 * @var bool
+	 */
+	protected $lenient = false;
+
+	/**
+	 * @var \libphonenumber\PhoneNumberUtil
+	 */
+	protected $lib;
+
+	/**
+	 * Phone constructor.
+	 *
+	 * @param string $number
+	 */
+	public function __construct($number)
+	{
+		$this->number = $number;
+		$this->lib = PhoneNumberUtil::getInstance();
+	}
+
+	/**
+	 * Create a phone instance.
+	 *
+	 * @param string       $number
+	 * @param string|array $country
+	 * @return static
+	 */
+	public static function make($number, $country = [])
+	{
+		$instance = new static($number);
+
+		return $instance->ofCountry($country);
+	}
+
+	/**
+	 * Set the country to which the phone number belongs to.
+	 *
+	 * @param string|array $country
+	 * @return static
+	 */
+	public function ofCountry($country)
+	{
+		$countries = is_array($country) ? $country : func_get_args();
+
+		$instance = clone $this;
+		$instance->countries = array_unique(
+			array_merge($instance->countries, static::parseCountries($countries))
+		);
+
+		return $instance;
+	}
+
+	/**
+	 * Format the phone number in international format.
+	 *
+	 * @return string
+	 */
+	public function formatInternational()
+	{
+		return $this->format(PhoneNumberFormat::INTERNATIONAL);
+	}
+
+	/**
+	 * Format the phone number in national format.
+	 *
+	 * @return string
+	 */
+	public function formatNational()
+	{
+		return $this->format(PhoneNumberFormat::NATIONAL);
+	}
+
+	/**
+	 * Format the phone number in E164 format.
+	 *
+	 * @return string
+	 */
+	public function formatE164()
+	{
+		return $this->format(PhoneNumberFormat::E164);
+	}
+
+	/**
+	 * Format the phone number in RFC3966 format.
+	 *
+	 * @return string
+	 */
+	public function formatRFC3966()
+	{
+		return $this->format(PhoneNumberFormat::RFC3966);
+	}
+
+	/**
+	 * Format the phone number in a given format.
+	 *
+	 * @param string $format
+	 * @return string
+	 * @throws \Propaganistas\LaravelPhone\Exceptions\NumberFormatException
+	 */
+	public function format($format)
+	{
+		$parsedFormat = static::parseFormat($format);
+
+		if (is_null($parsedFormat)) {
+			throw NumberFormatException::invalid($format);
+		}
+
+		return $this->lib->format(
+			$this->getPhoneNumberInstance(),
+			$parsedFormat
+		);
+	}
+
+	/**
+	 * Format the phone number in a way that it can be dialled from the provided country.
+	 *
+	 * @param string $country
+	 * @return string
+	 * @throws \Propaganistas\LaravelPhone\Exceptions\CountryCodeException
+	 */
+	public function formatForCountry($country)
+	{
+		if (! static::isValidCountryCode($country)) {
+			throw CountryCodeException::invalid($country);
+		}
+
+		return $this->lib->formatOutOfCountryCallingNumber(
+			$this->getPhoneNumberInstance(),
+			$country
+		);
+	}
+
+	/**
+	 * Format the phone number in a way that it can be dialled from the provided country using a cellphone.
+	 *
+	 * @param string $country
+	 * @param bool   $removeFormatting
+	 * @return string
+	 * @throws \Propaganistas\LaravelPhone\Exceptions\CountryCodeException
+	 */
+	public function formatForMobileDialingInCountry($country, $removeFormatting = false)
+	{
+		if (! static::isValidCountryCode($country)) {
+			throw CountryCodeException::invalid($country);
+		}
+
+		return $this->lib->formatNumberForMobileDialing(
+			$this->getPhoneNumberInstance(),
+			$country,
+			$removeFormatting
+		);
+	}
+
+	/**
+	 * Get the phone number's country.
+	 *
+	 * @return string
+	 */
+	public function getCountry()
+	{
+		if (! $this->country) {
+			$this->country = $this->filterValidCountry($this->countries);
+		}
+
+		return $this->country;
+	}
+
+	/**
+	 * Check if the phone number is of (a) given country(ies).
+	 *
+	 * @param string|array $country
+	 * @return bool
+	 */
+	public function isOfCountry($country)
+	{
+		$countries = static::parseCountries($country);
+
+		return in_array($this->getCountry(), $countries);
+	}
+
+	/**
+	 * Filter the provided countries to the one that is valid for the number.
+	 *
+	 * @param string|array $countries
+	 * @return string
+	 * @throws \Propaganistas\LaravelPhone\Exceptions\NumberParseException
+	 */
+	protected function filterValidCountry($countries)
+	{
+		$result = Collection::make($countries)
+							->filter(function ($country) {
+								$instance = $this->lib->parse($this->number, $country);
+
+								return $this->lenient
+									? $this->lib->isPossibleNumber($instance, $country)
+									: $this->lib->isValidNumberForRegion($instance, $country);
+							})->first();
+
+		// If we got a new result, return it.
+		if ($result) {
+			return $result;
+		}
+
+		// Last resort: try to detect it from an international number.
+		if ($this->numberLooksInternational()) {
+			$countries[] = null;
+		}
+
+		foreach ($countries as $country) {
+			$instance = $this->lib->parse($this->number, $country);
+
+			if ($this->lib->isValidNumber($instance)) {
+				return $this->lib->getRegionCodeForNumber($instance);
+			}
+		}
+
+		throw NumberParseException::countryRequired($this->number);
+	}
+
+	/**
+	 * Get the phone number's type.
+	 *
+	 * @param bool $asConstant
+	 * @return string|int|null
+	 */
+	public function getType($asConstant = false)
+	{
+		$type = $this->lib->getNumberType($this->getPhoneNumberInstance());
+
+		if ($asConstant) {
+			return $type;
+		}
+
+		$stringType = Arr::get(static::parseTypesAsStrings($type), 0);
+
+		return $stringType ? strtolower($stringType) : null;
+	}
+
+	/**
+	 * Check if the phone number is of (a) given type(s).
+	 *
+	 * @param string $type
+	 * @return bool
+	 */
+	public function isOfType($type)
+	{
+		$types = static::parseTypes($type);
+
+		// Add the unsure type when applicable.
+		if (array_intersect([PhoneNumberType::FIXED_LINE, PhoneNumberType::MOBILE], $types)) {
+			$types[] = PhoneNumberType::FIXED_LINE_OR_MOBILE;
+		}
+
+		return in_array($this->getType(true), $types, true);
+	}
+
+	/**
+	 * Get the PhoneNumber instance of the current number.
+	 *
+	 * @return \libphonenumber\PhoneNumber
+	 */
+	public function getPhoneNumberInstance()
+	{
+		return $this->lib->parse($this->number, $this->getCountry());
+	}
+
+	/**
+	 * Determine whether the phone number seems to be in international format.
+	 *
+	 * @return bool
+	 */
+	protected function numberLooksInternational()
+	{
+		return Str::startsWith($this->number, '+');
+	}
+
+	/**
+	 * Enable lenient number parsing.
+	 *
+	 * @return $this
+	 */
+	public function lenient()
+	{
+		$this->lenient = true;
+
+		return $this;
+	}
+
+	/**
+	 * Convert the phone instance to JSON.
+	 *
+	 * @param  int $options
+	 * @return string
+	 */
+	public function toJson($options = 0)
+	{
+		return json_encode($this->jsonSerialize(), $options);
+	}
+
+	/**
+	 * Convert the phone instance into something JSON serializable.
+	 *
+	 * @return string
+	 */
+	public function jsonSerialize()
+	{
+		return $this->formatE164();
+	}
+
+	/**
+	 * Convert the phone instance into a string representation.
+	 *
+	 * @return string
+	 */
+	public function serialize()
+	{
+		return $this->formatE164();
+	}
+
+	/**
+	 * Reconstructs the phone instance from a string representation.
+	 *
+	 * @param string $serialized
+	 */
+	public function unserialize($serialized)
+	{
+		$this->lib = PhoneNumberUtil::getInstance();
+		$this->number = $serialized;
+		$this->country = $this->lib->getRegionCodeForNumber($this->getPhoneNumberInstance());
+	}
+
+	/**
+	 * Convert the phone instance to a formatted number.
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		// Formatting the phone number could throw an exception, but __toString() doesn't cope well with that.
+		// Let's just return the original number in that case.
+		try {
+			return $this->formatE164();
+		} catch (Exception $exception) {
+			return $this->number;
+		}
+	}
 }
\ No newline at end of file