Craft Commerce 5 Class Reference

Appearance

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 ​

PropertyDescription
allShippingCategoriesarray, craft\commerce\models\ShippingCategory[] – all Shipping Categories
allShippingCategoriesAsListarray
behaviorsyii\base\Behavior – List of behaviors attached to this component.
defaultShippingCategorynull, craft\commerce\models\ShippingCategory – the default shipping category

allShippingCategories ​

Type
array, craft\commerce\models\ShippingCategory[]
Default value
null

all Shipping Categories

View source

allShippingCategoriesAsList ​

Type
array
Default value
null

View source

defaultShippingCategory ​

Type
null, craft\commerce\models\ShippingCategory
Default value
null

the default shipping category

View source

Public Methods ​

MethodDescription
__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.
clearCaches()
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.

clearCaches() ​

Since
5.0.0

View source

Returns ​

void

deleteShippingCategoryById() ​

View source

Arguments ​

  • $id

Throws ​

getAllShippingCategories() ​

Returns all Shipping Categories

View source

Arguments ​

Returns ​

\Illuminate\Support\Collection

Throws ​

getAllShippingCategoriesAsList() ​

Returns all Shipping category names, by ID.

View source

Arguments ​

  • $storeId

Throws ​

getDefaultShippingCategory() ​

Returns the default shipping category.

View source

Arguments ​

  • $storeId

Throws ​

getShippingCategoriesByProductTypeId() ​

View source

Arguments ​

Returns ​

array

Throws ​

getShippingCategoryByHandle() ​

Get a shipping category by its handle.

View source

Arguments ​

  • $shippingCategoryHandle
  • $storeId

Throws ​

getShippingCategoryById() ​

Get a shipping category by its ID.

View source

Arguments ​

Returns ​

craft\commerce\models\ShippingCategory, null

Throws ​

saveShippingCategory() ​

View source

Arguments ​

  • $shippingCategory
  • $runValidation (boolean) – Should we validate this before saving.

Throws ​