TaxCategories

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

Tax category service.

View source

Public Properties

$allTaxCategories

Signature

public craft\commerce\models\TaxCategory[] getAllTaxCategories ( )

$allTaxCategoriesAsList

Type
array
Access
Read-only

View source

Signature

public array getAllTaxCategoriesAsList ( )

$defaultTaxCategory

Signature

public craft\commerce\models\TaxCategory, null getDefaultTaxCategory ( )

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.
deleteTaxCategoryById()
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.
getAllTaxCategories()Returns all Tax Categories
getAllTaxCategoriesAsList()Returns all Tax categories, indexed by ID.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getDefaultTaxCategory()Get the default tax category
getTaxCategoriesByProductTypeId()
getTaxCategoryByHandle()Get a tax category by its handle.
getTaxCategoryById()Get a tax 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.
saveTaxCategory()Save a tax category.
trigger()Triggers an event.

deleteTaxCategoryById()

View source

Arguments

Returns

boolean

Signature

public boolean deleteTaxCategoryById ( $id )

getAllTaxCategories()

Returns all Tax Categories

View source

Returns

craft\commerce\models\TaxCategory[]

Signature

public craft\commerce\models\TaxCategory[] getAllTaxCategories ( )

getAllTaxCategoriesAsList()

Returns all Tax categories, indexed by ID.

View source

Returns

array

Signature

public array getAllTaxCategoriesAsList ( )

getDefaultTaxCategory()

Get the default tax category

View source

Returns

craft\commerce\models\TaxCategory, null

Signature

public craft\commerce\models\TaxCategory, null getDefaultTaxCategory ( )

getTaxCategoriesByProductTypeId()

View source

Arguments

  • $productTypeId

Returns

array

Signature

public array getTaxCategoriesByProductTypeId ( $productTypeId )

getTaxCategoryByHandle()

Get a tax category by its handle.

View source

Arguments

Returns

craft\commerce\models\TaxCategory, null

Signature

public craft\commerce\models\TaxCategory, null getTaxCategoryByHandle ( $taxCategoryHandle )

getTaxCategoryById()

Get a tax category by its ID.

View source

Arguments

Returns

craft\commerce\models\TaxCategory, null

Signature

public craft\commerce\models\TaxCategory, null getTaxCategoryById ( $taxCategoryId )

saveTaxCategory()

Save a tax category.

View source

Arguments

Returns

boolean

Throws

Signature

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