PHP Класс CommerceGuys\Addressing\Formatter\PostalLabelFormatter

Takes care of uppercasing fields where required by the format (to faciliate automated mail sorting). Requires specifying the origin country code, allowing it to differentiate between domestic and international mail. In case of domestic mail, the country name is not displayed at all. In case of international mail: 1. The postal code is prefixed with the destination's postal code prefix. 2. The country name is added to the formatted address, in both the current locale and English. This matches the recommandation given by the Universal Postal Union, to avoid difficulties in countries of transit.
Наследование: extends DefaultFormatter, implements CommerceGuys\Addressing\Formatter\PostalLabelFormatterInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$originCountryCode string The origin country code.

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

Метод Описание
__construct ( CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface $addressFormatRepository, CommerceGuys\Addressing\Country\CountryRepositoryInterface $countryRepository, CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface $subdivisionRepository, string $originCountryCode = null, string $locale = null, array $options = [] ) Creates a PostalFormatter instance.
format ( CommerceGuys\Addressing\AddressInterface $address )
getOriginCountryCode ( )
setOriginCountryCode ( $originCountryCode )

Защищенные методы

Метод Описание
buildView ( CommerceGuys\Addressing\AddressInterface $address, AddressFormat $addressFormat )
getDefaultOptions ( )

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

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

Creates a PostalFormatter instance.
public __construct ( CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface $addressFormatRepository, CommerceGuys\Addressing\Country\CountryRepositoryInterface $countryRepository, CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface $subdivisionRepository, string $originCountryCode = null, string $locale = null, array $options = [] )
$addressFormatRepository CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface
$countryRepository CommerceGuys\Addressing\Country\CountryRepositoryInterface
$subdivisionRepository CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface
$originCountryCode string
$locale string
$options array

buildView() защищенный Метод

protected buildView ( CommerceGuys\Addressing\AddressInterface $address, AddressFormat $addressFormat )
$address CommerceGuys\Addressing\AddressInterface
$addressFormat CommerceGuys\Addressing\AddressFormat\AddressFormat

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

public format ( CommerceGuys\Addressing\AddressInterface $address )
$address CommerceGuys\Addressing\AddressInterface

getDefaultOptions() защищенный Метод

protected getDefaultOptions ( )

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

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

public setOriginCountryCode ( $originCountryCode )

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

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

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