Skip to content

StoreLocationBehavior ​

Type
Class
Namespace
craft\commerce\behaviors
Inherits
craft\commerce\behaviors\StoreLocationBehavior » yii\base\Behavior » yii\base\BaseObject
Implements
yii\base\Configurable

View source

Public Properties ​

PropertyDescription
ownercraft\elements\Address

owner ​

Type
craft\elements\Address
Default value
null

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
attach()Attaches the behavior object to the component.
authorize()
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detach()Detaches the behavior object from the component.
events()Declares event handlers for the owner's events.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
saveStoreLocation()

attach() ​

Attaches the behavior object to the component.

The default implementation will set the owner property and attach event handlers as declared in events(). Make sure you call the parent implementation if you override this method.

View source

Arguments ​

  • $owner (yii\base\Component) – The component that this behavior is to be attached to.

authorize() ​

View source

Arguments ​

Returns ​

void

events() ​

Declares event handlers for the owner's events.

Child classes may override this method to declare what PHP callbacks should be attached to the events of the owner component.

The callbacks will be attached to the owner's events when the behavior is attached to the owner; and they will be detached from the events when the behavior is detached from the component.

The callbacks can be any of the following:

  • method in this behavior: 'handleClick', equivalent to [$this, 'handleClick']
  • object method: [$object, 'handleClick']
  • static method: ['Page', 'handleClick']
  • anonymous function: function ($event) { ... }

The following is an example:

php
[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]

View source

Returns ​

array – Events (array keys) and the corresponding event handler methods (array values).

saveStoreLocation() ​

View source

Arguments ​

Returns ​

void