RegisterAvailableShippingMethodsEvent ​
- Type
- Class
- Namespace
- craft\commerce\events
- Inherits
- craft\commerce\events\RegisterAvailableShippingMethodsEvent » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0
RegisterAvailableShippingMethodsEvent class.
Public Properties ​
Property | Description |
---|---|
data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
handled | boolean – Whether the event is handled. |
name | string – The event name. |
order | craft\commerce\elements\Order – The order the shipping method should be available for |
sender | object, null – The sender of this event. |
shippingMethods | \Illuminate\Support\Collection<\craft\commerce\base\ShippingMethodInterface> |
order
​
- Type
- craft\commerce\elements\Order
- Default value
null
The order the shipping method should be available for
shippingMethods
​
- Type
\Illuminate\Support\Collection<\craft\commerce\base\ShippingMethodInterface>
- Default value
null
- Since
- 5.0.0
Public Methods ​
Method | Description |
---|---|
__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. |
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. |
getShippingMethods() | |
hasHandlers() | Returns a value indicating whether there is any handler attached to the specified class-level event. |
hasMethod() | Returns a value indicating whether a method is defined. |
hasProperty() | Returns a value indicating whether a property is defined. |
init() | Initializes the object. |
off() | Detaches an event handler from a class-level event. |
offAll() | Detaches all registered class-level event handlers. |
on() | Attaches an event handler to a class-level event. |
setShippingMethods() | |
trigger() | Triggers a class-level event. |
getShippingMethods()
​
- Since
- 5.0.0
Returns ​
\Illuminate\Support\Collection<\craft\commerce\base\ShippingMethodInterface>
setShippingMethods()
​
- Since
- 5.0.0
Arguments ​
$shippingMethods
(\Illuminate\Support\Collection
, array)
Returns ​
void