ShippingRuleCategories
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\ShippingRuleCategories » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Shipping rule categories 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. |
# 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 a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be 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. |
| createShippingRuleCategory() | Save a shipping rule category. |
| deleteShippingRuleCategoryById() | Delete a shipping rule category 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. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getShippingRuleCategoriesByRuleId() | Returns an array of shipping rules categories per the rule's ID. |
| 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 for this component. |
| 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. |
| trigger() (opens new window) | Triggers an event. |
# createShippingRuleCategory()
Save a shipping rule category.
View source (opens new window)
Arguments
$model(craft\commerce\models\ShippingRuleCategory) – The shipping rule model.$runValidation(boolean (opens new window)) – Should we validate this rule category before saving.
Returns
boolean (opens new window) – Whether the save was successful.
# deleteShippingRuleCategoryById()
Delete a shipping rule category by its ID.
View source (opens new window)
Arguments
$id(integer (opens new window)) – The shipping rule category ID.
Returns
boolean (opens new window) – Whether the category was deleted successfully.
Throws
# getShippingRuleCategoriesByRuleId()
Returns an array of shipping rules categories per the rule's ID.
View source (opens new window)
Arguments
$ruleId(integer (opens new window)) – The rule's ID
Returns
craft\commerce\models\ShippingRuleCategory[] – An array of matched shipping rule categories.