PHP Interface CommerceGuys\Zone\Model\ZoneInterface

Show file Open project: commerceguys/zone Interface Usage Examples

Public Methods

Method	Description
getId ( ) : string	Gets the zone id.
getMembers ( ) : CommerceGuys\Zone\Model\ZoneMemberInterface[]	Gets the zone members.
getName ( ) : string	Gets the zone name.
getPriority ( ) : integer	Gets the zone priority.
getScope ( ) : string	Gets the zone scope.
hasMembers ( ) : boolean	Checks whether the zone has zone members.
match ( CommerceGuys\Addressing\AddressInterface $address ) : boolean	Checks whether the provided address belongs to the zone.

Method Details

getId() public method

Gets the zone id.

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

getMembers() public method

Gets the zone members.

public getMembers ( ) : CommerceGuys\Zone\Model\ZoneMemberInterface[]
return	CommerceGuys\Zone\Model\ZoneMemberInterface[]	The zone members.

getName() public method

Gets the zone name.

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

getPriority() public method

Zones with higher priority will be matched first.

public getPriority ( ) : integer
return	integer	The zone priority.

getScope() public method

Gets the zone scope.

public getScope ( ) : string
return	string	The zone scope.

hasMembers() public method

Checks whether the zone has zone members.

public hasMembers ( ) : boolean
return	boolean	True if the zone has zone members, false otherwise.

match() public method

Checks whether the provided address belongs to the zone.

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