PHP Interface CommerceGuys\Addressing\Formatter\FormatterInterface

Show file Open project: commerceguys/addressing

Public Methods

Method	Description
format ( CommerceGuys\Addressing\AddressInterface $address ) : string	Formats an address.
getLocale ( ) : string	Gets the locale.
getOption ( $key ) : array	Gets the option with the provided key.
getOptions ( ) : array	Gets the options.
setLocale ( string $locale )	Sets the locale.
setOption ( string $key, string $value )	Sets the option with the provided key.
setOptions ( array $options )	Sets the options.

Method Details

format() public method

Formats an address.

public format ( CommerceGuys\Addressing\AddressInterface $address ) : string
$address	CommerceGuys\Addressing\AddressInterface	The address.
return	string	The formatted address.

getLocale() public method

Gets the locale.

public getLocale ( ) : string
return	string	The locale.

getOption() public method

Gets the option with the provided key.

public getOption ( $key ) : array
return	array	$options The options.

getOptions() public method

Gets the options.

public getOptions ( ) : array
return	array	$options The options.

setLocale() public method

Sets the locale.

public setLocale ( string $locale )
$locale	string	The locale.

setOption() public method

Sets the option with the provided key.

public setOption ( string $key, string $value )
$key	string	The key.
$value	string	The new value.

setOptions() public method

Sets the options.

public setOptions ( array $options )
$options	array	The options.