PHP Class 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.

Inheritance: extends DefaultFormatter, implements CommerceGuys\Addressing\Formatter\PostalLabelFormatterInterface

Afficher le fichier Open project: commerceguys/addressing Class Usage Examples

Protected Properties

Свойство	Type	Description
$originCountryCode	string	The origin country code.

Méthodes publiques

Méthode	Description
__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 )

Méthodes protégées

Méthode	Description
buildView ( CommerceGuys\Addressing\AddressInterface $address, AddressFormat $addressFormat )
getDefaultOptions ( )

Method Details

__construct() public méthode

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 méthode

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

format() public méthode

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

getDefaultOptions() protected méthode

protected getDefaultOptions ( )

getOriginCountryCode() public méthode

public getOriginCountryCode ( )

setOriginCountryCode() public méthode

public setOriginCountryCode ( $originCountryCode )

Property Details

$originCountryCode protected_oe property

The origin country code.

protected string $originCountryCode
Résultat	string