CountryManagerInterface.php in Ubercart 8.4
Namespace
Drupal\uc_countryFile
uc_country/src/CountryManagerInterface.phpView source
<?php
namespace Drupal\uc_country;
/**
* Defines a common interface for country managers.
*/
interface CountryManagerInterface extends \Drupal\Core\Locale\CountryManagerInterface {
/**
* Returns a list of all available country code => country name pairs.
*
* @return array
* An array of country code => country name pairs.
*/
public function getAvailableList();
/**
* Returns a list of country code => country name pairs for enabled countries.
*
* @return array
* An array of country code => country name pairs.
*/
public function getEnabledList();
/**
* Returns the uc_country config entity with the specified country code.
*
* @param string $alpha_2
* The two-character ISO 3166 country code.
*
* @return \Drupal\uc_country\Entity\Country
* The uc_country config entity with the specified country code.
*/
public function getCountry($alpha_2);
/**
* Returns all uc_country config entities with the specified propertes.
*
* For example:
* To obtain all enabled countries, use getByProperty(['status' => TRUE]).
* To obtain the country with the two-character ISO 3166 code of 'ES', use
* getByProperty(['alpha_2' => 'ES']). Any property/properties defined in
* \Drupal\uc_country\Entity\Country may be used. Keep in mind that in most
* cases these properties are <em>unique</em>, so this method will return
* only one country configuration entity.
*
* @param array $properties
* An associative array where the keys are the property names and the values
* are the values those properties must have.
*
* @return \Drupal\uc_country\Entity\Country
* An array of \Drupal\uc_country\Entity\Country configuration entities,
* keyed by Id.
*/
public function getByProperty(array $properties);
/**
* Returns a list of zone code => zone name pairs for the specified country.
*
* @param string $alpha_2
* The two-character ISO 3166 country code.
*
* @return array
* An array of zone code => zone name pairs.
*/
public function getZoneList($alpha_2);
}
Interfaces
Name![]() |
Description |
---|---|
CountryManagerInterface | Defines a common interface for country managers. |