PHP Interface CommerceGuys\Zone\Model\ZoneMemberInterface

Show file Open project: commerceguys/zone

Public Methods

Method	Description
getId ( ) : string	Gets the zone member id.
getName ( ) : string	Gets the zone member name.
getParentZone ( ) : CommerceGuys\Zone\Model\ZoneInterface \| null	Gets the parent zone.
match ( CommerceGuys\Addressing\AddressInterface $address ) : boolean	Checks whether the provided address belongs to the zone member.

Method Details

getId() public method

Gets the zone member id.

public getId ( ) : string
return	string	The zone member id.

getName() public method

Gets the zone member name.

public getName ( ) : string
return	string	The zone member name.

getParentZone() public method

Gets the parent zone.

public getParentZone ( ) : CommerceGuys\Zone\Model\ZoneInterface \| null
return	CommerceGuys\Zone\Model\ZoneInterface \| null	The parent zone, if set.

match() public method

Checks whether the provided address belongs to the zone member.

public match ( CommerceGuys\Addressing\AddressInterface $address ) : boolean
$address	CommerceGuys\Addressing\AddressInterface	The address.
return	boolean	True if the provided address belongs to the zone member, false otherwise.