PhoneNumber::getCountryCodeSource() - Code Metrics - Inspection of "Upstream metadata changes from Google for v8.9.2" - giggsey/libphonenumber-for-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — upstream-8.9.2 ( 6a22e8 )

by Joshua

created 2018-03-14 10:44 UTC

PhoneNumber::getCountryCodeSource() A

↳ Parent: PhoneNumber

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace libphonenumber;

class PhoneNumber implements \Serializable
{
    /**
     * The country calling code for this number, as defined by the International Telecommunication Union
     * (ITU). For example, this would be 1 for NANPA countries, and 33 for France.
     *
     * @var int|null
     */
    protected $countryCode = null;
    /**
     * National (significant) Number is defined in International Telecommunication Union (ITU)
     * Recommendation E.164. It is a language/country-neutral representation of a phone number at a
     * country level. For countries which have the concept of an "area code" or "national destination
     * code", this is included in the National (significant) Number. Although the ITU says the maximum
     * length should be 15, we have found longer numbers in some countries e.g. Germany.
     *
     * Note that the National (significant) Number does not contain the National(trunk) prefix.
     *
     * @var string|null
     */
    protected $nationalNumber = null;
    /**
     * Extension is not standardized in ITU recommendations, except for being defined as a series of
     * numbers with a maximum length of 40 digits. It is defined as a string here to accommodate for the
     * possible use of a leading zero in the extension (organizations have complete freedom to do so,
     * as there is no standard defined). However, only ASCII digits should be stored here.
     *
     * @var string|null
     */
    protected $extension = null;
    /**
     * In some countries, the national (significant) number starts with one or more "0"s without this
     * being a national prefix or trunk code of some kind. For example, the leading zero in the national
     * (significant) number of an Italian phone number indicates the number is a fixed-line number.
     * There have been plans to migrate fixed-line numbers to start with the digit two since December
     * 2000, but it has not happened yet. See http://en.wikipedia.org/wiki/%2B39 for more details.
     *
     * These fields can be safely ignored (there is no need to set them) for most countries. Some
     * limited number of countries behave like Italy - for these cases, if the leading zero(s) of a
     * number would be retained even when dialling internationally, set this flag to true, and also
     * set the number of leading zeros.
     *
     * Clients who use the parsing functionality of the i18n phone number libraries
     * will have these fields set if necessary automatically.
     *
     * @var bool|null
     */
    protected $italianLeadingZero = null;
    /**
     * This field is used to store the raw input string containing phone numbers before it was
     * canonicalized by the library. For example, it could be used to store alphanumerical numbers
     * such as "1-800-GOOG-411".
     *
     * @var string|null
     */
    protected $rawInput = null;
    /**
     * The source from which the country_code is derived. This is not set in the general parsing method,
     * but in the method that parses and keeps raw_input. New fields could be added upon request.
     *
     * @see CountryCodeSource
     *
     * This must be one of the CountryCodeSource constants.
     *
     * @var int|null
     */
    protected $countryCodeSource = CountryCodeSource::UNSPECIFIED;
    /**
     * The carrier selection code that is preferred when calling this phone number domestically. This
     * also includes codes that need to be dialed in some countries when calling from landlines to
     * mobiles or vice versa. For example, in Columbia, a "3" needs to be dialed before the phone number
     * itself when calling from a mobile phone to a domestic landline phone and vice versa.
     *
     * Note this is the "preferred" code, which means other codes may work as well.
     *
     * @var string|null
     */
    protected $preferredDomesticCarrierCode = null;
    /**
     * Whether this phone number has a number of leading zeros set.
     *
     * @var bool
     */
    protected $hasNumberOfLeadingZeros = false;
    /**
     * The number of leading zeros of this phone number.
     *
     * @var int
     */
    protected $numberOfLeadingZeros = 1;

    /**
     * Clears this phone number.
     *
     * This effectively resets this phone number to the state of a new instance.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clear()
    {
        $this->clearCountryCode();
        $this->clearNationalNumber();
        $this->clearExtension();
        $this->clearItalianLeadingZero();
        $this->clearNumberOfLeadingZeros();
        $this->clearRawInput();
        $this->clearCountryCodeSource();
        $this->clearPreferredDomesticCarrierCode();
        return $this;
    }

    /**
     * Clears the country code of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearCountryCode()
    {
        $this->countryCode = null;
        return $this;
    }

    /**
     * Clears the national number of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearNationalNumber()
    {
        $this->nationalNumber = null;
        return $this;
    }

    /**
     * Clears the extension of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearExtension()
    {
        $this->extension = null;
        return $this;
    }

    /**
     * Clears the italian leading zero information of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearItalianLeadingZero()
    {
        $this->italianLeadingZero = null;
        return $this;
    }

    /**
     * Clears the number of leading zeros of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearNumberOfLeadingZeros()
    {
        $this->hasNumberOfLeadingZeros = false;
        $this->numberOfLeadingZeros = 1;
        return $this;
    }

    /**
     * Clears the raw input of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearRawInput()
    {
        $this->rawInput = null;
        return $this;
    }

    /**
     * Clears the country code source of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearCountryCodeSource()
    {
        $this->countryCodeSource = CountryCodeSource::UNSPECIFIED;
        return $this;
    }

    /**
     * Clears the preferred domestic carrier code of this phone number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function clearPreferredDomesticCarrierCode()
    {
        $this->preferredDomesticCarrierCode = null;
        return $this;
    }

    /**
     * Merges the information from another phone number into this phone number.
     *
     * @param PhoneNumber $other The phone number to copy.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function mergeFrom(PhoneNumber $other)
    {
        if ($other->hasCountryCode()) {
            $this->setCountryCode($other->getCountryCode());
        }
        if ($other->hasNationalNumber()) {
            $this->setNationalNumber($other->getNationalNumber());
        }
        if ($other->hasExtension()) {
            $this->setExtension($other->getExtension());
        }
        if ($other->hasItalianLeadingZero()) {
            $this->setItalianLeadingZero($other->isItalianLeadingZero());
        }
        if ($other->hasNumberOfLeadingZeros()) {
            $this->setNumberOfLeadingZeros($other->getNumberOfLeadingZeros());
        }
        if ($other->hasRawInput()) {
            $this->setRawInput($other->getRawInput());
        }
        if ($other->hasCountryCodeSource()) {
            $this->setCountryCodeSource($other->getCountryCodeSource());
        }
        if ($other->hasPreferredDomesticCarrierCode()) {
            $this->setPreferredDomesticCarrierCode($other->getPreferredDomesticCarrierCode());
        }
        return $this;
    }

    /**
     * Returns whether this phone number has a country code set.
     *
     * @return bool True if a country code is set, false otherwise.
     */
    public function hasCountryCode()
    {
        return isset($this->countryCode);
    }

    /**
     * Returns the country code of this phone number.
     *
     * @return int|null The country code, or null if not set.
     */
    public function getCountryCode()
    {
        return $this->countryCode;
    }

    /**
     * Sets the country code of this phone number.
     *
     * @param int $value The country code.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setCountryCode($value)
    {
        $this->countryCode = (int) $value;
        return $this;
    }

    /**
     * Returns whether this phone number has a national number set.
     *
     * @return bool True if a national number is set, false otherwise.
     */
    public function hasNationalNumber()
    {
        return isset($this->nationalNumber);
    }

    /**
     * Returns the country code of this phone number.
     *
     * @return string|null The national number, or null if not set.
     */
    public function getNationalNumber()
    {
        return $this->nationalNumber;
    }

    /**
     * Sets the national number of this phone number.
     *
     * @param string $value The national number.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setNationalNumber($value)
    {
        $this->nationalNumber = (string) $value;
        return $this;
    }

    /**
     * Returns whether this phone number has an extension set.
     *
     * @return bool True if an extension is set, false otherwise.
     */
    public function hasExtension()
    {
        return isset($this->extension);
    }

    /**
     * Returns the extension of this phone number.
     *
     * @return string|null The extension, or null if not set.
     */
    public function getExtension()
    {
        return $this->extension;
    }

    /**
     * Sets the extension of this phone number.
     *
     * @param string $value The extension.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setExtension($value)
    {
        $this->extension = (string) $value;
        return $this;
    }

    /**
     * Returns whether this phone number has the italian leading zero information set.
     *
     * @return bool
     */
    public function hasItalianLeadingZero()
    {
        return isset($this->italianLeadingZero);
    }

    /**
     * Sets whether this phone number uses an italian leading zero.
     *
     * @param bool $value True to use italian leading zero, false otherwise.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setItalianLeadingZero($value)
    {
        $this->italianLeadingZero = (bool) $value;
        return $this;
    }

    /**
     * Returns whether this phone number uses an italian leading zero.
     *
     * @return bool|null True if it uses an italian leading zero, false it it does not, null if not set.
     */
    public function isItalianLeadingZero()
    {
        return $this->italianLeadingZero;
    }

    /**
     * Returns whether this phone number has a number of leading zeros set.
     *
     * @return bool True if a number of leading zeros is set, false otherwise.
     */
    public function hasNumberOfLeadingZeros()
    {
        return $this->hasNumberOfLeadingZeros;
    }

    /**
     * Returns the number of leading zeros of this phone number.
     *
     * @return int The number of leading zeros.
     */
    public function getNumberOfLeadingZeros()
    {
        return $this->numberOfLeadingZeros;
    }

    /**
     * Sets the number of leading zeros of this phone number.
     *
     * @param int $value The number of leading zeros.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setNumberOfLeadingZeros($value)
    {
        $this->hasNumberOfLeadingZeros = true;
        $this->numberOfLeadingZeros = (int) $value;
        return $this;
    }

    /**
     * Returns whether this phone number has a raw input.
     *
     * @return bool True if a raw input is set, false otherwise.
     */
    public function hasRawInput()
    {
        return isset($this->rawInput);
    }

    /**
     * Returns the raw input of this phone number.
     *
     * @return string|null The raw input, or null if not set.
     */
    public function getRawInput()
    {
        return $this->rawInput;
    }

    /**
     * Sets the raw input of this phone number.
     *
     * @param string $value The raw input.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setRawInput($value)
    {
        $this->rawInput = (string) $value;
        return $this;
    }

    /**
     * Returns whether this phone number has a country code source.
     *
     * @return bool True if a country code source is set, false otherwise.
     */
    public function hasCountryCodeSource()
    {
        return $this->countryCodeSource !== CountryCodeSource::UNSPECIFIED;
    }

    /**
     * Returns the country code source of this phone number.
     *
     * @return int|null A CountryCodeSource constant, or null if not set.
     */
    public function getCountryCodeSource()
    {
        return $this->countryCodeSource;
    }

    /**
     * Sets the country code source of this phone number.
     *
     * @param int $value A CountryCodeSource constant.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setCountryCodeSource($value)
    {
        $this->countryCodeSource = (int) $value;
        return $this;
    }

    /**
     * Returns whether this phone number has a preferred domestic carrier code.
     *
     * @return bool True if a preferred domestic carrier code is set, false otherwise.
     */
    public function hasPreferredDomesticCarrierCode()
    {
        return isset($this->preferredDomesticCarrierCode);
    }

    /**
     * Returns the preferred domestic carrier code of this phone number.
     *
     * @return string|null The preferred domestic carrier code, or null if not set.
     */
    public function getPreferredDomesticCarrierCode()
    {
        return $this->preferredDomesticCarrierCode;
    }

    /**
     * Sets the preferred domestic carrier code of this phone number.
     *
     * @param string $value The preferred domestic carrier code.
     *
     * @return PhoneNumber This PhoneNumber instance, for chaining method calls.
     */
    public function setPreferredDomesticCarrierCode($value)
    {
        $this->preferredDomesticCarrierCode = (string) $value;
        return $this;
    }

    /**
     * Returns whether this phone number is equal to another.
     *
     * @param PhoneNumber $other The phone number to compare.
     *
     * @return bool True if the phone numbers are equal, false otherwise.
     */
    public function equals(PhoneNumber $other)
    {
        $sameType = get_class($other) == get_class($this);
        $sameCountry = $this->hasCountryCode() == $other->hasCountryCode() &&
            (!$this->hasCountryCode() || $this->getCountryCode() == $other->getCountryCode());
        $sameNational = $this->hasNationalNumber() == $other->hasNationalNumber() &&
            (!$this->hasNationalNumber() || $this->getNationalNumber() == $other->getNationalNumber());
        $sameExt = $this->hasExtension() == $other->hasExtension() &&
            (!$this->hasExtension() || $this->hasExtension() == $other->hasExtension());
        $sameLead = $this->hasItalianLeadingZero() == $other->hasItalianLeadingZero() &&
            (!$this->hasItalianLeadingZero() || $this->isItalianLeadingZero() == $other->isItalianLeadingZero());
        $sameZeros = $this->getNumberOfLeadingZeros() == $other->getNumberOfLeadingZeros();
        $sameRaw = $this->hasRawInput() == $other->hasRawInput() &&
            (!$this->hasRawInput() || $this->getRawInput() == $other->getRawInput());
        $sameCountrySource = $this->hasCountryCodeSource() == $other->hasCountryCodeSource() &&
            (!$this->hasCountryCodeSource() || $this->getCountryCodeSource() == $other->getCountryCodeSource());
        $samePrefCar = $this->hasPreferredDomesticCarrierCode() == $other->hasPreferredDomesticCarrierCode() &&
            (!$this->hasPreferredDomesticCarrierCode() || $this->getPreferredDomesticCarrierCode(
                ) == $other->getPreferredDomesticCarrierCode());
        return $sameType && $sameCountry && $sameNational && $sameExt && $sameLead && $sameZeros && $sameRaw && $sameCountrySource && $samePrefCar;
    }

    /**
     * Returns a string representation of this phone number.
     * @return string
     */
    public function __toString()
    {
        $outputString = '';

        $outputString .= 'Country Code: ' . $this->countryCode;
        $outputString .= ' National Number: ' . $this->nationalNumber;
        if ($this->hasItalianLeadingZero()) {
            $outputString .= ' Leading Zero(s): true';
        }
        if ($this->hasNumberOfLeadingZeros()) {
            $outputString .= ' Number of leading zeros: ' . $this->numberOfLeadingZeros;
        }
        if ($this->hasExtension()) {
            $outputString .= ' Extension: ' . $this->extension;
        }
        if ($this->hasCountryCodeSource()) {
            $outputString .= ' Country Code Source: ' . $this->countryCodeSource;
        }
        if ($this->hasPreferredDomesticCarrierCode()) {
            $outputString .= ' Preferred Domestic Carrier Code: ' . $this->preferredDomesticCarrierCode;
        }
        return $outputString;
    }

    /**
     * @inheritDoc
     */
    public function serialize()
    {
        return serialize(
            array(
                $this->countryCode,
                $this->nationalNumber,
                $this->extension,
                $this->italianLeadingZero,
                $this->numberOfLeadingZeros,
                $this->rawInput,
                $this->countryCodeSource,
                $this->preferredDomesticCarrierCode
            )
        );
    }

    /**
     * @inheritDoc
     */
    public function unserialize($serialized)
    {
        $data = unserialize($serialized);

        list(
            $this->countryCode,
            $this->nationalNumber,
            $this->extension,
            $this->italianLeadingZero,
            $this->numberOfLeadingZeros,
            $this->rawInput,
            $this->countryCodeSource,
            $this->preferredDomesticCarrierCode
        ) = $data;

        if ($this->numberOfLeadingZeros > 1) {
            $this->hasNumberOfLeadingZeros = true;
        }
    }
}


1		<?php
2
3		namespace libphonenumber;
4
5		class PhoneNumber implements \Serializable
6		{
7		/**
8		* The country calling code for this number, as defined by the International Telecommunication Union
9		* (ITU). For example, this would be 1 for NANPA countries, and 33 for France.
10		*
11		* @var int\|null
12		*/
13		protected $countryCode = null;
14		/**
15		* National (significant) Number is defined in International Telecommunication Union (ITU)
16		* Recommendation E.164. It is a language/country-neutral representation of a phone number at a
17		* country level. For countries which have the concept of an "area code" or "national destination
18		* code", this is included in the National (significant) Number. Although the ITU says the maximum
19		* length should be 15, we have found longer numbers in some countries e.g. Germany.
20		*
21		* Note that the National (significant) Number does not contain the National(trunk) prefix.
22		*
23		* @var string\|null
24		*/
25		protected $nationalNumber = null;
26		/**
27		* Extension is not standardized in ITU recommendations, except for being defined as a series of
28		* numbers with a maximum length of 40 digits. It is defined as a string here to accommodate for the
29		* possible use of a leading zero in the extension (organizations have complete freedom to do so,
30		* as there is no standard defined). However, only ASCII digits should be stored here.
31		*
32		* @var string\|null
33		*/
34		protected $extension = null;
35		/**
36		* In some countries, the national (significant) number starts with one or more "0"s without this
37		* being a national prefix or trunk code of some kind. For example, the leading zero in the national
38		* (significant) number of an Italian phone number indicates the number is a fixed-line number.
39		* There have been plans to migrate fixed-line numbers to start with the digit two since December
40		* 2000, but it has not happened yet. See http://en.wikipedia.org/wiki/%2B39 for more details.
41		*
42		* These fields can be safely ignored (there is no need to set them) for most countries. Some
43		* limited number of countries behave like Italy - for these cases, if the leading zero(s) of a
44		* number would be retained even when dialling internationally, set this flag to true, and also
45		* set the number of leading zeros.
46		*
47		* Clients who use the parsing functionality of the i18n phone number libraries
48		* will have these fields set if necessary automatically.
49		*
50		* @var bool\|null
51		*/
52		protected $italianLeadingZero = null;
53		/**
54		* This field is used to store the raw input string containing phone numbers before it was
55		* canonicalized by the library. For example, it could be used to store alphanumerical numbers
56		* such as "1-800-GOOG-411".
57		*
58		* @var string\|null
59		*/
60		protected $rawInput = null;
61		/**
62		* The source from which the country_code is derived. This is not set in the general parsing method,
63		* but in the method that parses and keeps raw_input. New fields could be added upon request.
64		*
65		* @see CountryCodeSource
66		*
67		* This must be one of the CountryCodeSource constants.
68		*
69		* @var int\|null
70		*/
71		protected $countryCodeSource = CountryCodeSource::UNSPECIFIED;
72		/**
73		* The carrier selection code that is preferred when calling this phone number domestically. This
74		* also includes codes that need to be dialed in some countries when calling from landlines to
75		* mobiles or vice versa. For example, in Columbia, a "3" needs to be dialed before the phone number
76		* itself when calling from a mobile phone to a domestic landline phone and vice versa.
77		*
78		* Note this is the "preferred" code, which means other codes may work as well.
79		*
80		* @var string\|null
81		*/
82		protected $preferredDomesticCarrierCode = null;
83		/**
84		* Whether this phone number has a number of leading zeros set.
85		*
86		* @var bool
87		*/
88		protected $hasNumberOfLeadingZeros = false;
89		/**
90		* The number of leading zeros of this phone number.
91		*
92		* @var int
93		*/
94		protected $numberOfLeadingZeros = 1;
95
96		/**
97		* Clears this phone number.
98		*
99		* This effectively resets this phone number to the state of a new instance.
100		*
101		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
102		*/
103	12	public function clear()
104		{
105	12	$this->clearCountryCode();
106	12	$this->clearNationalNumber();
107	12	$this->clearExtension();
108	12	$this->clearItalianLeadingZero();
109	12	$this->clearNumberOfLeadingZeros();
110	12	$this->clearRawInput();
111	12	$this->clearCountryCodeSource();
112	12	$this->clearPreferredDomesticCarrierCode();
113	12	return $this;
114		}
115
116		/**
117		* Clears the country code of this phone number.
118		*
119		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
120		*/
121	12	public function clearCountryCode()
122		{
123	12	$this->countryCode = null;
124	12	return $this;
125		}
126
127		/**
128		* Clears the national number of this phone number.
129		*
130		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
131		*/
132	12	public function clearNationalNumber()
133		{
134	12	$this->nationalNumber = null;
135	12	return $this;
136		}
137
138		/**
139		* Clears the extension of this phone number.
140		*
141		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
142		*/
143	13	public function clearExtension()
144		{
145	13	$this->extension = null;
146	13	return $this;
147		}
148
149		/**
150		* Clears the italian leading zero information of this phone number.
151		*
152		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
153		*/
154	13	public function clearItalianLeadingZero()
155		{
156	13	$this->italianLeadingZero = null;
157	13	return $this;
158		}
159
160		/**
161		* Clears the number of leading zeros of this phone number.
162		*
163		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
164		*/
165	12	public function clearNumberOfLeadingZeros()
166		{
167	12	$this->hasNumberOfLeadingZeros = false;
168	12	$this->numberOfLeadingZeros = 1;
169	12	return $this;
170		}
171
172		/**
173		* Clears the raw input of this phone number.
174		*
175		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
176		*/
177	139	public function clearRawInput()
178		{
179	139	$this->rawInput = null;
180	139	return $this;
181		}
182
183		/**
184		* Clears the country code source of this phone number.
185		*
186		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
187		*/
188	138	public function clearCountryCodeSource()
189		{
190	138	$this->countryCodeSource = CountryCodeSource::UNSPECIFIED;
191	138	return $this;
192		}
193
194		/**
195		* Clears the preferred domestic carrier code of this phone number.
196		*
197		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
198		*/
199	138	public function clearPreferredDomesticCarrierCode()
200		{
201	138	$this->preferredDomesticCarrierCode = null;
202	138	return $this;
203		}
204
205		/**
206		* Merges the information from another phone number into this phone number.
207		*
208		* @param PhoneNumber $other The phone number to copy.
209		*
210		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
211		*/
212	9	public function mergeFrom(PhoneNumber $other)
213		{
214	9	if ($other->hasCountryCode()) {
215	9	$this->setCountryCode($other->getCountryCode());
216		}
217	9	if ($other->hasNationalNumber()) {
218	9	$this->setNationalNumber($other->getNationalNumber());
219		}
220	9	if ($other->hasExtension()) {
221	1	$this->setExtension($other->getExtension());
222		}
223	9	if ($other->hasItalianLeadingZero()) {
224	2	$this->setItalianLeadingZero($other->isItalianLeadingZero());
225		}
226	9	if ($other->hasNumberOfLeadingZeros()) {
227	1	$this->setNumberOfLeadingZeros($other->getNumberOfLeadingZeros());
228		}
229	9	if ($other->hasRawInput()) {
230		$this->setRawInput($other->getRawInput());
231		}
232	9	if ($other->hasCountryCodeSource()) {
233		$this->setCountryCodeSource($other->getCountryCodeSource());
234		}
235	9	if ($other->hasPreferredDomesticCarrierCode()) {
236		$this->setPreferredDomesticCarrierCode($other->getPreferredDomesticCarrierCode());
237		}
238	9	return $this;
239		}
240
241		/**
242		* Returns whether this phone number has a country code set.
243		*
244		* @return bool True if a country code is set, false otherwise.
245		*/
246	20	public function hasCountryCode()
247		{
248	20	return isset($this->countryCode);
249		}
250
251		/**
252		* Returns the country code of this phone number.
253		*
254		* @return int\|null The country code, or null if not set.
255		*/
256	3142	public function getCountryCode()
257		{
258	3142	return $this->countryCode;
259		}
260
261		/**
262		* Sets the country code of this phone number.
263		*
264		* @param int $value The country code.
265		*
266		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
267		*/
268	3182	public function setCountryCode($value)
269		{
270	3182	$this->countryCode = (int) $value;
271	3182	return $this;
272		}
273
274		/**
275		* Returns whether this phone number has a national number set.
276		*
277		* @return bool True if a national number is set, false otherwise.
278		*/
279	20	public function hasNationalNumber()
280		{
281	20	return isset($this->nationalNumber);
282		}
283
284		/**
285		* Returns the country code of this phone number.
286		*
287		* @return string\|null The national number, or null if not set.
288		*/
289	2952	public function getNationalNumber()
290		{
291	2952	return $this->nationalNumber;
292		}
293
294		/**
295		* Sets the national number of this phone number.
296		*
297		* @param string $value The national number.
298		*
299		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
300		*/
301	3179	public function setNationalNumber($value)
302		{
303	3179	$this->nationalNumber = (string) $value;
304	3179	return $this;
305		}
306
307		/**
308		* Returns whether this phone number has an extension set.
309		*
310		* @return bool True if an extension is set, false otherwise.
311		*/
312	1767	public function hasExtension()
313		{
314	1767	return isset($this->extension);
315		}
316
317		/**
318		* Returns the extension of this phone number.
319		*
320		* @return string\|null The extension, or null if not set.
321		*/
322	27	public function getExtension()
323		{
324	27	return $this->extension;
325		}
326
327		/**
328		* Sets the extension of this phone number.
329		*
330		* @param string $value The extension.
331		*
332		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
333		*/
334	33	public function setExtension($value)
335		{
336	33	$this->extension = (string) $value;
337	33	return $this;
338		}
339
340		/**
341		* Returns whether this phone number has the italian leading zero information set.
342		*
343		* @return bool
344		*/
345	1674	public function hasItalianLeadingZero()
346		{
347	1674	return isset($this->italianLeadingZero);
348		}
349
350		/**
351		* Sets whether this phone number uses an italian leading zero.
352		*
353		* @param bool $value True to use italian leading zero, false otherwise.
354		*
355		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
356		*/
357	198	public function setItalianLeadingZero($value)
358		{
359	198	$this->italianLeadingZero = (bool) $value;
360	198	return $this;
361		}
362
363		/**
364		* Returns whether this phone number uses an italian leading zero.
365		*
366		* @return bool\|null True if it uses an italian leading zero, false it it does not, null if not set.
367		*/
368	2945	public function isItalianLeadingZero()
369		{
370	2945	return $this->italianLeadingZero;
371		}
372
373		/**
374		* Returns whether this phone number has a number of leading zeros set.
375		*
376		* @return bool True if a number of leading zeros is set, false otherwise.
377		*/
378	1663	public function hasNumberOfLeadingZeros()
379		{
380	1663	return $this->hasNumberOfLeadingZeros;
381		}
382
383		/**
384		* Returns the number of leading zeros of this phone number.
385		*
386		* @return int The number of leading zeros.
387		*/
388	110	public function getNumberOfLeadingZeros()
389		{
390	110	return $this->numberOfLeadingZeros;
391		}
392
393		/**
394		* Sets the number of leading zeros of this phone number.
395		*
396		* @param int $value The number of leading zeros.
397		*
398		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
399		*/
400	19	public function setNumberOfLeadingZeros($value)
401		{
402	19	$this->hasNumberOfLeadingZeros = true;
403	19	$this->numberOfLeadingZeros = (int) $value;
404	19	return $this;
405		}
406
407		/**
408		* Returns whether this phone number has a raw input.
409		*
410		* @return bool True if a raw input is set, false otherwise.
411		*/
412	22	public function hasRawInput()
413		{
414	22	return isset($this->rawInput);
415		}
416
417		/**
418		* Returns the raw input of this phone number.
419		*
420		* @return string\|null The raw input, or null if not set.
421		*/
422	39	public function getRawInput()
423		{
424	39	return $this->rawInput;
425		}
426
427		/**
428		* Sets the raw input of this phone number.
429		*
430		* @param string $value The raw input.
431		*
432		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
433		*/
434	289	public function setRawInput($value)
435		{
436	289	$this->rawInput = (string) $value;
437	289	return $this;
438		}
439
440		/**
441		* Returns whether this phone number has a country code source.
442		*
443		* @return bool True if a country code source is set, false otherwise.
444		*/
445	1677	public function hasCountryCodeSource()
446		{
447	1677	return $this->countryCodeSource !== CountryCodeSource::UNSPECIFIED;
448		}
449
450		/**
451		* Returns the country code source of this phone number.
452		*
453		* @return int\|null A CountryCodeSource constant, or null if not set.
454		*/
455	103	public function getCountryCodeSource()
456		{
457	103	return $this->countryCodeSource;
458		}
459
460		/**
461		* Sets the country code source of this phone number.
462		*
463		* @param int $value A CountryCodeSource constant.
464		*
465		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
466		*/
467	184	public function setCountryCodeSource($value)
468		{
469	184	$this->countryCodeSource = (int) $value;
470	184	return $this;
471		}
472
473		/**
474		* Returns whether this phone number has a preferred domestic carrier code.
475		*
476		* @return bool True if a preferred domestic carrier code is set, false otherwise.
477		*/
478	1674	public function hasPreferredDomesticCarrierCode()
479		{
480	1674	return isset($this->preferredDomesticCarrierCode);
481		}
482
483		/**
484		* Returns the preferred domestic carrier code of this phone number.
485		*
486		* @return string\|null The preferred domestic carrier code, or null if not set.
487		*/
488	2	public function getPreferredDomesticCarrierCode()
489		{
490	2	return $this->preferredDomesticCarrierCode;
491		}
492
493		/**
494		* Sets the preferred domestic carrier code of this phone number.
495		*
496		* @param string $value The preferred domestic carrier code.
497		*
498		* @return PhoneNumber This PhoneNumber instance, for chaining method calls.
499		*/
500	6	public function setPreferredDomesticCarrierCode($value)
501		{
502	6	$this->preferredDomesticCarrierCode = (string) $value;
503	6	return $this;
504		}
505
506		/**
507		* Returns whether this phone number is equal to another.
508		*
509		* @param PhoneNumber $other The phone number to compare.
510		*
511		* @return bool True if the phone numbers are equal, false otherwise.
512		*/
513	13	public function equals(PhoneNumber $other)
514		{
515	13	$sameType = get_class($other) == get_class($this);
516	13	$sameCountry = $this->hasCountryCode() == $other->hasCountryCode() &&
517	13	(!$this->hasCountryCode() \|\| $this->getCountryCode() == $other->getCountryCode());
518	13	$sameNational = $this->hasNationalNumber() == $other->hasNationalNumber() &&
519	13	(!$this->hasNationalNumber() \|\| $this->getNationalNumber() == $other->getNationalNumber());
520	13	$sameExt = $this->hasExtension() == $other->hasExtension() &&
521	13	(!$this->hasExtension() \|\| $this->hasExtension() == $other->hasExtension());
522	13	$sameLead = $this->hasItalianLeadingZero() == $other->hasItalianLeadingZero() &&
523	13	(!$this->hasItalianLeadingZero() \|\| $this->isItalianLeadingZero() == $other->isItalianLeadingZero());
524	13	$sameZeros = $this->getNumberOfLeadingZeros() == $other->getNumberOfLeadingZeros();
525	13	$sameRaw = $this->hasRawInput() == $other->hasRawInput() &&
526	13	(!$this->hasRawInput() \|\| $this->getRawInput() == $other->getRawInput());
527	13	$sameCountrySource = $this->hasCountryCodeSource() == $other->hasCountryCodeSource() &&
528	13	(!$this->hasCountryCodeSource() \|\| $this->getCountryCodeSource() == $other->getCountryCodeSource());
529	13	$samePrefCar = $this->hasPreferredDomesticCarrierCode() == $other->hasPreferredDomesticCarrierCode() &&
530	12	(!$this->hasPreferredDomesticCarrierCode() \|\| $this->getPreferredDomesticCarrierCode(
531	13	) == $other->getPreferredDomesticCarrierCode());
532	13	return $sameType && $sameCountry && $sameNational && $sameExt && $sameLead && $sameZeros && $sameRaw && $sameCountrySource && $samePrefCar;
533		}
534
535		/**
536		* Returns a string representation of this phone number.
537		* @return string
538		*/
539	1655	public function __toString()
540		{
541	1655	$outputString = '';
542
543	1655	$outputString .= 'Country Code: ' . $this->countryCode;
544	1655	$outputString .= ' National Number: ' . $this->nationalNumber;
545	1655	if ($this->hasItalianLeadingZero()) {
546	24	$outputString .= ' Leading Zero(s): true';
547		}
548	1655	if ($this->hasNumberOfLeadingZeros()) {
549		$outputString .= ' Number of leading zeros: ' . $this->numberOfLeadingZeros;
550		}
551	1655	if ($this->hasExtension()) {
552	1	$outputString .= ' Extension: ' . $this->extension;
553		}
554	1655	if ($this->hasCountryCodeSource()) {
555		$outputString .= ' Country Code Source: ' . $this->countryCodeSource;
556		}
557	1655	if ($this->hasPreferredDomesticCarrierCode()) {
558		$outputString .= ' Preferred Domestic Carrier Code: ' . $this->preferredDomesticCarrierCode;
559		}
560	1655	return $outputString;
561		}
562
563		/**
564		* @inheritDoc
565		*/
566	3	public function serialize()
567		{
568	3	return serialize(
569		array(
570	3	$this->countryCode,
571	3	$this->nationalNumber,
572	3	$this->extension,
573	3	$this->italianLeadingZero,
574	3	$this->numberOfLeadingZeros,
575	3	$this->rawInput,
576	3	$this->countryCodeSource,
577	3	$this->preferredDomesticCarrierCode
578		)
579		);
580		}
581
582		/**
583		* @inheritDoc
584		*/
585	3	public function unserialize($serialized)
586		{
587	3	$data = unserialize($serialized);
588
589		list(
590	3	$this->countryCode,
591	3	$this->nationalNumber,
592	3	$this->extension,
593	3	$this->italianLeadingZero,
594	3	$this->numberOfLeadingZeros,
595	3	$this->rawInput,
596	3	$this->countryCodeSource,
597	3	$this->preferredDomesticCarrierCode
598	3	) = $data;
599
600	3	if ($this->numberOfLeadingZeros > 1) {
601		$this->hasNumberOfLeadingZeros = true;
602		}
603	3	}
604		}
605

giggsey / libphonenumber-for-php

Push — upstream-8.9.2 ( 6a22e8 )

PhoneNumber::getCountryCodeSource() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like