Interface CountryServiceInterface

Interface CountryServiceInterface

Direct known implementers

CountryService

Package: Customer\Interfaces
Category: System
Located at Services/Core/Country/Interfaces/CountryServiceInterface.inc.php

Methods summary

`public CustomerCountryInterface`	# `getCountryById( IdType $id )` Method to get a country with a given id Method to get a country with a given id Parameters `$id` Returns `CustomerCountryInterface`
`public CustomerCountryZoneInterface`	# `getCountryZoneByNameAndCountry( CustomerCountryZoneNameInterface\|string $p_zoneName, CustomerCountryInterface $customerCountry )` Method to get a country with a given name and country Method to get a country with a given name and country Parameters `$p_zoneName` `$customerCountry` Returns `CustomerCountryZoneInterface`
`public CustomerCountryZoneInterface\|null`	# `findCountryZoneByNameAndCountry( CustomerCountryZoneNameInterface\|string $p_zoneName, CustomerCountryInterface $customerCountry )` This method returns a CustomerCountryZone object if found. Otherwise null will be returned. This method returns a CustomerCountryZone object if found. Otherwise null will be returned. Parameters `$p_zoneName` `$customerCountry` Returns `CustomerCountryZoneInterface`\|null
`public boolean`	# `countryZoneExistsInCountry( CustomerCountryZoneInterface $customerCountryZone, CustomerCountryInterface $customerCountry )` Method to check if a country zone exists in a country Method to check if a country zone exists in a country Parameters `$customerCountryZone` `$customerCountry` Returns boolean
`public boolean`	# `countryHasCountryZones( CustomerCountryInterface $customerCountry )` Method to check if a country has country zones Method to check if a country has country zones Parameters `$customerCountry` Returns boolean
`public CustomerCountryZone`	# `getUnknownCountryZoneByName( string $p_zoneName )` This method will return a new CustomerCountryZone object representing an unknown country zone. This method will return a new CustomerCountryZone object representing an unknown country zone. Parameters `$p_zoneName` Returns `CustomerCountryZone`
`public array`	# `findCountryZonesByCountryId( IdType $countryId )` This method will return an array of CustomerCountryZone objects found by the country ID. If the country has no zones, an empty array will be returned This method will return an array of CustomerCountryZone objects found by the country ID. If the country has no zones, an empty array will be returned Parameters `$countryId` Returns array of CustomerCountryZone objects
`public CustomerCountryInterface`	# `getCountryByName( string $p_countryName )` Get country by name. Get country by name. Parameters `$p_countryName` Returns `CustomerCountryInterface`
`public CustomerCountryInterface`	# `findCountryByName( string $p_countryName )` Find country by name. Find country by name. Parameters `$p_countryName` Returns `CustomerCountryInterface`
`public CustomerCountryInterface`	# `getCountryByIso2( string $p_countryIso2 )` Get country by iso2 code. Get country by iso2 code. Parameters `$p_countryIso2` Returns `CustomerCountryInterface`
`public CustomerCountryInterface`	# `findCountryByIso2( string $p_countryIso2 )` Find country by iso2 code. Find country by iso2 code. Parameters `$p_countryIso2` Returns `CustomerCountryInterface`
`public boolean`	# `isStateMandatory( IdType $countryId )` This method returns whether the specified country, necessary, needs a state. This method returns whether the specified country, necessary, needs a state. Parameters `$countryId` Returns boolean
`public CustomerCountryZoneInterface`	# `getCountryZoneByZoneCodeAndCountry( CustomerCountryZoneIsoCode $zoneCode, CustomerCountryInterface $country )` Returns the country zone by the given zone code and country. An error will be raised if no results are found. Returns the country zone by the given zone code and country. An error will be raised if no results are found. Parameters `$zoneCode` Zone code of expected country zone. `$country` Country of zone. Returns `CustomerCountryZoneInterface` Country zone model.
`public CustomerCountryZoneInterface`	# `getCountryZoneByZoneCodeAndCountryId( CustomerCountryZoneIsoCode $zoneCode, IdType $countryId )` Returns the country zone by the given zone code and country id. An error will be raised if no results are found. Returns the country zone by the given zone code and country id. An error will be raised if no results are found. Parameters `$zoneCode` Zone code of expected country zone. `$countryId` Country id of zone. Returns `CustomerCountryZoneInterface` Country zone model.
`public CustomerCountryZoneInterface\|null`	# `findCountryZoneByZoneCodeAndCountry( CustomerCountryZoneIsoCode $zoneCode, CustomerCountryInterface $country )` Finds the country zone by the given zone code and country. Null will be returned if no results are found. Finds the country zone by the given zone code and country. Null will be returned if no results are found. Parameters `$zoneCode` Zone code of expected country zone. `$country` Country of zone. Returns `CustomerCountryZoneInterface`\|null Country zone model, if found.
`public CustomerCountryZoneInterface`	# `findCountryZoneByZoneCodeAndCountryId( CustomerCountryZoneIsoCode $zoneCode, IdType $countryId )` Returns the country zone by the given zone code and country id. Null will be returned if no results are found. Returns the country zone by the given zone code and country id. Null will be returned if no results are found. Parameters `$zoneCode` Zone code of expected country zone. `$countryId` Country id of zone. Returns `CustomerCountryZoneInterface` Country zone model, if found.