libphonenumber for PHP Lite

https://github.com/giggsey/libphonenumber-for-php-lite
Admin
A lightweight PHP library for parsing, formatting, storing and validating international phone...
Tokens:109,223
Snippets:799
Trust Score:9.6
License:Apache-2.0
Update:5 days ago
Show doc for...
Tokens:
Raw
### Get ShortNumberInfo singleton instance

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

ShortNumberInfo uses a singleton, similar to PhoneNumberUtil. Call getInstance() to obtain the shared instance.

```php
$shortNumberUtil = \libphonenumber\ShortNumberInfo::getInstance();
```

--------------------------------

### Usage Example - Get Short Number Info

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Shows how to obtain the singleton and parse a short number like '110' in the US region.

```php
$shortInfo = \libphonenumber\ShortNumberInfo::getInstance();
$shortNumber = \libphonenumber\PhoneNumberUtil::getInstance()->parse("110", "US");
```

--------------------------------

### getExampleShortNumber

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Gets an example short number for a region.

```APIDOC
## getExampleShortNumber

### Description
Returns an example short number from metadata for the given region code. Returns an empty string when absent.

### Method
getExampleShortNumber

### Parameters
- **$regionCode** (string) - Required - The region code.

### Return Value
- **string** - An example short number or empty string.
```

--------------------------------

### getExampleNumber() - Get example PhoneNumber for region

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberUtil.md

Returns an example PhoneNumber object for the supplied region code. The output shows the country code and national number for the example.

```php
var_dump($phoneNumberUtil->getExampleNumber('GB'));
// (PhoneNumber) Country Code: 44 National Number: 1212345678 ... 
```

--------------------------------

### getExampleShortNumberForCost

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Gets an example short number for a region and cost category.

```APIDOC
## getExampleShortNumberForCost

### Description
Returns an example short number from metadata for the given region code and cost category. Costs map: TOLL_FREE → tollFree desc, STANDARD_RATE → standardRate, PREMIUM_RATE → premiumRate; UNKNOWN_COST examples are derived by elimination and return an empty string.

### Method
getExampleShortNumberForCost

### Parameters
- **$regionCode** (string) - Required - The region code.
- **$cost** (ShortNumberCost) - Required - The cost category.

### Return Value
- **string** - An example short number or empty string.
```

--------------------------------

### start()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberMatch.md

Returns the start index of the match as passed to the constructor.

```APIDOC
## start()

### Description
Returns the start index of the match as passed to the constructor.

### Method
start

### Signature
```php
public function start(): int
```

### Return Value
- **int** - The start index.

### Example
```php
$start = $match->start();
```
```

--------------------------------

### getExampleNumberForType() - Get example PhoneNumber for region and type

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberUtil.md

Returns an example PhoneNumber object for the supplied region code and PhoneNumberType. Also accepts a PhoneNumberType as the first parameter to get a valid number of that type from any country, leaving the second parameter null.

```php
var_dump($phoneNumberUtil->getExampleNumberForType('GB', \libphonenumber\PhoneNumberType::MOBILE));
// (PhoneNumber) Country Code: 44 National Number: 7400123456 ...
```

```php
var_dump($phoneNumberUtil->getExampleNumberForType(\libphonenumber\PhoneNumberType::MOBILE));
// (PhoneNumber) Country Code: 1 National Number: 2015555555 ...
```

--------------------------------

### getExampleShortNumber() for GB

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns an example short phone number for the supplied region code. For 'GB' it returns the string '150'.

```php
var_dump($shortNumberUtil->getExampleShortNumber('GB'));
// string(3) "150"
```

--------------------------------

### PhoneNumberMatch usage example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberMatch.md

Shows constructing a PhoneNumberMatch with a parsed number, accessing its properties, and handling a negative start index error. The example outputs start, end, rawString, number, and string representation, and catches InvalidArgumentException for negative start.

```php
use libphonenumber\PhoneNumber;
use libphonenumber\PhoneNumberMatch;
use libphonenumber\PhoneNumberUtil;

$phoneUtil = PhoneNumberUtil::getInstance();
$found = new PhoneNumberMatch(
    $start = 0,
    $rawString = '+1 345 657 1234',
    $phoneUtil->parse('+1 345 657 1234', null)
);

echo $found->start();        // 0
echo $found->end();          // 15
echo $found->rawString();    // +1 345 657 1234
echo $found->number();       // PhoneNumber object
echo (string) $found;        // PhoneNumberMatch [0,15) +1 345 657 1234

// Error handling: negative start index
try {
    new PhoneNumberMatch(-1, '123', new PhoneNumber());
} catch (\InvalidArgumentException $e) {
    echo $e->getMessage();   // Start index must be >= 0.
}
```

--------------------------------

### getExampleShortNumber and getExampleShortNumberForCost method signatures

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Returns example numbers from metadata, or '' when absent. Costs map: TOLL_FREE to tollFree desc, STANDARD_RATE to standardRate, PREMIUM_RATE to premiumRate; UNKNOWN_COST examples are derived by elimination and return ''.

```php
public function getExampleShortNumber(string $regionCode): string
public function getExampleShortNumberForCost(string $regionCode, ShortNumberCost $cost): string
```

--------------------------------

### Example number method signatures

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Lists the public methods for retrieving example numbers. getExampleNumberForType is overloaded: with a single PhoneNumberType it returns an example of that type from any supported region (also checking non-geo entities); with a region string plus type it returns a region-specific example. Returns null when no metadata. Throws TypeError for incompatible arguments.

```php
public function getExampleNumber(string $regionCode): ?PhoneNumber          // FIXED_LINE example
public function getInvalidExampleNumber(string $regionCode): ?PhoneNumber  // parseable-but-invalid
public function getExampleNumberForType(string|PhoneNumberType $regionCodeOrType, ?PhoneNumberType $type = null): ?PhoneNumber
public function getExampleNumberForNonGeoEntity(int $countryCallingCode): ?PhoneNumber
```

--------------------------------

### Matcher end() and start() methods

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/Matcher.md

Character offsets for the match or group. start returns null for absent groups; end is start + mb_strlen(group). Offsets are character-based, not byte-based.

```php
public function end(?int $group = null): ?int
```

```php
public function start(?int $group = null): mixed
```

--------------------------------

### Using getExampleNumber with validation and formatting

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Shows how to retrieve an example number for a region, check it is valid, and format it in E164 format.

```php
$example = $phoneUtil->getExampleNumber('GB');
if ($example !== null && $phoneUtil->isValidNumber($example)) {
    echo $phoneUtil->format($example, \libphonenumber\PhoneNumberFormat::E164);
}
```

--------------------------------

### Usage example for ShortNumberInfo

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Shows how to use ShortNumberInfo to validate a short number for a region, get its expected cost, and check if it is an SMS service. Requires a parsed PhoneNumber object from PhoneNumberUtil.

```php
use libphonenumber\PhoneNumberUtil;
use libphonenumber\ShortNumberInfo;

$phoneUtil = PhoneNumberUtil::getInstance();
$shortInfo = ShortNumberInfo::getInstance();

$number = $phoneUtil->parse('110', 'US');
if ($shortInfo->isValidShortNumberForRegion($number, 'US')) {
    $cost = $shortInfo->getExpectedCostForRegion($number, 'US');
    $sms  = $shortInfo->isSmsServiceForRegion($number, 'US');
}
```

--------------------------------

### format() usage example with all formats

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Example of parsing a Swiss number and formatting it with E164, NATIONAL, INTERNATIONAL, and RFC3966 formats. Shows the expected output for each format.

```php
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();
$number = $phoneUtil->parse("044 668 18 00", "CH");

echo $phoneUtil->format($number, \libphonenumber\PhoneNumberFormat::E164);         // +41446681800
echo $phoneUtil->format($number, \libphonenumber\PhoneNumberFormat::NATIONAL);     // 044 668 18 00
echo $phoneUtil->format($number, \libphonenumber\PhoneNumberFormat::INTERNATIONAL);// +41 44 668 18 00
echo $phoneUtil->format($number, \libphonenumber\PhoneNumberFormat::RFC3966);      // tel:+41-44-668-18-00
```

--------------------------------

### PhoneNumberDesc getters and setters for exampleNumber

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberDesc.md

Methods to get, set, and check the example number. Setting a value flips the has-flag.

```php
public function getExampleNumber(): string
public function setExampleNumber(string $value): static
public function hasExampleNumber(): bool
```

--------------------------------

### getExpectedCostForRegion() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns the expected cost as a ShortNumberCost constant for a string or PhoneNumber object. The example shows a UK number returning UNKNOWN_COST and a US number returning PREMIUM_RATE (int 4).

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(44);
$phoneNumber->setNationalNumber(118118);

var_dump($shortNumberUtil->getExpectedCostForRegion($phoneNumber, 'GB'));
// int(10) (\libphonenumber\ShortNumberCost::UNKNOWN_COST)

var_dump($shortNumberUtil->getExpectedCostForRegion('24280', 'US'));
// int(4) (\libphonenumber\ShortNumberCost::PREMIUM_RATE)
```

--------------------------------

### Matcher usage example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/Matcher.md

Shows lookingAt(), group(), end(), reset(), find(), replaceAll(), and matches() in action. Demonstrates that matches() requires the whole string to match.

```php
$m = new \libphonenumber\Matcher('(\d{3})(\d{4})', '0123456789');
var_dump($m->lookingAt());   // bool(true)
var_dump($m->group(1));      // "012"
var_dump($m->group(2));      // "3456"
var_dump($m->end());         // 7

$m->reset('xx012 0345yy');
var_dump($m->find());        // bool(true)
echo $m->replaceAll('[$1-$2]'); // xx[012-0345]yy

// matches() requires the whole string to match:
$m2 = new \libphonenumber\Matcher('\d+', '123');
var_dump($m2->matches());    // bool(true)
```

--------------------------------

### getExpectedCost() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns the expected cost as a ShortNumberCost constant for a PhoneNumber object. The example uses a UK short number and outputs UNKNOWN_COST (int 10).

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(44);
$phoneNumber->setNationalNumber(118118);

var_dump($shortNumberUtil->getExpectedCost($phoneNumber, 'GB'));
// int(10) (\libphonenumber\ShortNumberCost::UNKNOWN_COST)
```

--------------------------------

### Install via Composer: composer require giggsey/libphonenumber-for-php-lite

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/README.md

Use Composer to install the library. Requires PHP 8.1+ and the PECL mbstring extension.

```bash
composer require giggsey/libphonenumber-for-php-lite
```

--------------------------------

### Custom metadata directory example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Shows how to reset the singleton and pass a custom metadata class-name prefix to getInstance(). Must call resetInstance() before changing parameters.

```php
// Custom metadata directory example
\libphonenumber\PhoneNumberUtil::resetInstance();
$util = \libphonenumber\PhoneNumberUtil::getInstance('MyApp\Data\PhoneNumberMetadata_');
```

--------------------------------

### NumberFormat example with pattern and format

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/NumberFormat.md

Example of constructing a NumberFormat with a pattern, format, leading digits pattern, and optional national prefix. This is generated data.

```php
(new NumberFormat())
    ->setPattern('(\d{3})(\d{3})(\d{4})')
    ->setFormat('($1) $2-$3')
    ->setLeadingDigitsPattern(['[2-9]'])
    ->setNationalPrefixOptionalWhenFormatting(true)
```

--------------------------------

### isPossibleShortNumberForRegion() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Checks whether a short number (string or PhoneNumber) is possible for a given region. The example uses UK region 'GB' and shows both object and string inputs, both returning bool(true).

```php

$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(44);
$phoneNumber->setNationalNumber(118118);

var_dump($shortNumberUtil->isPossibleShortNumberForRegion($phoneNumber, 'GB'));
// bool(true)

var_dump($shortNumberUtil->isPossibleShortNumberForRegion('1234', 'GB'));
// bool(true)
```

--------------------------------

### RegexBasedMatcher usage example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/InternalInterfaces.md

Shows how to instantiate RegexBasedMatcher and call matchNationalNumber with a short-number emergency test using prefix matching.

```php
$matcher = new \libphonenumber\RegexBasedMatcher();
// e.g. short-number emergency test with prefix matching
$desc = $metadata->getEmergency();
$matcher->matchNationalNumber('911', $desc, false);
```

--------------------------------

### getExampleNumberForType

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Returns an example phone number of a specified type. Overloaded: with a single PhoneNumberType argument, returns an example of that type from any supported region; with a region string and type, returns a region-specific example. Returns null when no metadata.

```APIDOC
## getExampleNumberForType

### Description
Returns an example phone number of a specified type. Overloaded: with a single PhoneNumberType argument, returns an example of that type from any supported region; with a region string and type, returns a region-specific example. Returns null when no metadata.

### Method
`public function getExampleNumberForType(string|PhoneNumberType $regionCodeOrType, ?PhoneNumberType $type = null): ?PhoneNumber`

### Parameters
- `$regionCodeOrType` (string|PhoneNumberType) - Required - Either a region code string or a PhoneNumberType.
- `$type` (?PhoneNumberType) - Optional - The phone number type. Required if the first argument is a string.

### Return Value
- `?PhoneNumber` - A PhoneNumber instance or null if no example exists.

### Throws
- `TypeError` - If arguments are incompatible:
  - `'$regionCodeOrType must be a PhoneNumberType'` when `$type` is null but argument is a string.
  - `'$regionCodeOrType must be a string if $type is null'` when `$type` is given but first argument is not a string.
```

--------------------------------

### getExampleNumberForType()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberUtil.md

Returns an example PhoneNumber object for the supplied region code and phone number type. Can also be called with only a PhoneNumberType to get a valid number from any country.

```APIDOC
## getExampleNumberForType()

### Description
Returns an example `PhoneNumber` object for the `$regionCode` supplied of the `PhoneNumberType`. This also accepts the first parameter being a `PhoneNumberType`, where it will return a valid number for the specified number type from any country. Just leave the second parameter as null.

### Method
`getExampleNumberForType`

### Parameters
- **$regionCode** (string) - Required - The region code (e.g., 'GB').
- **$type** (PhoneNumberType) - Required - The phone number type (e.g., `\libphonenumber\PhoneNumberType::MOBILE`).

### Return Value
Returns a `PhoneNumber` object.

### Examples
```php
var_dump($phoneNumberUtil->getExampleNumberForType('GB', \libphonenumber\PhoneNumberType::MOBILE));
// (PhoneNumber) Country Code: 44 National Number: 7400123456 ...

var_dump($phoneNumberUtil->getExampleNumberForType(\libphonenumber\PhoneNumberType::MOBILE));
// (PhoneNumber) Country Code: 1 National Number: 2015555555 ...
```
```

--------------------------------

### getExampleShortNumber($regionCode)

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns an example short phone number for the specified region code. The region code is a string representing the ISO 3166-1 alpha-2 country code.

```APIDOC
## getExampleShortNumber($regionCode)

### Description
Returns an example short phone number for the supplied region code.

### Parameters
- **$regionCode** (string) - Required - The region code (e.g., 'GB').

### Return Value
- **string** - An example short number for the region.

### Example
```php
var_dump($shortNumberUtil->getExampleShortNumber('GB'));
// string(3) "150"
```
```

--------------------------------

### getDescriptionForNumber() examples with GB and US numbers

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberOfflineGeocoder.md

Shows how to get a text description for a phone number in different locales and user regions. The description may be the country or geographical area. If the number is from the same region as $userRegion, only a lower-level description is returned.

```php
$gbNumber = \libphonenumber\PhoneNumberUtil::getInstance()->parse('0161 496 0123', 'GB');

var_dump($geoCoder->getDescriptionForNumber($gbNumber, 'en'));
// string(10) "Manchester"

var_dump($geoCoder->getDescriptionForNumber($gbNumber, 'en_GB', 'GB'));
// string(10) "Manchester"

var_dump($geoCoder->getDescriptionForNumber($gbNumber, 'en_GB', 'US'));
// string(14) "United Kingdom"

var_dump($geoCoder->getDescriptionForNumber($gbNumber, 'ko-KR', 'US'));
// string(6) "영국" (Korean for United Kingdom)


$usNumber = \libphonenumber\PhoneNumberUtil::getInstance()->parse("+1 650 253 0000", "US");

var_dump($geoCoder->getDescriptionForNumber($usNumber, 'en'));
// string(10) "Mountain View, CA"

var_dump($geoCoder->getDescriptionForNumber($usNumber, 'en_GB', 'GB'));
// string(10) "United States"

var_dump($geoCoder->getDescriptionForNumber($usNumber, 'en_GB', 'US'));
// string(14) "Mountain View, CA"

var_dump($geoCoder->getDescriptionForNumber($usNumber, 'ko-KR', 'US'));
// string(6) "미국" (Korean for United States)
```

--------------------------------

### Build metadata with composer

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/README.md

Runs the composer script 'build' to compile phone number metadata. Clones the libphonenumber project at the version specified in METADATA-VERSION.php.

```bash
composer run build
```

--------------------------------

### getExampleNumber()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberUtil.md

Returns an example PhoneNumber object for the supplied region code. Useful for testing and demonstration purposes.

```APIDOC
## getExampleNumber()

### Description
Returns an example `PhoneNumber` object for the `$regionCode` supplied.

### Method
`getExampleNumber`

### Parameters
- **$regionCode** (string) - Required - The region code (e.g., 'GB').

### Return Value
Returns a `PhoneNumber` object.

### Example
```php
var_dump($phoneNumberUtil->getExampleNumber('GB'));
// (PhoneNumber) Country Code: 44 National Number: 1212345678 ...
```
```

--------------------------------

### Example PhoneNumber object output

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberUtil.md

Shows the structure of the PhoneNumber object returned by parse() for the examples above. Contains countryCode, nationalNumber, extension, and other fields.

```text
object(libphonenumber\PhoneNumber)#31 (9) {
  ["countryCode":"libphonenumber\PhoneNumber":private]=>
  int(44)
  ["nationalNumber":"libphonenumber\PhoneNumber":private]=>
  string(10) "1174960123"
  ["extension":"libphonenumber\PhoneNumber":private]=>
  NULL
  ["italianLeadingZero":"libphonenumber\PhoneNumber":private]=>
  NULL
  ["rawInput":"libphonenumber\PhoneNumber":private]=>
  NULL
  ["countryCodeSource":"libphonenumber\PhoneNumber":private]=>
  NULL
  ["preferredDomesticCarrierCode":"libphonenumber\PhoneNumber":private]=>
  NULL
  ["hasNumberOfLeadingZeros":"libphonenumber\PhoneNumber":private]=>
  bool(false)
  ["numberOfLeadingZeros":"libphonenumber\PhoneNumber":private]=>
  int(1)
}
```

--------------------------------

### getExampleNumber

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Returns a fixed-line example phone number for a given region code, or null if no metadata is available.

```APIDOC
## getExampleNumber

### Description
Returns a fixed-line example phone number for a given region code, or null if no metadata is available.

### Method
`public function getExampleNumber(string $regionCode): ?PhoneNumber`

### Parameters
- `$regionCode` (string) - Required - The region code (e.g., 'GB').

### Return Value
- `?PhoneNumber` - A PhoneNumber instance or null if no example exists.

### Example
```php
$example = $phoneUtil->getExampleNumber('GB');
```
```

--------------------------------

### Matcher lookingAt() method

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/Matcher.md

Returns true when the subject starts with a match (^pattern).

```php
public function lookingAt(): bool
```

--------------------------------

### isPossibleShortNumber() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Checks whether a PhoneNumber object is a possible short number. The example uses a UK number 118118 and outputs bool(true).

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(44);
$phoneNumber->setNationalNumber(118118);

var_dump($shortNumberUtil->isPossibleShortNumber($phoneNumber));
// bool(true)
```

--------------------------------

### isValidShortNumberForRegion() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Checks whether a short number (string or PhoneNumber) is valid for a given region. The example uses UK region 'GB' and shows an object returning bool(true) and a string '1234' returning bool(false).

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(44);
$phoneNumber->setNationalNumber(118118);

var_dump($shortNumberUtil->isValidShortNumberForRegion($phoneNumber, 'GB'));
// bool(true)

var_dump($shortNumberUtil->isValidShortNumberForRegion('1234', 'GB'));
// bool(false)
```

--------------------------------

### isCarrierSpecificForRegion() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns whether a PhoneNumber is a carrier specific short number in the given region. The example uses US region 'US' and outputs (bool) true.

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(1);
$phoneNumber->setNationalNumber(611);

var_dump($shortNumberUtil->isCarrierSpecificForRegion($phoneNumber, 'US'));
// (bool) true
```

--------------------------------

### Generated usage example from PhoneNumberMetadata_US.php

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberDesc.md

Shows how to create a PhoneNumberDesc for tollFree with pattern and example, and use PhoneNumberDesc::empty() for types with no numbers.

```php
$this->tollFree = (new PhoneNumberDesc())
    ->setNationalNumberPattern('8(?:00|33|44|55|66|77|88)[2-9]\d{6}')
    ->setExampleNumber('8002345678');
// types with no numbers of that type:
$this->voip = PhoneNumberDesc::empty();
```

--------------------------------

### PhoneNumberMatch constructor signature

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberMatch.md

Constructor for PhoneNumberMatch. Requires a non-negative start index, the raw matched substring, and a parsed PhoneNumber. Throws InvalidArgumentException with message 'Start index must be >= 0.' if start is negative.

```php
public function __construct(int $start, string $rawString, PhoneNumber $number)
```

--------------------------------

### parse() usage example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Shows parsing national and international formats, and catching NumberParseException for invalid input without a region.

```php
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();

$swissNumber = $phoneUtil->parse("044 668 18 00", "CH");       // national format
$intlNumber  = $phoneUtil->parse("+41 44 668 18 00", null);    // international format, no region

try {
    $phoneUtil->parse("unknown input", null); // no '+' and no region
} catch (\libphonenumber\NumberParseException $e) {
    echo $e->getErrorType(); // NumberParseException::INVALID_COUNTRY_CODE (0)
}
```

--------------------------------

### Get PhoneNumberToCarrierMapper singleton instance

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberToCarrierMapper.md

Retrieves the singleton instance of PhoneNumberToCarrierMapper, similar to PhoneNumberUtil.

```php
$carrierMapper = \libphonenumber\PhoneNumberToCarrierMapper::getInstance();
```

--------------------------------

### Emergency number usage example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Shows how to use isEmergencyNumber and connectsToEmergencyNumber with a raw string. Both return false when the region has no emergency descriptor.

```php
if ($shortInfo->isEmergencyNumber('911', 'US')) {
    // dispatch…
}
if ($shortInfo->connectsToEmergencyNumber('911-EXTRA', 'US')) {
    // prefix match permitted outside BR/CL/NI
}
```

--------------------------------

### Switch on ShortNumberCost constants

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Example of switching on the ShortNumberCost constants returned by getExpectedCostForRegion, with cases for TOLL_FREE, STANDARD_RATE, PREMIUM_RATE, and UNKNOWN_COST.

```php
$cost = $shortInfo->getExpectedCostForRegion($shortNumber, "US");
switch ($cost) {
    case \libphonenumber\ShortNumberCost::TOLL_FREE:       // …
    case \libphonenumber\ShortNumberCost::STANDARD_RATE:   // …
    case \libphonenumber\ShortNumberCost::PREMIUM_RATE:    // …
    case \libphonenumber\ShortNumberCost::UNKNOWN_COST:    // …
}
```

--------------------------------

### Usage example with try-catch

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/NumberParseException.md

Shows how to catch NumberParseException and branch on the error type. The exception is Stringable, so echoing it outputs 'Error type: …'.

```php
use libphonenumber\NumberParseException;
use libphonenumber\PhoneNumberUtil;

$phoneUtil = PhoneNumberUtil::getInstance();

try {
    $phoneUtil->parse('+44 117 496 0123', null);
} catch (NumberParseException $e) {
    // Branch on the machine-readable error type
    switch ($e->getErrorType()) {
        case NumberParseException::TOO_LONG:
            // input exceeded 250 chars, or NSN > 17 digits
            break;
        case NumberParseException::NOT_A_NUMBER:
            // not viable / invalid phone-context
            break;
        case NumberParseException::INVALID_COUNTRY_CODE:
            // missing region and no leading '+', or unknown country code
            break;
        case NumberParseException::TOO_SHORT_AFTER_IDD:
        case NumberParseException::TOO_SHORT_NSN:
            break;
    }
    echo $e; // Stringable: "Error type: …"
}
```

--------------------------------

### Using isNumberMatch with parse and output

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Demonstrates comparing a parsed number with a string, outputting the match type name. The example yields SHORT_NSN_MATCH.

```php
$match = $phoneUtil->isNumberMatch(
    $phoneUtil->parse('+1 345 657 1234', null),
    '657 1234'
);
echo $match->name; // SHORT_NSN_MATCH
```

--------------------------------

### Format a phone number for out-of-country dialing

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/README.md

Formats the Swiss number as dialed from the US and Great Britain using formatOutOfCountryCallingNumber().

```php
// Produces "011 41 44 668 1800", the number when it is dialled in the United States.
echo $phoneUtil->formatOutOfCountryCallingNumber($swissNumberProto, "US");

// Produces "00 41 44 668 18 00", the number when it is dialled in Great Britain.
echo $phoneUtil->formatOutOfCountryCallingNumber($swissNumberProto, "GB");
```

--------------------------------

### Using isPossibleNumberWithReason

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Example of checking if a number length is feasible using the ValidationResult enum.

```php
$reason = $phoneUtil->isPossibleNumberWithReason($phoneNumber);
if ($reason === \libphonenumber\ValidationResult::IS_POSSIBLE) {
    // number length is feasible
}
```

--------------------------------

### getExampleShortNumberForCost() with cost categories

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns a valid short number for the specified region and cost category. For 'GB' with TOLL_FREE it returns '116000'; for PREMIUM_RATE it returns an empty string. For 'US' with PREMIUM_RATE it returns '24280'.

```php
var_dump($shortNumberUtil->getExampleShortNumberForCost('GB', \libphonenumber\ShortNumberCost::TOLL_FREE));
// string(6) "116000"

var_dump($shortNumberUtil->getExampleShortNumberForCost('GB', \libphonenumber\ShortNumberCost::PREMIUM_RATE));
// string(0) ""

var_dump($shortNumberUtil->getExampleShortNumberForCost('US', \libphonenumber\ShortNumberCost::PREMIUM_RATE));
// string(5) "24280"
```

--------------------------------

### isEmergencyNumber() for GB

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns whether the supplied number exactly matches an emergency service number for the region. For '999' in 'GB' it returns true; for '9999' it returns false.

```php
var_dump($shortNumberUtil->isEmergencyNumber('999', 'GB'));
// bool(true)

var_dump($shortNumberUtil->isEmergencyNumber('9999', 'GB'));
// bool(false)
```

--------------------------------

### getExampleNumberForNonGeoEntity

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Returns an example phone number for a non-geographic entity identified by its country calling code, or null if no metadata is available.

```APIDOC
## getExampleNumberForNonGeoEntity

### Description
Returns an example phone number for a non-geographic entity identified by its country calling code, or null if no metadata is available.

### Method
`public function getExampleNumberForNonGeoEntity(int $countryCallingCode): ?PhoneNumber`

### Parameters
- `$countryCallingCode` (int) - Required - The country calling code (e.g., 800).

### Return Value
- `?PhoneNumber` - A PhoneNumber instance or null if no example exists.
```

--------------------------------

### Get Supported Regions

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Returns an array of region codes that have short-number metadata, sourced from the generated ShortNumbersRegionCodeSet constant.

```php
public function getSupportedRegions(): array // string[]
```

--------------------------------

### Matcher find() method

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/Matcher.md

Returns true when a match exists starting at $offset (defaults to the internal advancing searchIndex, which increments per call).

```php
public function find(?int $offset = null): bool
```

--------------------------------

### Format a phone number in E164, NATIONAL, and INTERNATIONAL formats

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/README.md

Formats the parsed Swiss number using PhoneNumberFormat constants. Each format produces a different string representation.

```php
// Produces "+41446681800"
echo $phoneUtil->format($swissNumberProto, \libphonenumber\PhoneNumberFormat::E164);

// Produces "044 668 18 00"
echo $phoneUtil->format($swissNumberProto, \libphonenumber\PhoneNumberFormat::NATIONAL);

// Produces "+41 44 668 18 00"
echo $phoneUtil->format($swissNumberProto, \libphonenumber\PhoneNumberFormat::INTERNATIONAL);
```

--------------------------------

### setItalianLeadingZerosForPhoneNumber() static method

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Sets italianLeadingZero(true) (and numberOfLeadingZeros) when the national number starts with a run of zeros.

```php
public static function setItalianLeadingZerosForPhoneNumber(string $nationalNumber, PhoneNumber $phoneNumber): void
```

--------------------------------

### connectsToEmergencyNumber() for GB

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Checks whether the number, when dialled, might connect to an emergency service within the region. For '999' it returns true; for '999123' it also returns true because additional digits after 999 might be dialled.

```php
var_dump($shortNumberUtil->connectsToEmergencyNumber('999', 'GB'));
// bool(true)

// Note, 999 is a GB emergency service, but additional digits after the 999
// might be possible to dial.
var_dump($shortNumberUtil->connectsToEmergencyNumber('999123', 'GB'));
// bool(true)
```

--------------------------------

### Parse and normalize a Swiss phone number

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/README.md

Parses a Swiss phone number string into a PhoneNumber object using PhoneNumberUtil::parse(). Throws NumberParseException on invalid input.

```php
$swissNumberStr = "044 668 18 00";
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();
try {
    $swissNumberProto = $phoneUtil->parse($swissNumberStr, "CH");
    var_dump($swissNumberProto);
} catch (\libphonenumber\NumberParseException $e) {
    var_dump($e);
}
```

--------------------------------

### getInvalidExampleNumber() - Get invalid example PhoneNumber for region

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/PhoneNumberUtil.md

Returns an example invalid PhoneNumber object for the supplied region code. Useful for unit testing with invalid numbers; the returned number can be parsed and may be a valid short number for the region.

```php
var_dump($phoneNumberUtil->getInvalidExampleNumber('GB'));
// (PhoneNumber) Country Code: 44 National Number: 121234567 ...
```

--------------------------------

### formattingRuleHasFirstGroupOnly() static method

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Returns true when the rule is empty or starts with the first-group symbol $1 (i.e. the rule does not prepend a national prefix).

```php
public static function formattingRuleHasFirstGroupOnly(string $nationalPrefixFormattingRule): bool
```

--------------------------------

### Validate a parsed phone number

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/README.md

Checks if the parsed Swiss number is valid using isValidNumber(). Outputs true for the example.

```php
$isValid = $phoneUtil->isValidNumber($swissNumberProto);
var_dump($isValid); // true
```

--------------------------------

### ShortNumberInfo::__construct() signature

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Protected constructor for short-number metadata. $matcherAPI is required (the singleton passes new RegexBasedMatcher()); $metadataSource defaults to a MultiFileMetadataSourceImpl for short-number metadata. Also initializes country calling code map and primes shared regexes via PhoneNumberUtil::getInstance().

```php
protected function __construct(
    protected MatcherAPIInterface $matcherAPI,
    protected MetadataSourceInterface $metadataSource = new MultiFileMetadataSourceImpl(__NAMESPACE__ . '\data\ShortNumberMetadata_'),
)
```

--------------------------------

### MultiFileMetadataSourceImpl::__construct()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Creates a MultiFileMetadataSourceImpl instance with a configurable metadata file prefix. Lookups load `{prefix}{RegionCode}` (ucfirst) or `{prefix}{intCallingCode}` for non-geo entities.

```APIDOC
## MultiFileMetadataSourceImpl::__construct()

### Description
Creates a MultiFileMetadataSourceImpl instance with a configurable metadata file prefix. Lookups load `{prefix}{RegionCode}` (ucfirst) or `{prefix}{intCallingCode}` for non-geo entities.

### Method
constructor

### Signature
```php
public function __construct(
    protected readonly string $currentFilePrefix = __NAMESPACE__ . '\data\PhoneNumberMetadata_'
)
```

### Parameters
- **$currentFilePrefix** (string) - Optional - Prefix of metadata class names. Default: `__NAMESPACE__ . '\data\PhoneNumberMetadata_'`
```

--------------------------------

### ShortNumberInfo::__construct()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Protected constructor for ShortNumberInfo. The singleton passes a RegexBasedMatcher and a default metadata source; subclassing with a custom matcher/metadata source is the documented way to inject alternatives.

```APIDOC
## ShortNumberInfo::__construct()

### Description
Protected constructor for ShortNumberInfo. The singleton passes a RegexBasedMatcher and a default metadata source; subclassing with a custom matcher/metadata source is the documented way to inject alternatives.

### Method
constructor (protected)

### Signature
```php
protected function __construct(
    protected MatcherAPIInterface $matcherAPI,
    protected MetadataSourceInterface $metadataSource = new MultiFileMetadataSourceImpl(__NAMESPACE__ . '\data\ShortNumberMetadata_')
)
```

### Parameters
- **$matcherAPI** (MatcherAPIInterface) - Required - Regex engine; the singleton passes `new RegexBasedMatcher()`.
- **$metadataSource** (MetadataSourceInterface) - Optional - Loads the generated short-number metadata files. Default: `new MultiFileMetadataSourceImpl(__NAMESPACE__ . '\data\ShortNumberMetadata_')`
```

--------------------------------

### connectsToEmergencyNumber($number, $region)

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Checks whether the supplied number, when dialled, might connect to an emergency service within the given region. This allows for additional digits after the emergency number.

```APIDOC
## connectsToEmergencyNumber($number, $region)

### Description
Checks whether the supplied number, when dialled, might connect to an emergency service within the given region.

### Parameters
- **$number** (string) - Required - The phone number to check.
- **$region** (string) - Required - The region code (e.g., 'GB').

### Return Value
- **bool** - True if the number might connect to an emergency service, false otherwise.

### Example
```php
var_dump($shortNumberUtil->connectsToEmergencyNumber('999', 'GB'));
// bool(true)

// Note, 999 is a GB emergency service, but additional digits after the 999
// might be possible to dial.
var_dump($shortNumberUtil->connectsToEmergencyNumber('999123', 'GB'));
// bool(true)
```
```

--------------------------------

### isCarrierSpecific() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns whether a PhoneNumber is a carrier specific short number. The example uses a US number 611 and outputs (bool) true.

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(1);
$phoneNumber->setNationalNumber(611);

var_dump($shortNumberUtil->isCarrierSpecific($phoneNumber));
// (bool) true
```

--------------------------------

### connectsToEmergencyNumber method signature

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Checks if a number might connect to an emergency service, allowing prefix matches except in BR, CL, NI where exactness is required. Numbers starting with '+' always return false.

```php
public function connectsToEmergencyNumber(string $number, string $regionCode): bool
```

--------------------------------

### PhoneNumber usage example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumber.md

Demonstrates parsing, manual construction with fluent setters, equality checking, extension-free copying via mergeFrom() and clearExtension(), and a serialization round-trip. The manual number equals the parsed GB number '0117 496 0123'.

```php
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();

// Preferred: parse
$number = $phoneUtil->parse('+1 345 657 1234', null);

// Manual construction is possible (fluent setters)
$manual = (new \libphonenumber\PhoneNumber())
    ->setCountryCode(44)
    ->setNationalNumber('1174960123');

if ($manual->equals($phoneUtil->parse('0117 496 0123', 'GB'))) {
    echo 'same core number';
}

// Extension-free copy for formatting
$noExt = (new \libphonenumber\PhoneNumber())->mergeFrom($number)->clearExtension();

// Serialization round-trip
$packed = serialize($number);
$restored = unserialize($packed);
```

--------------------------------

### Singleton Access - getInstance()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Returns the singleton instance of ShortNumberInfo. The constructor internally creates a MultiFileMetadataSourceImpl, copies the country code map, and initializes PhoneNumberUtil regexes.

```php
public static function getInstance(): ShortNumberInfo
```

--------------------------------

### Use PhoneNumberUtil singleton and reset instance

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberUtil.md

Shows how to obtain the singleton and reset it, mainly for testing. After resetInstance(), the next getInstance() call re-creates the instance.

```php
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();

// Reset singleton (mainly used in testing)
\libphonenumber\PhoneNumberUtil::resetInstance();
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance(); // re-created
```

--------------------------------

### isEmergencyNumber($number, $region)

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Returns whether the supplied number exactly matches an emergency service number for the given region. The number is a string, and the region is a string representing the ISO 3166-1 alpha-2 country code.

```APIDOC
## isEmergencyNumber($number, $region)

### Description
Returns whether the supplied number exactly matches an emergency service number for the given region.

### Parameters
- **$number** (string) - Required - The phone number to check.
- **$region** (string) - Required - The region code (e.g., 'GB').

### Return Value
- **bool** - True if the number exactly matches an emergency service number, false otherwise.

### Example
```php
var_dump($shortNumberUtil->isEmergencyNumber('999', 'GB'));
// bool(true)

var_dump($shortNumberUtil->isEmergencyNumber('9999', 'GB'));
// bool(false)
```
```

--------------------------------

### getInstance

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Returns the singleton instance of ShortNumberInfo. This is the primary way to access the class.

```APIDOC
## getInstance

### Description
Returns the singleton instance of ShortNumberInfo. This is the primary way to access the class.

### Method
`public static function getInstance(): ShortNumberInfo`

### Returns
- **ShortNumberInfo** - The singleton instance.

### Example
```php
$shortInfo = \libphonenumber\ShortNumberInfo::getInstance();
```
```

--------------------------------

### isValidShortNumber() example

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/docs/ShortNumberInfo.md

Checks whether a PhoneNumber object is a valid short number. Note: this only validates number patterns, not actual usage. The example uses a UK number 118118 and outputs bool(true).

```php
$phoneNumber = new \libphonenumber\PhoneNumber();
$phoneNumber->setCountryCode(44);
$phoneNumber->setNationalNumber(118118);

var_dump($shortNumberUtil->isValidShortNumber($phoneNumber));
// bool(true)
```

--------------------------------

### PhoneNumberUtil::getInstance()

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Retrieves the singleton instance of PhoneNumberUtil. Configuration parameters only take effect on the first call; call resetInstance() before changing them.

```APIDOC
## PhoneNumberUtil::getInstance()

### Description
Retrieves the singleton instance of PhoneNumberUtil. Configuration parameters only take effect on the first call; call resetInstance() before changing them.

### Method
static method

### Signature
```php
public static function getInstance(
    string $metadataLocation = __NAMESPACE__ . '\data\PhoneNumberMetadata_',
    array $countryCallingCodeToRegionCodeMap = CountryCodeToRegionCodeMap::COUNTRY_CODE_TO_REGION_CODE_MAP,
): PhoneNumberUtil
```

### Parameters
- **$metadataLocation** (string) - Optional - Class-name prefix of the generated per-region metadata classes used by MultiFileMetadataSourceImpl. Default: `__NAMESPACE__ . '\data\PhoneNumberMetadata_'` (i.e. `libphonenumber\data\PhoneNumberMetadata_`)
- **$countryCallingCodeToRegionCodeMap** (array<int,string[]>) - Optional - Country calling code → region code list; drives supportedRegions, countryCodesForNonGeographicalRegion and nanpaRegions (computed in the protected init()). Default: `CountryCodeToRegionCodeMap::COUNTRY_CODE_TO_REGION_CODE_MAP`

### Return Value
- **PhoneNumberUtil** - The singleton instance.

### Example
```php
// Custom metadata directory example
\libphonenumber\PhoneNumberUtil::resetInstance();
$util = \libphonenumber\PhoneNumberUtil::getInstance('MyApp\Data\PhoneNumberMetadata_');
```
```

--------------------------------

### PhoneNumberMatch method signatures

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/PhoneNumberMatch.md

Method signatures for PhoneNumberMatch: number(), start(), end(), rawString(), and __toString(). The end() method returns start plus the byte length of rawString, and __toString() formats as 'PhoneNumberMatch [start,end) rawString'.

```php
public function number(): PhoneNumber
```

```php
public function start(): int
```

```php
public function end(): int
```

```php
public function rawString(): string
```

```php
public function __toString(): string
```

--------------------------------

### PhoneNumberUtil::getInstance() constructor signature

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Defines the singleton's constructor parameters: $metadataLocation (class-name prefix for per-region metadata classes) and $countryCallingCodeToRegionCodeMap (country calling code to region code map). These only take effect on the first call; resetInstance() must be called before changing them.

```php
public static function getInstance(
    string $metadataLocation = __NAMESPACE__ . '\data\PhoneNumberMetadata_',
    array $countryCallingCodeToRegionCodeMap = CountryCodeToRegionCodeMap::COUNTRY_CODE_TO_REGION_CODE_MAP,
): PhoneNumberUtil
```

--------------------------------

### MultiFileMetadataSourceImpl::__construct() signature

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/configuration.md

Constructor for the metadata source that loads per-region metadata classes. $currentFilePrefix defaults to the package's data namespace; lookups load {prefix}{RegionCode} or {prefix}{intCallingCode} for non-geo entities.

```php
public function __construct(
    protected readonly string $currentFilePrefix = __NAMESPACE__ . '\data\PhoneNumberMetadata_'
)
```

--------------------------------

### getExpectedCostForRegion

Source: https://github.com/giggsey/libphonenumber-for-php-lite/blob/main/_autodocs/api-reference/ShortNumberInfo.md

Gets the expected cost of a short number in a specific region.

```APIDOC
## getExpectedCostForRegion

### Description
Returns the expected cost in a region. Order of checks: PREMIUM_RATE, STANDARD_RATE, TOLL_FREE, then emergency numbers (implicitly toll-free) — the most expensive matching category wins. Returns UNKNOWN_COST when the region doesn't match the number's calling code, metadata is missing, the length isn't in the general desc, or nothing matches.

### Method
getExpectedCostForRegion

### Parameters
- **$number** (PhoneNumber) - Required - The phone number to check.
- **$regionDialingFrom** (string) - Required - The region dialing from.

### Return Value
- **ShortNumberCost** - The expected cost category.
```
Tokens:
Raw