API Documentation
Back to top  

CustomerCountryZoneReaderInterface

Extends

Interface CustomerCountryZoneReaderInterface

category

System
package

Customer
subpackage

Interfaces

Methods

Method to find a country zone with a given ID if it exists else it will return null

findById(\IdType $countryZoneId) : \CustomerCountryZone|null
Throws
\InvalidArgumentException

if $p_countryZoneName is not a string

Arguments

$countryZoneId

\IdType

Response

\CustomerCountryZone|null

Method to find a country zone with a given name if it exists else it will return null

findByName(\CustomerCountryZoneNameInterface $countryZoneName) : \CustomerCountryZone|null
Throws
\InvalidArgumentException

if $p_countryZoneName is not a string

Arguments

$countryZoneName

\CustomerCountryZoneNameInterface

Response

\CustomerCountryZone|null

Returns an array with country zone data.

findCountryZoneByZoneCodeAndCountry(\CustomerCountryZoneIsoCodeInterface $zoneCode, \CustomerCountryInterface $country) : \CustomerCountryZoneInterface|null

An empty array will be returned if no results are found.

Arguments

$zoneCode

\CustomerCountryZoneIsoCodeInterface

Zone code of expected country zone.

$country

\CustomerCountryInterface

Country of zone.

Response

\CustomerCountryZoneInterface|null

Country zone.

Returns an array with country zone data.

findCountryZoneByZoneCodeAndCountryId(\CustomerCountryZoneIsoCodeInterface $zoneCode, \IdType $countryId) : \CustomerCountryZoneInterface|null

An empty array will be returned if no results are found.

Arguments

$zoneCode

\CustomerCountryZoneIsoCodeInterface

Zone code of expected country zone.

$countryId

\IdType

Country id of zone.

Response

\CustomerCountryZoneInterface|null

Country zone.

Method to find a country zone with a given country ID if it exists else it will return an empty array

findCountryZonesByCountryId(\IdType $countryId) : array
Throws
\InvalidArgumentException

Arguments

$countryId

\IdType

Response

array

of CustomerCountryZone objects|empty array