Addresses
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Addresses » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Address service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component |
| storeLocationAddress | craft\commerce\models\Address |
# storeLocationAddress
- Type
- craft\commerce\models\Address
- 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. |
| addressWithinZone() | |
| 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. |
| deleteAddressById() | Deletes an address 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. |
| getAddressById() | Returns an address by its ID. |
| getAddressByIdAndCustomerId() | Returns an address by an address id and customer id. |
| getAddressesByCustomerId() | Returns all of a customer's addresses, by the customer's ID. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getStoreLocationAddress() | Returns the stock location or a blank address if it's not defined. |
| 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. |
| saveAddress() | Saves an address. |
| trigger() (opens new window) | Triggers an event. |
# addressWithinZone()
View source (opens new window)
Arguments
$address(craft\commerce\models\Address)$zone
Returns
# deleteAddressById()
Deletes an address by its ID.
View source (opens new window)
Arguments
$id(integer (opens new window)) – The address' ID
Returns
boolean (opens new window) – Whether the address was deleted successfully
# getAddressById()
Returns an address by its ID.
View source (opens new window)
Arguments
$addressId(integer (opens new window)) – The address' ID
Returns
craft\commerce\models\Address, null (opens new window) – The matched address or null if not found
# getAddressByIdAndCustomerId()
Returns an address by an address id and customer id.
View source (opens new window)
Arguments
$addressId(integer (opens new window)) – The address id$customerId(integer (opens new window)) – The customer's ID
Returns
craft\commerce\models\Address, null (opens new window) – The matched address or null if not found
# getAddressesByCustomerId()
Returns all of a customer's addresses, by the customer's ID.
View source (opens new window)
Arguments
$customerId(integer (opens new window)) – The customer's ID
Returns
craft\commerce\models\Address[] – An array of matched addresses
# getStoreLocationAddress()
Returns the stock location or a blank address if it's not defined.
View source (opens new window)
Returns
# saveAddress()
Saves an address.
View source (opens new window)
Arguments
$addressModel(craft\commerce\models\Address) – The address to be saved.$runValidation(boolean (opens new window)) – Should we validate this address before saving.
Returns
boolean (opens new window) – Whether the address was saved successfully.
Throws
- InvalidArgumentException (opens new window)
if an address does not exist. - yii\db\Exception (opens new window)
# Events
# EVENT_AFTER_DELETE_ADDRESS
The event that is raised after an address is deleted.
Plugins can get notified after an address has been deleted.
use craft\commerce\events\AddressEvent;
use craft\commerce\services\Addresses;
use yii\base\Event;
Event::on(Addresses::class, Addresses::EVENT_AFTER_DELETE_ADDRESS, function(AddressEvent $e) {
// Do something - perhaps remove this address from a payment gateway.
});
# EVENT_AFTER_SAVE_ADDRESS
The event that is raised after an address is saved.
Plugins can get notified after an address has been saved
use craft\commerce\events\AddressEvent;
use craft\commerce\services\Addresses;
use yii\base\Event;
Event::on(Addresses::class, Addresses::EVENT_AFTER_SAVE_ADDRESS, function(AddressEvent $e) {
// Do something - perhaps set this address as default in an external CRM system
});
# EVENT_BEFORE_SAVE_ADDRESS
The event that is raised before an address is saved.
Plugins can get notified before an address is being saved
use craft\commerce\events\AddressEvent;
use craft\commerce\services\Addresses;
use yii\base\Event;
Event::on(Addresses::class, Addresses::EVENT_BEFORE_SAVE_ADDRESS, function(AddressEvent $e) {
// Do something - perhaps let an external CRM system know about a client's new address
});