Countries
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Countries » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Country service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| allCountries | craft\commerce\models\Country[] – An array of all countries. |
| allCountriesAsList | array (opens new window) |
| allCountriesListData | array (opens new window) |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component |
# allCountries
- Type
- craft\commerce\models\Country[]
- Access
- Read-only
An array of all countries.
View source (opens new window)
# allCountriesAsList
- Type
- array (opens new window)
- Access
- Read-only
View source (opens new window)
# allCountriesListData
- Type
- array (opens new window)
- Access
- Read-only
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| deleteCountryById() | Deletes a country by its ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getAllCountries() | Returns an array of all countries. |
| getAllCountriesAsList() | Returns all country names, indexed by ID. |
| getAllCountriesListData() | Returns all country names, indexed by ID. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getCountriesByShippingZoneId() | Returns all countries in a shipping zone, per the shipping zone's ID. |
| getCountriesByTaxZoneId() | Returns all countries in a tax zone, per the tax zone's ID. |
| getCountryById() | Returns a country by its ID. |
| getCountryByIso() | Returns a country by its ISO code. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
| init() (opens new window) | Initializes the object. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| reorderCountries() | |
| saveCountry() | Saves a country. |
| trigger() (opens new window) | Triggers an event. |
# deleteCountryById()
Deletes a country by its ID.
View source (opens new window)
Arguments
$id(integer (opens new window)) – The country's ID
Returns
boolean (opens new window) – Whether the country was deleted successfully
# getAllCountries()
Returns an array of all countries.
View source (opens new window)
Returns
craft\commerce\models\Country[] – An array of all countries.
# getAllCountriesAsList()
Returns all country names, indexed by ID.
View source (opens new window)
Returns
# getAllCountriesListData()
DEPRECATED
Deprecated as of 2.0
Returns all country names, indexed by ID.
View source (opens new window)
Returns
# getCountriesByShippingZoneId()
Returns all countries in a shipping zone, per the shipping zone's ID.
View source (opens new window)
Arguments
$shippingZoneId(integer (opens new window)) – The shipping zone's ID
Returns
craft\commerce\models\Country[] – An array of countries in the matched shipping zone.
# getCountriesByTaxZoneId()
Returns all countries in a tax zone, per the tax zone's ID.
View source (opens new window)
Arguments
$taxZoneId(integer (opens new window)) – The tax zone's ID
Returns
craft\commerce\models\Country[] – An array of countries in the matched tax zone
# getCountryById()
Returns a country by its ID.
View source (opens new window)
Arguments
$id(integer (opens new window)) – The country's ID
Returns
craft\commerce\models\Country, null (opens new window)
# getCountryByIso()
Returns a country by its ISO code.
View source (opens new window)
Arguments
$iso(string (opens new window)) – The country's ISO code
Returns
craft\commerce\models\Country, null (opens new window)
# reorderCountries()
- Since
- 2.2
View source (opens new window)
Arguments
$ids(array (opens new window))
Returns
Throws
# saveCountry()
Saves a country.
View source (opens new window)
Arguments
$country(craft\commerce\models\Country) – The country to be saved.$runValidation(boolean (opens new window)) – Should we validate this country before saving.
Returns
boolean (opens new window) – Whether the country was saved successfully.
Throws
- yii\base\Exception (opens new window)
if the country does not exist.
← Carts Currencies →