API Documentation
Back to top  

CustomerCountryZoneReader

Implements \CustomerCountryZoneReaderInterface

Class CustomerCountryZoneReader

This class is used for reading customer country zone data from the database

category

System
package

Customer
subpackage

CountryZone
implements

CustomerCountryZoneReaderInterface

Methods

Constructor of the class CustomerCountryZoneReader

__construct(\AbstractCustomerFactory $customerFactory, \CI_DB_query_builder $dbQueryBuilder)

Arguments

$customerFactory

\AbstractCustomerFactory

$dbQueryBuilder

\CI_DB_query_builder

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

findById(\IdType $countryZoneId) : \CustomerCountryZone

Arguments

$countryZoneId

\IdType

Response

\CustomerCountryZone

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

findByName(\CustomerCountryZoneNameInterface $countryZoneName) : \CustomerCountryZone

Arguments

$countryZoneName

\CustomerCountryZoneNameInterface

Response

\CustomerCountryZone

findByNameAndCountry

findByNameAndCountry(\CustomerCountryZoneNameInterface $countryZoneName, \CustomerCountryInterface $country) : \CustomerCountryZone|null

Arguments

$countryZoneName

\CustomerCountryZoneNameInterface

$country

\CustomerCountryInterface

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

Arguments

$countryId

\IdType

Response

array

of CustomerCountryZone objects

Properties