• Home
• libphonenumber
• PhoneNumber

PHP Class libphonenumber\PhoneNumber

Show file Open project: giggsey/libphonenumber-for-php Class Usage Examples

Protected Properties

Property	Type	Description
$countryCode	integer | null	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.
$countryCodeSource	integer | 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.
$extension	string | 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.
$hasNumberOfLeadingZeros	boolean	Whether this phone number has a number of leading zeros set.
$italianLeadingZero	boolean | null	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.
$nationalNumber	string | null	Note that the National (significant) Number does not contain the National(trunk) prefix.
$numberOfLeadingZeros	integer	The number of leading zeros of this phone number.
$preferredDomesticCarrierCode	string | null	Note this is the "preferred" code, which means other codes may work as well.
$rawInput	string | 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".

Public Methods

Method	Description
__toString ( ) : string	Returns a string representation of this phone number.
clear ( ) : PhoneNumber	Clears this phone number.
clearCountryCode ( ) : PhoneNumber	Clears the country code of this phone number.
clearCountryCodeSource ( ) : PhoneNumber	Clears the country code source of this phone number.
clearExtension ( ) : PhoneNumber	Clears the extension of this phone number.
clearItalianLeadingZero ( ) : PhoneNumber	Clears the italian leading zero information of this phone number.
clearNationalNumber ( ) : PhoneNumber	Clears the national number of this phone number.
clearNumberOfLeadingZeros ( ) : PhoneNumber	Clears the number of leading zeros of this phone number.
clearPreferredDomesticCarrierCode ( ) : PhoneNumber	Clears the preferred domestic carrier code of this phone number.
clearRawInput ( ) : PhoneNumber	Clears the raw input of this phone number.
equals ( PhoneNumber $other ) : boolean	Returns whether this phone number is equal to another.
getCountryCode ( ) : integer | null	Returns the country code of this phone number.
getCountryCodeSource ( ) : integer | null	Returns the country code source of this phone number.
getExtension ( ) : string | null	Returns the extension of this phone number.
getNationalNumber ( ) : string | null	Returns the country code of this phone number.
getNumberOfLeadingZeros ( ) : integer	Returns the number of leading zeros of this phone number.
getPreferredDomesticCarrierCode ( ) : string | null	Returns the preferred domestic carrier code of this phone number.
getRawInput ( ) : string | null	Returns the raw input of this phone number.
hasCountryCode ( ) : boolean	Returns whether this phone number has a country code set.
hasCountryCodeSource ( ) : boolean	Returns whether this phone number has a country code source.
hasExtension ( ) : boolean	Returns whether this phone number has an extension set.
hasItalianLeadingZero ( ) : boolean	Returns whether this phone number has the italian leading zero information set.
hasNationalNumber ( ) : boolean	Returns whether this phone number has a national number set.
hasNumberOfLeadingZeros ( ) : boolean	Returns whether this phone number has a number of leading zeros set.
hasPreferredDomesticCarrierCode ( ) : boolean	Returns whether this phone number has a preferred domestic carrier code.
hasRawInput ( ) : boolean	Returns whether this phone number has a raw input.
isItalianLeadingZero ( ) : boolean | null	Returns whether this phone number uses an italian leading zero.
mergeFrom ( PhoneNumber $other ) : PhoneNumber	Merges the information from another phone number into this phone number.
serialize ( )
setCountryCode ( integer $value ) : PhoneNumber	Sets the country code of this phone number.
setCountryCodeSource ( integer $value ) : PhoneNumber	Sets the country code source of this phone number.
setExtension ( string $value ) : PhoneNumber	Sets the extension of this phone number.
setItalianLeadingZero ( boolean $value ) : PhoneNumber	Sets whether this phone number uses an italian leading zero.
setNationalNumber ( string $value ) : PhoneNumber	Sets the national number of this phone number.
setNumberOfLeadingZeros ( integer $value ) : PhoneNumber	Sets the number of leading zeros of this phone number.
setPreferredDomesticCarrierCode ( string $value ) : PhoneNumber	Sets the preferred domestic carrier code of this phone number.
setRawInput ( string $value ) : PhoneNumber	Sets the raw input of this phone number.
unserialize ( $serialized )

Method Details

Property Details