ShippingRuleCategories ​
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\ShippingRuleCategories » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 2.0
Shipping rule categories service.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| 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. |
| createShippingRuleCategory() | Save a shipping rule category. |
| deleteShippingRuleCategoryById() | Delete a shipping rule category by its ID. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getShippingRuleCategoriesByRuleId() | Returns an array of shipping rules categories per the rule's ID. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| trigger() | Triggers an event. |
createShippingRuleCategory() ​
Save a shipping rule category.
Arguments ​
$model(craft\commerce\models\ShippingRuleCategory) – The shipping rule model.$runValidation(boolean) – Should we validate this rule category before saving.
Returns ​
boolean – Whether the save was successful.
deleteShippingRuleCategoryById() ​
Delete a shipping rule category by its ID.
Arguments ​
$id(integer) – The shipping rule category ID.
Returns ​
boolean – Whether the category was deleted successfully.
Throws ​
getShippingRuleCategoriesByRuleId() ​
Returns an array of shipping rules categories per the rule's ID.
Arguments ​
$ruleId(integer) – The rule's ID
Returns ​
craft\commerce\models\ShippingRuleCategory[] – An array of matched shipping rule categories.