ModelTaxes module

Provider

A model in the Taxes module, with 15 members for templates, 11 API properties and 15 members for admin templates.

Taxes\Models\Frontend\Provider Taxes\Models\Api\Provider Taxes\Models\Backend\Provider Also in Taxes: AvalaraProvider Category CategoryProviderCode Location MockTaxProvider Rate StripeTaxProvider Transaction Zone
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 14

Take no arguments.

# getId()
?int
# getName()
?string
# getEntity()
?string
# isEnabled()
bool
# getConfiguration()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getSite()
?Site
# getCategoryProviderCodes()
?Collection<CategoryProviderCode>
# getZones()
?Collection<Zone>
# getRates()
?Collection<Rate>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

Methods 1

Take arguments. The API serialises only getters that need none.

# getCategories(?array $criteria, string $sort, string $direction)
Collection
Helper that will fetch instances of Taxes\Models\Category through Taxes\Models\CategoryProviderCode

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 11

Read-only values on the record.

# id
?int
# name
?string
# entity
?string
# enabled
bool
# configuration
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# site
?Site
# categoryProviderCodes
?Collection<CategoryProviderCode>
# zones
?Collection<Zone>
# rates
?Collection<Rate>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 14

Take no arguments.

# getId()
?int
# getName()
?string
# getEntity()
?string
# isEnabled()
bool
# getConfiguration()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getSite()
?Site
# getCategoryProviderCodes()
?Collection<CategoryProviderCode>
# getZones()
?Collection<Zone>
# getRates()
?Collection<Rate>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

Methods 1

Take arguments. The API serialises only getters that need none.

# getCategories(?array $criteria, string $sort, string $direction)
Collection
Helper that will fetch instances of Taxes\Models\Category through Taxes\Models\CategoryProviderCode