TaxCategories
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\TaxCategories » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Tax category service.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
allTaxCategories | craft\commerce\models\TaxCategory[] |
allTaxCategoriesAsList | array (opens new window) |
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component |
defaultTaxCategory | craft\commerce\models\TaxCategory, null (opens new window) |
# allTaxCategories
- Type
- craft\commerce\models\TaxCategory[]
- Access
- Read-only
View source (opens new window)
# allTaxCategoriesAsList
- Type
- array (opens new window)
- Access
- Read-only
View source (opens new window)
# defaultTaxCategory
- Type
- craft\commerce\models\TaxCategory, null (opens new window)
- Access
- Read-only
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__unset() (opens new window) | Sets an object property to null. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
deleteTaxCategoryById() | |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
getAllTaxCategories() | Returns all Tax Categories |
getAllTaxCategoriesAsList() | Returns all Tax categories, indexed by ID. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | 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() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
init() (opens new window) | Initializes the object. |
off() (opens new window) | Detaches an existing event handler from this component. |
on() (opens new window) | Attaches an event handler to an event. |
saveTaxCategory() | Save a tax category. |
trigger() (opens new window) | Triggers an event. |
# deleteTaxCategoryById()
View source (opens new window)
Arguments
Returns
# getAllTaxCategories()
Returns all Tax Categories
View source (opens new window)
Returns
craft\commerce\models\TaxCategory[]
# getAllTaxCategoriesAsList()
Returns all Tax categories, indexed by ID.
View source (opens new window)
Returns
# getDefaultTaxCategory()
Get the default tax category
View source (opens new window)
Returns
craft\commerce\models\TaxCategory, null (opens new window)
# getTaxCategoriesByProductTypeId()
View source (opens new window)
Arguments
$productTypeId
Returns
# getTaxCategoryByHandle()
Get a tax category by its handle.
View source (opens new window)
Arguments
$taxCategoryHandle
(integer (opens new window))
Returns
craft\commerce\models\TaxCategory, null (opens new window)
# getTaxCategoryById()
Get a tax category by its ID.
View source (opens new window)
Arguments
$taxCategoryId
(integer (opens new window))
Returns
craft\commerce\models\TaxCategory, null (opens new window)
# saveTaxCategory()
Save a tax category.
View source (opens new window)
Arguments
$taxCategory
(craft\commerce\models\TaxCategory)$runValidation
(boolean (opens new window)) – Should we validate this state before saving.