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.
Public Properties ​
| Property | Description |
|---|---|
| allTaxCategories | craft\commerce\models\TaxCategory[], array – all Tax Categories |
| allTaxCategoriesAsList | array |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| defaultTaxCategory | craft\commerce\models\TaxCategory, null – the default tax category |
allTaxCategories ​
- Type
- craft\commerce\models\TaxCategory[], array
- Default value
null
all Tax Categories
allTaxCategoriesAsList ​
- Type
- array
- Default value
null
defaultTaxCategory ​
- Type
- craft\commerce\models\TaxCategory, null
- Default value
null
the default tax category
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. |
| 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 category names, 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 for this component. |
| 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() ​
Arguments ​
$id(integer)
Returns ​
Throws ​
getAllTaxCategories() ​
Returns all Tax Categories
Arguments ​
$withTrashed(boolean)
Returns ​
craft\commerce\models\TaxCategory[]
getAllTaxCategoriesAsList() ​
Returns all Tax category names, indexed by ID.
getDefaultTaxCategory() ​
Get the default tax category
Throws ​
getTaxCategoriesByProductTypeId() ​
Arguments ​
$productTypeId(integer)
Returns ​
getTaxCategoryByHandle() ​
Get a tax category by its handle.
Arguments ​
$taxCategoryHandle
getTaxCategoryById() ​
Get a tax category by its ID.
Arguments ​
$taxCategoryId
saveTaxCategory() ​
Save a tax category.
Arguments ​
$taxCategory$runValidation(boolean) – Should we validate this state before saving.