ShippingCategories

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\ShippingCategories » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Shipping category service.

View source

# Public Properties

# allShippingCategories

Type
craft\commerce\models\ShippingCategory[]
Access
Read-only

View source

# allShippingCategoriesAsList

Type
array
Access
Read-only

View source

# defaultShippingCategory

Type
craft\commerce\models\ShippingCategory, null
Access
Read-only

View source

# 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.
deleteShippingCategoryById()
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.
getAllShippingCategories() Returns all Shipping Categories
getAllShippingCategoriesAsList() Returns all Shipping category names, by ID.
getBehavior() Returns the named behavior object.
getBehaviors() 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() 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.
saveShippingCategory()
trigger() Triggers an event.

# deleteShippingCategoryById()

View source

Arguments

Returns

boolean

# getAllShippingCategories()

Returns all Shipping Categories

View source

Returns

craft\commerce\models\ShippingCategory[]

# getAllShippingCategoriesAsList()

Returns all Shipping category names, by ID.

View source

Returns

array

# getDefaultShippingCategory()

Returns the default shipping category.

View source

Returns

craft\commerce\models\ShippingCategory, null

# getShippingCategoriesByProductTypeId()

View source

Arguments

  • $productTypeId

Returns

array

# getShippingCategoryByHandle()

Get a shipping category by its handle.

View source

Arguments

Returns

craft\commerce\models\ShippingCategory, null

# getShippingCategoryById()

Get a shipping category by its ID.

View source

Arguments

Returns

craft\commerce\models\ShippingCategory, null

# saveShippingCategory()

View source

Arguments

Returns

boolean

Throws