PHP Class CommerceGuys\Zone\Model\ZoneMemberCountry

Inheritance: extends CommerceGuys\Zone\Model\ZoneMember

Show file Open project: commerceguys/zone

Protected Properties

Property	Type	Description
$administrativeArea	string	The administrative area.
$countryCode	string	The country code.
$dependentLocality	string	The dependent locality.
$excludedPostalCodes	string	Can be a regular expression ("/(35\|38)[0-9]{3}/") or a comma-separated list of postal codes, including ranges ("98, 100:200, 250").
$includedPostalCodes	string	Can be a regular expression ("/(35\|38)[0-9]{3}/") or a comma-separated list of postal codes, including ranges ("98, 100:200, 250").
$locality	string	The locality.

Public Methods

Method	Description
getAdministrativeArea ( ) : string \| null	Gets the administrative area.
getCountryCode ( ) : string	Gets the country code.
getDependentLocality ( ) : string \| null	Gets the dependent locality.
getExcludedPostalCodes ( ) : string	Gets the excluded postal codes.
getIncludedPostalCodes ( ) : string	Gets the included postal codes.
getLocality ( ) : string \| null	Gets the locality.
match ( CommerceGuys\Addressing\AddressInterface $address )
setAdministrativeArea ( string \| null $administrativeArea = null ) : self	Sets the administrative area.
setCountryCode ( string $countryCode ) : self	Sets the country code.
setDependentLocality ( string \| null $dependentLocality = null ) : self	Sets the dependent locality.
setExcludedPostalCodes ( string $excludedPostalCodes ) : self	Sets the excluded postal codes.
setIncludedPostalCodes ( string $includedPostalCodes ) : self	Sets the included postal codes.
setLocality ( string \| null $locality = null ) : self	Sets the locality.

Method Details

getAdministrativeArea() public method

Gets the administrative area.

public getAdministrativeArea ( ) : string \| null
return	string \| null	The administrative area, or null if all should match.

getCountryCode() public method

Gets the country code.

public getCountryCode ( ) : string
return	string	The country code.

getDependentLocality() public method

Gets the dependent locality.

public getDependentLocality ( ) : string \| null
return	string \| null	The dependent locality, or null if all should match.

getExcludedPostalCodes() public method

Gets the excluded postal codes.

public getExcludedPostalCodes ( ) : string
return	string	The excluded postal codes.

getIncludedPostalCodes() public method

Gets the included postal codes.

public getIncludedPostalCodes ( ) : string
return	string	The included postal codes.

getLocality() public method

Gets the locality.

public getLocality ( ) : string \| null
return	string \| null	The locality, or null if all should match.

match() public method

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

setAdministrativeArea() public method

Sets the administrative area.

public setAdministrativeArea ( string \| null $administrativeArea = null ) : self
$administrativeArea	string \| null	The administrative area.
return	self

setCountryCode() public method

Sets the country code.

public setCountryCode ( string $countryCode ) : self
$countryCode	string	The country code.
return	self

setDependentLocality() public method

Sets the dependent locality.

public setDependentLocality ( string \| null $dependentLocality = null ) : self
$dependentLocality	string \| null	The dependent locality.
return	self

setExcludedPostalCodes() public method

Sets the excluded postal codes.

public setExcludedPostalCodes ( string $excludedPostalCodes ) : self
$excludedPostalCodes	string	The excluded postal codes.
return	self

setIncludedPostalCodes() public method

Sets the included postal codes.

public setIncludedPostalCodes ( string $includedPostalCodes ) : self
$includedPostalCodes	string	The included postal codes.
return	self

setLocality() public method

Sets the locality.

public setLocality ( string \| null $locality = null ) : self
$locality	string \| null	The locality.
return	self

Property Details

$administrativeArea protected property

The administrative area.

protected string $administrativeArea
return	string

$countryCode protected property

The country code.

protected string $countryCode
return	string

$dependentLocality protected property

The dependent locality.

protected string $dependentLocality
return	string

$excludedPostalCodes protected property

Can be a regular expression ("/(35|38)[0-9]{3}/") or a comma-separated list of postal codes, including ranges ("98, 100:200, 250").

protected string $excludedPostalCodes
return	string

$includedPostalCodes protected property

Can be a regular expression ("/(35|38)[0-9]{3}/") or a comma-separated list of postal codes, including ranges ("98, 100:200, 250").

protected string $includedPostalCodes
return	string

$locality protected property

The locality.

protected string $locality
return	string