ShippingCategories
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\ShippingCategories » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Shipping category service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| allShippingCategories | array (opens new window), craft\commerce\models\ShippingCategory[] – all Shipping Categories |
| allShippingCategoriesAsList | array (opens new window) |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| defaultShippingCategory | null (opens new window), craft\commerce\models\ShippingCategory – the default shipping category |
# allShippingCategories
- Type
- array (opens new window), craft\commerce\models\ShippingCategory[]
- Default value
null
all Shipping Categories
View source (opens new window)
# allShippingCategoriesAsList
- Type
- array (opens new window)
- Default value
null
View source (opens new window)
# defaultShippingCategory
- Type
- null (opens new window), craft\commerce\models\ShippingCategory
- Default value
null
the default shipping category
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 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. |
| deleteShippingCategoryById() | |
| 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. |
| getAllShippingCategories() | Returns all Shipping Categories |
| getAllShippingCategoriesAsList() | Returns all Shipping category names, by ID. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getDefaultShippingCategory() | Returns the default shipping category. |
| getShippingCategoriesByProductTypeId() | |
| getShippingCategoryByHandle() | Get a shipping category by its handle. |
| getShippingCategoryById() | Get a shipping category by its 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. |
| saveShippingCategory() | |
| trigger() (opens new window) | Triggers an event. |
# deleteShippingCategoryById()
View source (opens new window)
Arguments
$id
Throws
# getAllShippingCategories()
Returns all Shipping Categories
View source (opens new window)
Arguments
$withTrashed(boolean (opens new window))
Returns
array (opens new window), craft\commerce\models\ShippingCategory[]
# getAllShippingCategoriesAsList()
Returns all Shipping category names, by ID.
View source (opens new window)
# getDefaultShippingCategory()
Returns the default shipping category.
View source (opens new window)
Throws
# getShippingCategoriesByProductTypeId()
View source (opens new window)
Arguments
$productTypeId(integer (opens new window))
Returns
Throws
# getShippingCategoryByHandle()
Get a shipping category by its handle.
View source (opens new window)
Arguments
$shippingCategoryHandle
# getShippingCategoryById()
Get a shipping category by its ID.
View source (opens new window)
Arguments
$shippingCategoryId
# saveShippingCategory()
View source (opens new window)
Arguments
$shippingCategory$runValidation(boolean (opens new window)) – Should we validate this before saving.
Throws
← Sales ShippingMethods →