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

Signature

public craft\commerce\models\ShippingCategory[] getAllShippingCategories ( )

$defaultShippingCategory

Signature

public craft\commerce\models\ShippingCategory, null getDefaultShippingCategory ( )

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 an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getDefaultShippingCategory()Returns the default shipping category.
getShippingCategoriesByProductId()
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.
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

Signature

public boolean deleteShippingCategoryById ( $id )

getAllShippingCategories()

Returns all Shipping Categories

View source

Returns

craft\commerce\models\ShippingCategory[]

Signature

public craft\commerce\models\ShippingCategory[] getAllShippingCategories ( )

getDefaultShippingCategory()

Returns the default shipping category.

View source

Returns

craft\commerce\models\ShippingCategory, null

Signature

public craft\commerce\models\ShippingCategory, null getDefaultShippingCategory ( )

getShippingCategoriesByProductId()

View source

Arguments

  • $productTypeId

Returns

array

Signature

public array getShippingCategoriesByProductId ( $productTypeId )

getShippingCategoryByHandle()

Get a shipping category by its handle.

View source

Arguments

  • $shippingCategoryHandle (string)

Returns

craft\commerce\models\ShippingCategory, null

Signature

public craft\commerce\models\ShippingCategory, null getShippingCategoryByHandle ( \craft\commerce\services\string $shippingCategoryHandle )

getShippingCategoryById()

Get a shipping category by its ID.

View source

Arguments

Returns

craft\commerce\models\ShippingCategory, null

Signature

public craft\commerce\models\ShippingCategory, null getShippingCategoryById ( \craft\commerce\services\int $shippingCategoryId )

saveShippingCategory()

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveShippingCategory ( craft\commerce\models\ShippingCategory $model, \craft\commerce\services\bool $runValidation = true )