ProductType

Type
Class
Namespace
craft\commerce\models
Inherits
craft\commerce\models\ProductType » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
2.0

Product type model.

View source

# Public Properties

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
attributes array – Attribute values (name => value).
behaviors yii\base\Behavior – List of behaviors attached to this component
cpEditUrl string
cpEditVariantUrl string
descriptionFormat string – Description format
errors array – Errors for all attributes or the specified attribute.
fieldLayoutId integer – Field layout ID
firstErrors array – The first errors.
handle string – Handle
hasDimensions boolean – Has dimension
hasVariantTitleField boolean – Has variant title field
hasVariants boolean – Has variants
id integer – ID
iterator ArrayIterator – An iterator for traversing the items in the list.
lineItemFormat string – Line item format
name string – Name
productFieldLayout craft\models\FieldLayout
scenario string – The scenario that this model is in.
shippingCategories craft\commerce\models\ShippingCategory[]
siteSettings craft\commerce\models\ProductTypeSite[]
skuFormat string – SKU format
taxCategories craft\commerce\models\TaxCategory[]
template string – Template
titleFormat string – Title format
titleLabel string – Title label
uid string – UID
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.
variantFieldLayout craft\models\FieldLayout
variantFieldLayoutId integer – Variant layout ID
variantTitleLabel string – Title label

# cpEditUrl

Type
string
Access
Read-only

View source

# cpEditVariantUrl

Type
string
Access
Read-only

View source

# descriptionFormat

Type
string

Description format

View source

# fieldLayoutId

Type
integer

Field layout ID

View source

# handle

Type
string

Handle

View source

# hasDimensions

Type
boolean

Has dimension

View source

# hasVariantTitleField

Type
boolean

Has variant title field

View source

# hasVariants

Type
boolean

Has variants

View source

# id

Type
integer

ID

View source

# lineItemFormat

Type
string

Line item format

View source

# name

Type
string

Name

View source

# productFieldLayout

Type
craft\models\FieldLayout
Access
Read-only

View source

# shippingCategories

Type
craft\commerce\models\ShippingCategory[]

View source

# siteSettings

Type
craft\commerce\models\ProductTypeSite[]

View source

# skuFormat

Type
string

SKU format

View source

# taxCategories

Type
craft\commerce\models\TaxCategory[]

View source

# template

Type
string

Template

View source

# titleFormat

Type
string

Title format

View source

# titleLabel

Type
string

Title label

View source

# uid

Type
string

UID

View source

# variantFieldLayout

Type
craft\models\FieldLayout
Access
Read-only

View source

# variantFieldLayoutId

Type
integer

Variant layout ID

View source

# variantTitleLabel

Type
string

Title label

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__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.
__toString()
__unset() Sets a component property to be null.
activeAttributes() Returns the attribute names that are subject to validation in the current scenario.
addError() Adds a new error to the specified attribute.
addErrors() Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterValidate() This method is invoked after validation ends.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
attributeHints() Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() Returns the list of attribute names.
beforeValidate() This method is invoked before validation starts.
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.
clearErrors() Removes errors for all attributes or a single attribute.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
defineRules() Returns the validation rules for attributes.
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.
extraFields() Returns the list of fields that can be expanded further and returned by toArray().
fields() Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName() Returns the form name that this model class should use.
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() Returns the validators applicable to the current scenario.
getAttributeHint() Returns the text hint for the specified attribute.
getAttributeLabel() Returns the text label for the specified attribute.
getAttributes() Returns attribute values.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getCpEditUrl()
getCpEditVariantUrl()
getError() Returns the first error of the specified attribute.
getErrorSummary() Returns the errors for all attributes as a one-dimensional array.
getErrors() Returns the errors for all attributes or a single attribute.
getFirstError() Returns the first error of the specified attribute.
getFirstErrors() Returns the first error of every attribute in the model.
getIterator() Returns an iterator for traversing the attributes in the model.
getProductFieldLayout()
getScenario() Returns the scenario that this model is used in.
getShippingCategories()
getSiteSettings() Returns the product types's site-specific settings.
getTaxCategories()
getValidators() Returns all the validators declared in rules().
getVariantFieldLayout()
hasErrors() Returns a value indicating whether there is any validation error.
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.
instance() Returns static class instance, which can be used to obtain meta information.
isAttributeActive() Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() Returns a value indicating whether the attribute is required.
isAttributeSafe() Returns a value indicating whether the attribute is safe for massive assignments.
load() Populates the model with input data.
loadMultiple() Populates a set of models with the data from end user.
off() Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() Returns the element at the specified offset.
offsetSet() Sets the element at the specified offset.
offsetUnset() Sets the element value at the specified offset to null.
on() Attaches an event handler to an event.
onUnsafeAttribute() This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() Returns a list of scenarios and the corresponding active attributes.
setAttributes() Sets the attribute values in a massive way.
setScenario() Sets the scenario for the model.
setShippingCategories()
setSiteSettings() Sets the product type's site-specific settings.
setTaxCategories()
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Performs the data validation.
validateMultiple() Validates multiple models.

# __toString()

View source

Returns

null, string

# behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\commerce\models\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns

array – The behavior configurations.

# defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

# getCpEditUrl()

View source

Returns

string

# getCpEditVariantUrl()

View source

Returns

string

# getProductFieldLayout()

View source

Returns

craft\models\FieldLayout

# getShippingCategories()

View source

Returns

craft\commerce\models\ShippingCategory[]

# getSiteSettings()

Returns the product types's site-specific settings.

View source

Returns

craft\commerce\models\ProductTypeSite[]

# getTaxCategories()

View source

Returns

craft\commerce\models\TaxCategory[]

# getVariantFieldLayout()

View source

Returns

craft\models\FieldLayout

# setShippingCategories()

View source

Arguments

# setSiteSettings()

Sets the product type's site-specific settings.

View source

Arguments

# setTaxCategories()

View source

Arguments

# Protected Methods

Method Description
extractFieldsFor() Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() Extracts the root field names from nested fields.
resolveFields() Determines which fields can be returned by toArray().

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.