PHP Class libphonenumber\PhoneNumberToCarrierMapper

显示文件 Open project: giggsey/libphonenumber-for-php Class Usage Examples

Protected Properties

Property Type Description
$instance PhoneNumberToCarrierMapper[]
$phoneUtil PhoneNumberUtil
$prefixFileReader libphonenumber\prefixmapper\PrefixFileReader

Public Methods

Method Description
getInstance ( string $mappingDir = self::MAPPING_DATA_DIRECTORY ) : PhoneNumberToCarrierMapper Gets a {@link PhoneNumberToCarrierMapper} instance to carry out international carrier lookup.
getNameForNumber ( PhoneNumber $number, string $languageCode ) : string Gets the name of the carrier for the given phone number, in the language provided. As per {@link #getNameForValidNumber(PhoneNumber, Locale)} but explicitly checks the validity of the number passed in.
getNameForValidNumber ( PhoneNumber $number, string $languageCode ) : string Returns a carrier name for the given phone number, in the language provided. The carrier name is the one the number was originally allocated to, however if the country supports mobile number portability the number might not belong to the returned carrier anymore. If no mapping is found an empty string is returned.
getSafeDisplayName ( PhoneNumber $number, $languageCode ) : string Gets the name of the carrier for the given phone number only when it is 'safe' to display to users. A carrier name is considered safe if the number is valid and for a region that doesn't support {@linkplain http://en.wikipedia.org/wiki/Mobile_number_portability mobile number portability}.

Protected Methods

Method Description
__construct ( $phonePrefixDataDirectory )
isMobile ( integer $numberType ) : boolean Checks if the supplied number type supports carrier lookup.

Method Details

__construct() protected method

protected __construct ( $phonePrefixDataDirectory )

getInstance() public static method

The {@link PhoneNumberToCarrierMapper} is implemented as a singleton. Therefore, calling this method multiple times will only result in one instance being created.

public static getInstance ( string $mappingDir = self::MAPPING_DATA_DIRECTORY ) : PhoneNumberToCarrierMapper
$mappingDir string
return PhoneNumberToCarrierMapper

getNameForNumber() public method

Gets the name of the carrier for the given phone number, in the language provided. As per {@link #getNameForValidNumber(PhoneNumber, Locale)} but explicitly checks the validity of the number passed in.
public getNameForNumber ( PhoneNumber $number, string $languageCode ) : string
$number PhoneNumber The phone number for which we want to get a carrier name
$languageCode string Language code for which the description should be written
return string a carrier name for the given phone number, or empty string if the number passed in is invalid

getNameForValidNumber() public method

This method assumes the validity of the number passed in has already been checked, and that the number is suitable for carrier lookup. We consider mobile and pager numbers possible candidates for carrier lookup.

public getNameForValidNumber ( PhoneNumber $number, string $languageCode ) : string
$number PhoneNumber a valid phone number for which we want to get a carrier name
$languageCode string the language code in which the name should be written
return string a carrier name for the given phone number

getSafeDisplayName() public method

Gets the name of the carrier for the given phone number only when it is 'safe' to display to users. A carrier name is considered safe if the number is valid and for a region that doesn't support {@linkplain http://en.wikipedia.org/wiki/Mobile_number_portability mobile number portability}.
public getSafeDisplayName ( PhoneNumber $number, $languageCode ) : string
$number PhoneNumber PhoneNumber the phone number for which we want to get a carrier name
$languageCode String the language code in which the name should be written
return string a carrier name that is safe to display to users, or the empty string

isMobile() protected method

Checks if the supplied number type supports carrier lookup.
protected isMobile ( integer $numberType ) : boolean
$numberType integer A PhoneNumberType int
return boolean

Property Details

$instance protected_oe static_oe property

protected static PhoneNumberToCarrierMapper[],libphonenumber $instance
return PhoneNumberToCarrierMapper[]

$phoneUtil protected_oe property

protected PhoneNumberUtil,libphonenumber $phoneUtil
return PhoneNumberUtil

$prefixFileReader protected_oe property

protected PrefixFileReader,libphonenumber\prefixmapper $prefixFileReader
return libphonenumber\prefixmapper\PrefixFileReader