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, craft\base\ModelInterface, 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
enableVersioning	boolean – Whether versioning should be enabled for this product type.
errors	array – Errors for all attributes or the specified attribute.
fieldLayout	craft\models\FieldLayout
fieldLayoutId	integer, null – Field layout ID
firstErrors	array – The first errors.
handle	string, null – Handle
hasDimensions	boolean – Has dimension
hasProductTitleField	boolean – Has product title field?
hasVariantTitleField	boolean – Has variant title field
hasVariants	boolean
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
maxVariants	integer, null – Maximum number of variants
name	string, null – Name
productFieldLayout	mixed
productTitleFormat	string – Product title format
productTitleTranslationKeyFormat	string, null – Product title translation key format
productTitleTranslationMethod	string – Product title translation method
propagationMethod	\craft\enums\PropagationMethod – Propagation method This will be set to one of the following: - PropagationMethod::None – Only save products in the site they were created in - PropagationMethod::SiteGroup – Save products to other sites in the same site group - PropagationMethod::Language – Save products to other sites with the same language - PropagationMethod::Custom – Save products to other sites based on a custom $propagationKeyFormat - PropagationMethod::All – Save products to all sites supported by the owner element
scenario	string – The scenario that this model is in.
shippingCategories	array, craft\commerce\models\ShippingCategory[], integer[]
siteIds	integer[]
siteSettings	craft\commerce\models\ProductTypeSite[] – the product types' site-specific settings
skuFormat	string, null – SKU format
taxCategories	craft\commerce\models\TaxCategory[], array, integer[]
template	string, null – Template
titleFormat	string
uid	string, null – UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
variantFieldLayout	mixed
variantFieldLayoutId	integer, null – Variant layout ID
variantTitleFormat	string – Variant title format
variantTitleTranslationKeyFormat	string, null – Variant title translation key format
variantTitleTranslationMethod	string – Variant title translation method

cpEditUrl

Type

string

Default value

null

View source

cpEditVariantUrl

Type

string

Default value

null

View source

descriptionFormat

Type

string

Default value

'{product.title} - {title}'

Description format

View source

enableVersioning

Type

boolean

Default value

false

Since

5.0.0

Whether versioning should be enabled for this product type.

View source

fieldLayout

Type

craft\models\FieldLayout

Default value

null

View source

fieldLayoutId

Type

integer, null

Default value

null

Field layout ID

View source

handle

Type

string, null

Default value

null

Handle

View source

hasDimensions

Type

boolean

Default value

false

Has dimension

View source

hasProductTitleField

Type

boolean

Default value

true

Has product title field?

View source

hasVariantTitleField

Type

boolean

Default value

true

Has variant title field

View source

hasVariants

Type

boolean

Default value

null

Access

Read-only

View source

id

Type

integer, null

Default value

null

ID

View source

maxVariants

Type

integer, null

Default value

null

Maximum number of variants

View source

name

Type

string, null

Default value

null

Name

View source

productFieldLayout

Type

mixed

Default value

null

View source

productTitleFormat

Type

string

Default value

''

Product title format

View source

productTitleTranslationKeyFormat

Type

string, null

Default value

null

Since

5.1.0

Product title translation key format

View source

productTitleTranslationMethod

Type

string

Default value

\craft\base\Field::TRANSLATION_METHOD_SITE

Since

5.1.0

Product title translation method

View source

propagationMethod

Type

\craft\enums\PropagationMethod

Default value

\craft\enums\PropagationMethod::All

Since

5.1.0

Propagation method

This will be set to one of the following:

• PropagationMethod::None – Only save products in the site they were created in
• PropagationMethod::SiteGroup – Save products to other sites in the same site group
• PropagationMethod::Language – Save products to other sites with the same language
• PropagationMethod::Custom – Save products to other sites based on a custom $propagationKeyFormat
• PropagationMethod::All – Save products to all sites supported by the owner element

View source

shippingCategories

Type

array, craft\commerce\models\ShippingCategory[], integer[]

Default value

null

View source

siteIds

Type

integer[]

Default value

null

Access

Read-only

Since

5.1.0

View source

siteSettings

Type

craft\commerce\models\ProductTypeSite[]

Default value

null

the product types' site-specific settings

View source

skuFormat

Type

string, null

Default value

null

SKU format

View source

taxCategories

Type

craft\commerce\models\TaxCategory[], array, integer[]

Default value

null

View source

template

Type

string, null

Default value

null

Template

View source

titleFormat

Type

string

Default value

null

View source

uid

Type

string, null

Default value

null

UID

View source

variantFieldLayout

Type

mixed

Default value

null

View source

variantFieldLayoutId

Type

integer, null

Default value

null

Variant layout ID

View source

variantTitleFormat

Type

string

Default value

'{product.title}'

Variant title format

View source

variantTitleTranslationKeyFormat

Type

string, null

Default value

null

Since

5.1.0

Variant title translation key format

View source

variantTitleTranslationMethod

Type

string

Default value

\craft\base\Field::TRANSLATION_METHOD_SITE

Since

5.1.0

Variant title translation method

View source

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()
__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.
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()
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFieldLayout()
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getHasVariants()
getIterator()	Returns an iterator for traversing the attributes in the model.
getProductFieldLayout()
getScenario()	Returns the scenario that this model is used in.
getShippingCategories()
getSiteIds()	Returns the site IDs that are enabled for the product type.
getSiteSettings()	Returns the product type's site-specific settings.
getTaxCategories()
getTitleFormat()
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.
setFieldLayout()
setScenario()	Sets the scenario for the model.
setShippingCategories()
setSiteSettings()	Sets the product type's site-specific settings.
setTaxCategories()
setTitleFormat()
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateFieldLayout()	Validate the field layout to make sure no fields with reserved words are used.
validateMultiple()	Validates multiple models.
validateVariantFieldLayout()	Validate the variant field layout to make sure no fields with reserved words are used.

__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.

extraFields()

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

getCpEditUrl()

View source

getCpEditVariantUrl()

View source

getFieldLayout()

View source

Returns

craft\models\FieldLayout –

getHasVariants()

DEPRECATED

Deprecated since version 5.0.0:

View source

Returns

boolean

getProductFieldLayout()

View source

Throws

• yii\base\InvalidConfigException

getShippingCategories()

View source

Returns

craft\commerce\models\ShippingCategory[]

Throws

• yii\base\InvalidConfigException

getSiteIds()

Since

5.1.0

Returns the site IDs that are enabled for the product type.

View source

Returns

integer[]

getSiteSettings()

Returns the product type's site-specific settings.

View source

Returns

craft\commerce\models\ProductTypeSite[]

Throws

• yii\base\InvalidConfigException

getTaxCategories()

View source

Returns

craft\commerce\models\TaxCategory[]

Throws

• yii\base\InvalidConfigException

getTitleFormat()

DEPRECATED

Deprecated since version 4.0.0:

View source

Returns

string

getVariantFieldLayout()

View source

Throws

• yii\base\InvalidConfigException

setFieldLayout()

View source

Arguments

• $fieldLayout

Returns

null –

setShippingCategories()

View source

Arguments

• $shippingCategories (integer[], craft\commerce\models\ShippingCategory[])

Throws

• yii\base\InvalidConfigException

setSiteSettings()

Sets the product type's site-specific settings.

View source

Arguments

• $siteSettings (craft\commerce\models\ProductTypeSite[])

setTaxCategories()

View source

Arguments

• $taxCategories (integer[], craft\commerce\models\TaxCategory[])

Throws

• yii\base\InvalidConfigException

setTitleFormat()

DEPRECATED

Deprecated since version 4.0.0:

View source

Arguments

• $titleFormat (string)

Returns

void

Throws

• craft\errors\DeprecationException

validateFieldLayout()

Since

3.4

Validate the field layout to make sure no fields with reserved words are used.

View source

validateVariantFieldLayout()

Since

3.4

Validate the variant field layout to make sure no fields with reserved words are used.

View source

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
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().

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

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.