| Свойство | Тип | Описание | |
|---|---|---|---|
| $instance | |||
| $phoneUtil | |||
| $prefixFileReader |
| Метод | Описание | |
|---|---|---|
|
getDescriptionForNumber ( |
As per getDescriptionForValidNumber, but explicitly checks the validity of the number passed in. | |
|
getDescriptionForValidNumber ( |
Returns a text description for the given phone number, in the language provided. The description might consist of the name of the country where the phone number is from, or the name of the geographical area the phone number is from if more detailed information is available. | |
|
getInstance ( string $mappingDir = self::MAPPING_DATA_DIRECTORY ) : |
Gets a PhoneNumberOfflineGeocoder instance to carry out international phone number geocoding. | |
| resetInstance ( ) |
| Метод | Описание | |
|---|---|---|
| __construct ( string $phonePrefixDataDirectory ) | PhoneNumberOfflineGeocoder constructor. | |
|
getCountryNameForNumber ( |
Returns the customary display name in the given language for the given territory the phone number is from. If it could be from many territories, nothing is returned. | |
| getRegionDisplayName ( $regionCode, $locale ) : string | Returns the customary display name in the given language for the given region. |
| protected __construct ( string $phonePrefixDataDirectory ) | ||
| $phonePrefixDataDirectory | string | |
|
protected getCountryNameForNumber ( |
||
| $number | ||
| $locale | string | |
| Результат | string | |
|
public getDescriptionForNumber ( |
||
| $number | a valid phone number for which we want to get a text description | |
| $locale | string | the language code for which the description should be written |
| $userRegion | string | the region code for a given user. This region will be omitted from the description if the phone number comes from this region. It is a two-letter uppercase ISO country code as defined by ISO 3166-1. |
| Результат | string | a text description for the given language code for the given phone number, or empty string if the number passed in is invalid |
This method assumes the validity of the number passed in has already been checked, and that the number is suitable for geocoding. We consider fixed-line and mobile numbers possible candidates for geocoding.
If $userRegion is set, we also consider the region of the user. If the phone number is from the same region as the user, only a lower-level description will be returned, if one exists. Otherwise, the phone number's region will be returned, with optionally some more detailed information.
For example, for a user from the region "US" (United States), we would show "Mountain View, CA" for a particular number, omitting the United States from the description. For a user from the United Kingdom (region "GB"), for the same number we may show "Mountain View, CA, United States" or even just "United States".
|
public getDescriptionForValidNumber ( |
||
| $number | a valid phone number for which we want to get a text description | |
| $locale | string | the language code for which the description should be written |
| $userRegion | string | the region code for a given user. This region will be omitted from the description if the phone number comes from this region. It is a two-letter uppercase ISO country code as defined by ISO 3166-1. |
| Результат | string | a text description for the given language code for the given phone number |
The PhoneNumberOfflineGeocoder 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 ) : |
||
| $mappingDir | string | (Optional) Mapping Data Directory |
| Результат | ||
| protected getRegionDisplayName ( $regionCode, $locale ) : string | ||
| $regionCode | ||
| $locale | ||
| Результат | string | |
| protected static PhoneNumberOfflineGeocoder,libphonenumber\geocoding $instance | ||
| Результат | ||
| protected PhoneNumberUtil,libphonenumber $phoneUtil | ||
| Результат | ||
