Product

Type
Class
Namespace
craft\commerce\elements
Inherits
craft\commerce\elements\Product » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
2.0

Product model.

View source

Public Properties

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$ancestorscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$archivedboolean – Whether the element is archived
$attributesarray – Attribute values (name => value).
$availableForPurchaseboolean – Is this product available to be purchased
$awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$cheapestVariantcraft\commerce\elements\Variant
$childrencraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$contentIdinteger, null – The element’s content row ID
$contentTablestring
$cpEditUrlstring, null
$dateCreatedDateTime, null – The date that the element was created
$dateUpdatedDateTime, null – The date that the element was last updated
$defaultHeightfloat – Default height
$defaultLengthfloat – Default length
$defaultPricefloat – Default price
$defaultSkustring – Default SKU
$defaultVariantcraft\commerce\elements\Variant
$defaultVariantIdinteger – DefaultVariantId
$defaultWeightfloat – Default weight
$defaultWidthfloat – Default width
$descendantscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$editorHtmlstring – The HTML for the editor HUD
$enabledboolean – Whether the element is enabled
$enabledForSiteboolean – Whether the element is enabled for this site.
$errorsarray – Errors for all attributes or the specified attribute.
$expiryDateDateTime – Expiry date
$fieldColumnPrefixstring
$fieldContextstring
$fieldLayoutcraft\models\FieldLayout, null
$fieldLayoutIdinteger, null – The element’s field layout ID
$fieldParamNamespacestring, null – The field param namespace
$fieldValuesarray – The field values (handle => value)
$firstErrorsarray – The first errors.
$freeShippingboolean – Whether the product has free shipping
$hasDescendantsboolean
$hasFreshContentboolean – Whether the element’s content is fresh
$hasUnlimitedStockboolean
$idinteger, null – The element’s ID
$isEditableboolean
$iteratorArrayIterator – An iterator for traversing the items in the list.
$levelinteger, null – The element’s level within its structure
$lftinteger, null – The element’s left position within its structure
$linkTwig_Markup, null
$namestring – Name
$nextcraft\base\ElementInterface, null
$nextSiblingcraft\base\ElementInterface, null
$parentcraft\base\ElementInterface, null
$postDateDateTime – Post date
$prevcraft\base\ElementInterface, null
$prevSiblingcraft\base\ElementInterface, null
$promotableboolean – Whether the product is promotable
$propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
$refstring, null
$rgtinteger, null – The element’s right position within its structure
$rootinteger, null – The element’s structure’s root ID
$routemixed – The route that the request should use, or null if no special action should be taken
$scenariostring – The scenario that this model is in.
$searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
$serializedFieldValuesarray
$shippingCategorycraft\commerce\models\ShippingCategory, null
$shippingCategoryIdinteger – Shipping category ID
$siblingscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface
$sitecraft\models\Site
$siteIdinteger, null – The site ID the element is associated with
$slugstring, null – The element’s slug
$snapshotarray
$statusstring, null
$structureIdinteger, null – The element’s structure ID
$supportedSitesinteger[], array
$taxCategorycraft\commerce\models\TaxCategory – Tax category
$taxCategoryIdinteger – Tax category ID
$tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
$titlestring, null – The element’s title
$totalDescendantsinteger
$totalStockinteger
$typecraft\commerce\models\ProductType
$typeIdinteger – Product type ID
$uidstring, null – The element’s UID
$unlimitedStockboolean
$uristring, null – The element’s URI
$uriFormatstring, null
$urlstring, null
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
$variantscraft\commerce\elements\Variant[]

$availableForPurchase

Type
boolean

Is this product available to be purchased

View source

Signature

public boolean $availableForPurchase = true

$cheapestVariant

Signature

public craft\commerce\elements\Variant getCheapestVariant ( )

$cpEditUrl

Type
string, null
Access
Read-only

View source

Signature

public string, null getCpEditUrl ( )

$defaultHeight

Type
float

Default height

View source

Signature

public float $defaultHeight = null

$defaultLength

Type
float

Default length

View source

Signature

public float $defaultLength = null

$defaultPrice

Type
float

Default price

View source

Signature

public float $defaultPrice = null

$defaultSku

Type
string

Default SKU

View source

Signature

public string $defaultSku = null

$defaultVariant

Signature

public craft\commerce\elements\Variant getDefaultVariant ( )

$defaultVariantId

Type
integer

DefaultVariantId

View source

Signature

public integer $defaultVariantId = null

$defaultWeight

Type
float

Default weight

View source

Signature

public float $defaultWeight = null

$defaultWidth

Type
float

Default width

View source

Signature

public float $defaultWidth = null

$editorHtml

Type
string
Access
Read-only

The HTML for the editor HUD

View source

Signature

public string getEditorHtml ( )

$enabled

Type
boolean

Whether the element is enabled

View source

Signature

public boolean $enabled = null

$expiryDate

Type
DateTime

Expiry date

View source

Signature

public DateTime $expiryDate = null

$fieldLayout

Signature

public craft\models\FieldLayout, null getFieldLayout ( )

$freeShipping

Type
boolean

Whether the product has free shipping

View source

Signature

public boolean $freeShipping = null

$hasUnlimitedStock

Type
boolean
Access
Read-only

View source

Signature

public boolean getHasUnlimitedStock ( )

$isEditable

Type
boolean
Access
Read-only

View source

Signature

public boolean getIsEditable ( )

$name

Type
string
Access
Read-only

Name

View source

Signature

public string, null getName ( )

$postDate

Type
DateTime

Post date

View source

Signature

public DateTime $postDate = null

$promotable

Type
boolean

Whether the product is promotable

View source

Signature

public boolean $promotable = null

$shippingCategory

Signature

public craft\commerce\models\ShippingCategory, null getShippingCategory ( )

$shippingCategoryId

Type
integer

Shipping category ID

View source

Signature

public integer $shippingCategoryId = null

$snapshot

Type
array
Access
Read-only

View source

Signature

public array getSnapshot ( )

$status

Type
string, null
Access
Read-only

View source

Signature

public string, null getStatus ( )

$taxCategory

Type
craft\commerce\models\TaxCategory
Access
Read-only

Tax category

View source

Signature

public craft\commerce\models\TaxCategory, null getTaxCategory ( )

$taxCategoryId

Type
integer

Tax category ID

View source

Signature

public integer $taxCategoryId = null

$totalStock

Type
integer
Access
Read-only

View source

Signature

public integer getTotalStock ( )

$type

Signature

public craft\commerce\models\ProductType getType ( )

$typeId

Type
integer

Product type ID

View source

Signature

public integer $typeId = null

$unlimitedStock

Type
boolean
Access
Read-only

View source

Signature

public boolean getUnlimitedStock ( )

$uriFormat

Type
string, null
Access
Read-only

View source

Signature

public string, null getUriFormat ( )

$variants

Signature

public craft\commerce\elements\Variant[] getVariants ( )
public void setVariants ( array $variants )

Public Methods

MethodDescription
__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.
__set()Sets the value of a component property.
__toString()Returns the string representation of the element.
__unset()Sets an object property to null.
actions()Returns the available element actions for a given source (if one is provided).
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.
afterDelete()Performs actions after an element is deleted.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterSave()Performs actions after an element is saved.
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.
beforeDelete()Performs actions before an element is deleted.
beforeMoveInStructure()Performs actions before an element is moved within a structure.
beforeSave()Performs actions before an element is saved.
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.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
eagerLoadingMap()Returns an array that maps source-to-target element IDs based on the given sub-property handle.
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.
find()Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne()Returns a single element instance by a primary key or a set of element criteria parameters.
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.
getAncestors()Returns the element’s ancestors.
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.
getCheapestVariant()Return the cheapest variant.
getChildren()Returns the element’s children.
getContentTable()Returns the name of the table this element’s content is stored in.
getCpEditUrl()Returns the element’s CP edit URL.
getDefaultVariant()Returns the default variant.
getDescendants()Returns the element’s descendants.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEditorHtml()Returns the HTML for the element’s editor HUD.
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.
getFieldColumnPrefix()Returns the field column prefix this element’s content uses.
getFieldContext()Returns the field context this element’s content uses.
getFieldLayout()Returns the field layout used by this element.
getFieldParamNamespace()Returns the namespace used by custom field params on the request.
getFieldValue()Returns the value for a given field.
getFieldValues()Returns the element’s normalized custom field values, indexed by their handles.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getHasDescendants()Returns whether the element has descendants.
getHasFreshContent()Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHasUnlimitedStock()Returns whether at least one variant has unlimited stock.
getHtmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
getId()Returns the element’s ID.
getIsEditable()Returns whether the current user can edit the element.
getIterator()Returns an iterator for traversing the attributes in the model.
getLink()Returns an anchor pre-filled with this element’s URL and title.
getName()
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element’s next sibling.
getParent()Returns the element’s parent.
getPrev()Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()Returns the element’s previous sibling.
getRef()Returns the reference string to this element.
getRoute()Returns the route that should be used when the element’s URI is requested.
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords for a given search attribute.
getSerializedFieldValues()Returns an array of the element’s serialized custom field values, indexed by their handles.
getShippingCategory()Returns the shipping category.
getSiblings()Returns all of the element’s siblings.
getSite()Returns the site the element is associated with.
getSnapshot()Allows the variant to ask the product what data to snapshot.
getStatus()Returns the element’s status.
getSupportedSites()Returns the sites this element is associated with.
getTableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
getTaxCategory()Returns the tax category.
getThumbUrl()Returns the URL to the element’s thumbnail, if there is one.
getTotalDescendants()Returns the total number of descendants that the element has.
getTotalStock()
getType()Returns the product's product type.
getUnlimitedStock()Returns whether at least one variant has unlimited stock.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
getValidators()Returns all the validators declared in rules().
getVariants()Returns an array of the product's variants.
hasContent()Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).
hasEagerLoadedElements()Returns whether elements have been eager-loaded with a given handle.
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.
hasStatuses()Returns whether elements of this type have statuses.
hasTitles()Returns whether elements of this type have traditional titles.
hasUris()Returns whether elements of this type can have their own slugs and URIs.
indexHtml()Returns the element index HTML.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
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.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isFieldEmpty()Returns whether a field is empty.
isLocalized()Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()Returns whether this element is the direct next sibling of another one.
isParentOf()Returns whether this element is a direct parent of another one.
isPrevSiblingOf()Returns whether this element is the direct previous sibling of another one.
isSiblingOf()Returns whether this element is a sibling of another one.
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.
prepElementQueryForTableAttribute()Preps the element criteria for a given table attribute
refHandle()Returns the handle that should be used to refer to this element type from reference tags.
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.
searchableAttributes()Defines which element attributes should be searchable.
setAttributes()Sets the attribute values in a massive way.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setFieldParamNamespace()Sets the namespace used by custom field params on the request.
setFieldValue()Sets the value for a given field.
setFieldValues()Sets the element’s custom field values.
setFieldValuesFromRequest()Sets the element’s custom field values, when the values have come from post data.
setNext()Sets the default next element.
setParent()Sets the element’s parent.
setPrev()Sets the default previous element.
setScenario()Sets the scenario for the model.
setVariants()Sets the variants on the product. Accepts an array of variant data keyed by variant ID or the string 'new'.
sortOptions()Returns the sort options for the element type.
sources()Returns the source definitions that elements of this type may belong to.
statuses()Returns all of the possible statuses that elements of this type may have.
tableAttributes()Defines all of the available columns that can be shown in table views.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateCustomFieldAttribute()Calls a custom validation function on a custom field.
validateCustomFieldContentSize()Validates that the content size is going to fit within the field’s database column.
validateMultiple()Validates multiple models.

__toString()

Returns the string representation of the element.

View source

Returns

string

Signature

public string __toString ( )

afterDelete()

Performs actions after an element is deleted.

View source

Signature

public void afterDelete ( )

afterSave()

Performs actions after an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

Signature

public void afterSave ( \craft\commerce\elements\bool $isNew )

afterValidate()

This method is invoked after validation ends.

The default implementation raises an afterValidate event. You may override this method to do postprocessing after validation. Make sure the parent implementation is invoked so that the event can be raised.

View source

Signature

public void afterValidate ( )

beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

Signature

public boolean beforeDelete ( )

beforeSave()

Performs actions before an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

Returns

boolean – Whether the element should be saved

Signature

public boolean beforeSave ( \craft\commerce\elements\bool $isNew )

beforeValidate()

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

View source

Returns

boolean – Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.

Signature

public boolean beforeValidate ( )

datetimeAttributes()

Returns the names of any attributes that should hold DateTime values.

View source

Returns

string[]

Signature

public string[] datetimeAttributes ( )

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

Signature

public static string displayName ( )

eagerLoadingMap()

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys.
  • criteria(optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

View source

Arguments

  • $sourceElements (craft\base\ElementInterface) – An array of the source elements
  • $handle (string) – The property handle used to identify which target elements should be included in the map

Returns

array, false – The eager-loading element ID mappings, or false if no mappings exist

Signature

public static array, false eagerLoadingMap ( array $sourceElements, \craft\commerce\elements\string $handle )

find()

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated \craft\commerce\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

View source

Returns

craft\commerce\elements\db\ProductQuery – The newly created craft\commerce\elements\db\ProductQuery instance.

Signature

public static craft\commerce\elements\db\ProductQuery find ( )

getCheapestVariant()

Return the cheapest variant.

View source

Returns

craft\commerce\elements\Variant

Signature

public craft\commerce\elements\Variant getCheapestVariant ( )

getCpEditUrl()

Returns the element’s CP edit URL.

View source

Returns

string, null

Signature

public string, null getCpEditUrl ( )

getDefaultVariant()

Returns the default variant.

View source

Returns

craft\commerce\elements\Variant

Signature

public craft\commerce\elements\Variant getDefaultVariant ( )

getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

Signature

public string getEditorHtml ( )

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

Signature

public craft\models\FieldLayout, null getFieldLayout ( )

getHasUnlimitedStock()

Returns whether at least one variant has unlimited stock.

View source

Returns

boolean

Signature

public boolean getHasUnlimitedStock ( )

getIsEditable()

Returns whether the current user can edit the element.

View source

Returns

boolean

Signature

public boolean getIsEditable ( )

getName()

Signature

public string, null getName ( )

getSearchKeywords()

Returns the search keywords for a given search attribute.

View source

Arguments

Returns

string

Signature

public string getSearchKeywords ( \craft\commerce\elements\string $attribute )

getShippingCategory()

Returns the shipping category.

View source

Returns

craft\commerce\models\ShippingCategory, null

Signature

public craft\commerce\models\ShippingCategory, null getShippingCategory ( )

getSnapshot()

Allows the variant to ask the product what data to snapshot.

View source

Returns

array

Signature

public array getSnapshot ( )

getStatus()

Returns the element’s status.

View source

Returns

string, null

Signature

public string, null getStatus ( )

getTaxCategory()

Returns the tax category.

View source

Returns

craft\commerce\models\TaxCategory, null

Signature

public craft\commerce\models\TaxCategory, null getTaxCategory ( )

getTotalStock()

Signature

public integer getTotalStock ( )

getType()

Signature

public craft\commerce\models\ProductType getType ( )

getUnlimitedStock()

DEPRECATED

Deprecated as of 2.0

Returns whether at least one variant has unlimited stock.

View source

Returns

boolean

Signature

public boolean getUnlimitedStock ( )

getUriFormat()

Returns the URI format used to generate this element’s URI.

Note that element types that can have URIs must return true from hasUris().

View source

Returns

string, null

Signature

public string, null getUriFormat ( )

getVariants()

Returns an array of the product's variants.

View source

Returns

craft\commerce\elements\Variant[]

Throws

Signature

public craft\commerce\elements\Variant[] getVariants ( )

hasContent()

Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).

View source

Returns

boolean – Whether elements of this type will be storing any data in the content table.

Signature

public static boolean hasContent ( )

hasStatuses()

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() to customize which statuses the elements might have.

View source

Returns

boolean – Whether elements of this type have statuses.

Signature

public static boolean hasStatuses ( )

hasTitles()

Returns whether elements of this type have traditional titles.

View source

Returns

boolean – Whether elements of this type have traditional titles.

Signature

public static boolean hasTitles ( )

hasUris()

Returns whether elements of this type can have their own slugs and URIs.

Note that individual elements must also return a URI format from getUriFormat() if they are to actually get a URI.

View source

Returns

boolean – Whether elements of this type can have their own slugs and URIs.

Signature

public static boolean hasUris ( )

isLocalized()

Returns whether elements of this type store content on a per-site basis.

If this returns true, the element’s getSupportedSites() method will be responsible for defining which sites its content should be stored in.

View source

Returns

boolean – Whether elements of this type store data on a per-site basis.

Signature

public static boolean isLocalized ( )

prepElementQueryForTableAttribute()

Preps the element criteria for a given table attribute

View source

Arguments

Signature

public static void prepElementQueryForTableAttribute ( craft\elements\db\ElementQueryInterface $elementQuery, \craft\commerce\elements\string $attribute )

refHandle()

Returns the handle that should be used to refer to this element type from reference tags.

View source

Returns

string, null – The reference handle, or null if the elemnet type doesn’t support reference tags

Signature

public static string, null refHandle ( )

rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\commerce\elements\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\commerce\elements\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source

Returns

array – Validation rules

Signature

public array rules ( )

setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

Signature

public void setEagerLoadedElements ( \craft\commerce\elements\string $handle, array $elements )

setVariants()

Sets the variants on the product. Accepts an array of variant data keyed by variant ID or the string 'new'.

View source

Arguments

Signature

public void setVariants ( array $variants )

statuses()

Returns all of the possible statuses that elements of this type may have.

This method will be called when populating the Status menu on element indexes, for element types whose hasStatuses() method returns true. It will also be called when craft\elements\db\ElementQuery is querying for elements, to ensure that its “status” parameter is set to a valid status. It should return an array whose keys are the status values, and values are the human-facing status labels, or an array with the following keys:

  • label – The human-facing status label.
  • color – The status color (green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, or white) You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().

View source

Returns

array

Signature

public static array statuses ( )

Protected Methods

MethodDescription
defineActions()Defines the available element actions for a given source (if one is provided).
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
defineSearchableAttributes()Defines which element attributes should be searchable.
defineSortOptions()Returns the sort options for the element type.
defineSources()Defines the sources that elements of this type may belong to.
defineTableAttributes()Defines all of the available columns that can be shown in table views.
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.
fieldByHandle()Returns the field with a given handle.
fieldLayoutFields()Returns each of this element’s fields.
findByCondition()Finds Element instance(s) by the given condition.
htmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
normalizeFieldValue()Normalizes a field’s value.
resolveFields()Determines which fields can be returned by toArray().
route()Returns the route that should be used when the element’s URI is requested.
tableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.

defineActions()

Defines the available element actions for a given source (if one is provided).

View source

Arguments

  • $source (string, null) – The selected source’s key, if any.

Returns

array – The available element actions.

Signature

protected static array defineActions ( \craft\commerce\elements\string $source = null )

defineDefaultTableAttributes()

Returns the list of table attribute keys that should be shown by default.

View source

Arguments

  • $source (string) – The selected source’s key

Returns

string[] – The table attributes.

Signature

protected static string[] defineDefaultTableAttributes ( \craft\commerce\elements\string $source )

defineSearchableAttributes()

Defines which element attributes should be searchable.

View source

Returns

string[] – The element attributes that should be searchable

Signature

protected static string[] defineSearchableAttributes ( )

defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

Signature

protected static array defineSortOptions ( )

defineSources()

Defines the sources that elements of this type may belong to.

View source

Arguments

  • $context (string, null) – The context ('index' or 'modal').

Returns

array – The sources.

Signature

protected static array defineSources ( \craft\commerce\elements\string $context = null )

defineTableAttributes()

Defines all of the available columns that can be shown in table views.

View source

Returns

array – The table attributes.

Signature

protected static array defineTableAttributes ( )

route()

Returns the route that should be used when the element’s URI is requested.

View source

Returns

mixed – The route that the request should use, or null if no special action should be taken

Signature

protected mixed route ( )

tableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

View source

Arguments

  • $attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in Table View.

Signature

protected string tableAttributeHtml ( \craft\commerce\elements\string $attribute )

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED
STATUS_EXPIRED
STATUS_LIVE
STATUS_PENDING