CustomerCountryZoneReaderInterface
in
Interface CustomerCountryZoneReaderInterface
Tags
Table of Contents
- findById() : CustomerCountryZone|null
- Method to find a country zone with a given ID if it exists else it will return null
- findByName() : CustomerCountryZone|null
- Method to find a country zone with a given name if it exists else it will return null
- findCountryZoneByZoneCodeAndCountry() : CustomerCountryZoneInterface|null
- Returns an array with country zone data.
- findCountryZoneByZoneCodeAndCountryId() : CustomerCountryZoneInterface|null
- Returns an array with country zone data.
- findCountryZonesByCountryId() : array<string|int, mixed>
- Method to find a country zone with a given country ID if it exists else it will return an empty array
Methods
findById()
Method to find a country zone with a given ID if it exists else it will return null
public
findById(IdType $countryZoneId) : CustomerCountryZone|null
Parameters
- $countryZoneId : IdType
Tags
Return values
CustomerCountryZone|null —findByName()
Method to find a country zone with a given name if it exists else it will return null
public
findByName(CustomerCountryZoneNameInterface $countryZoneName) : CustomerCountryZone|null
Parameters
- $countryZoneName : CustomerCountryZoneNameInterface
Tags
Return values
CustomerCountryZone|null —findCountryZoneByZoneCodeAndCountry()
Returns an array with country zone data.
public
findCountryZoneByZoneCodeAndCountry(CustomerCountryZoneIsoCodeInterface $zoneCode, CustomerCountryInterface $country) : CustomerCountryZoneInterface|null
An empty array will be returned if no results are found.
Parameters
- $zoneCode : CustomerCountryZoneIsoCodeInterface
-
Zone code of expected country zone.
- $country : CustomerCountryInterface
-
Country of zone.
Return values
CustomerCountryZoneInterface|null —Country zone.
findCountryZoneByZoneCodeAndCountryId()
Returns an array with country zone data.
public
findCountryZoneByZoneCodeAndCountryId(CustomerCountryZoneIsoCodeInterface $zoneCode, IdType $countryId) : CustomerCountryZoneInterface|null
An empty array will be returned if no results are found.
Parameters
- $zoneCode : CustomerCountryZoneIsoCodeInterface
-
Zone code of expected country zone.
- $countryId : IdType
-
Country id of zone.
Return values
CustomerCountryZoneInterface|null —Country zone.
findCountryZonesByCountryId()
Method to find a country zone with a given country ID if it exists else it will return an empty array
public
findCountryZonesByCountryId(IdType $countryId) : array<string|int, mixed>
Parameters
- $countryId : IdType
Tags
Return values
array<string|int, mixed> —of CustomerCountryZone objects|empty array