PHP Класс CommerceGuys\Addressing\Subdivision\Subdivision

Subdivisions are hierarchical and can have up to three levels: Administrative Area -> Locality -> Dependent Locality.
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$children The children.
$code string The subdivision code.
$countryCode string The country code.
$isoCode string The subdivision iso code.
$localCode string The local subdivision code.
$localName string The local subdivision name.
$locale string The locale.
$name string The subdivision name.
$parent Subdivision The parent.
$postalCodePattern string The postal code pattern.
$postalCodePatternType string The postal code pattern type.

Открытые методы

Метод Описание
__construct ( array $definition ) Creates a new Subdivision instance.
getChildren ( ) : Subdivision[] Gets the subdivision children.
getCode ( ) : string Gets the subdivision code.
getCountryCode ( ) : string Gets the subdivision country code.
getIsoCode ( ) : string Gets the subdivision ISO 3166-2 code.
getLocalCode ( ) : string | null Gets the subdivision local code.
getLocalName ( ) : string | null Gets the subdivision local name.
getLocale ( ) : string | null Gets the subdivision locale.
getName ( ) : string Gets the subdivision name.
getParent ( ) : Subdivision | null Gets the subdivision parent.
getPostalCodePattern ( ) : string | null Gets the postal code pattern.
getPostalCodePatternType ( ) : string | null Gets the postal code pattern type.
hasChildren ( ) : boolean Checks whether the subdivision has children.

Описание методов

__construct() публичный Метод

Creates a new Subdivision instance.
public __construct ( array $definition )
$definition array The definition array.

getChildren() публичный Метод

Gets the subdivision children.
public getChildren ( ) : Subdivision[]
Результат Subdivision[] The subdivision children.

getCode() публичный Метод

Represents the subdivision on the formatted address. Could be an abbreviation, such as "CA" for California, or a full string such as "Grand Cayman". This is the value that is stored on the address object. Guaranteed to be in latin script.
public getCode ( ) : string
Результат string The subdivision code.

getCountryCode() публичный Метод

This is a CLDR country code, since CLDR includes additional countries for addressing purposes, such as Canary Islands (IC).
public getCountryCode ( ) : string
Результат string The two-letter country code.

getIsoCode() публичный Метод

Only defined for administrative areas. Examples: 'US-CA', 'JP-01'.
public getIsoCode ( ) : string
Результат string The subdivision ISO 3166-2 code.

getLocalCode() публичный Метод

When a country uses a non-latin script, the local code is the code in that script (Cyrilic in Russia, Chinese in China, etc).
public getLocalCode ( ) : string | null
Результат string | null The subdivision local code, if defined.

getLocalName() публичный Метод

When a country uses a non-latin script, the local name is the name in that script (Cyrilic in Russia, Chinese in China, etc).
public getLocalName ( ) : string | null
Результат string | null The subdivision local name, if defined.

getLocale() публичный Метод

Used for selecting local subdivision codes/names. Only defined if the subdivision has a local code or name.
public getLocale ( ) : string | null
Результат string | null The subdivision locale, if defined.

getName() публичный Метод

Represents the subdivision in dropdowns. Guaranteed to be in latin script.
public getName ( ) : string
Результат string The subdivision name.

getParent() публичный Метод

Gets the subdivision parent.
public getParent ( ) : Subdivision | null
Результат Subdivision | null The parent, or NULL if there is none.

getPostalCodePattern() публичный Метод

This is a regular expression pattern used to validate postal codes.
public getPostalCodePattern ( ) : string | null
Результат string | null The postal code pattern.

getPostalCodePatternType() публичный Метод

Gets the postal code pattern type.
public getPostalCodePatternType ( ) : string | null
Результат string | null The postal code pattern type.

hasChildren() публичный Метод

Checks whether the subdivision has children.
public hasChildren ( ) : boolean
Результат boolean TRUE if the subdivision has children, FALSE otherwise.

Описание свойств

$children защищенное свойство

The children.
protected $children

$code защищенное свойство

The subdivision code.
protected string $code
Результат string

$countryCode защищенное свойство

The country code.
protected string $countryCode
Результат string

$isoCode защищенное свойство

The subdivision iso code.
protected string $isoCode
Результат string

$localCode защищенное свойство

The local subdivision code.
protected string $localCode
Результат string

$localName защищенное свойство

The local subdivision name.
protected string $localName
Результат string

$locale защищенное свойство

The locale.
protected string $locale
Результат string

$name защищенное свойство

The subdivision name.
protected string $name
Результат string

$parent защищенное свойство

The parent.
protected Subdivision,CommerceGuys\Addressing\Subdivision $parent
Результат Subdivision

$postalCodePattern защищенное свойство

The postal code pattern.
protected string $postalCodePattern
Результат string

$postalCodePatternType защищенное свойство

The postal code pattern type.
protected string $postalCodePatternType
Результат string