Element

Type
Abstract Class
Namespace
craft\base
Inherits
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
Extended by
craft\elements\Asset, craft\elements\Category, craft\elements\Entry, craft\elements\GlobalSet, craft\elements\MatrixBlock, craft\elements\Tag, craft\elements\User, craft\models\BaseEntryRevisionModel, craft\models\EntryDraft, craft\models\EntryVersion
Since
3.0

Element is the base class for classes representing elements in terms of objects.

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).
$awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$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
$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.
$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.
$hasDescendantsboolean
$hasFreshContentboolean – Whether the element’s content is fresh
$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
$nextcraft\base\ElementInterface, null
$nextSiblingcraft\base\ElementInterface, null
$parentcraft\base\ElementInterface, null
$prevcraft\base\ElementInterface, null
$prevSiblingcraft\base\ElementInterface, null
$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
$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
$statusstring, null
$structureIdinteger, null – The element’s structure ID
$supportedSitesinteger[], array
$tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
$titlestring, null – The element’s title
$totalDescendantsinteger
$uidstring, null – The element’s UID
$uristring, null – The element’s URI
$uriFormatstring, null
$urlstring, null
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$ancestors

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getAncestors ( \craft\base\int $dist = null )

$children

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getChildren ( )

$contentTable

Type
string
Access
Read-only

View source

Signature

public string getContentTable ( )

$cpEditUrl

Type
string, null
Access
Read-only

View source

Signature

public string, null getCpEditUrl ( )

$descendants

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getDescendants ( \craft\base\int $dist = null )

$editorHtml

Type
string
Access
Read-only

The HTML for the editor HUD

View source

Signature

public string getEditorHtml ( )

$fieldColumnPrefix

Type
string
Access
Read-only

View source

Signature

public string getFieldColumnPrefix ( )

$fieldContext

Type
string
Access
Read-only

View source

Signature

public string getFieldContext ( )

$fieldLayout

Signature

public craft\models\FieldLayout, null getFieldLayout ( )

$fieldParamNamespace

Type
string, null

The field param namespace

View source

Signature

public string, null getFieldParamNamespace ( )
public void setFieldParamNamespace ( \craft\base\string $namespace )

$fieldValues

Type
array

The field values (handle => value)

View source

Signature

public array getFieldValues ( array $fieldHandles = null )
public void setFieldValues ( array $values )

$hasDescendants

Type
boolean
Access
Read-only

View source

Signature

public boolean getHasDescendants ( )

$hasFreshContent

Type
boolean
Access
Read-only

Whether the element’s content is fresh

View source

Signature

public boolean getHasFreshContent ( )

$isEditable

Type
boolean
Access
Read-only

View source

Signature

public boolean getIsEditable ( )
Type
Twig_Markup, null
Access
Read-only

View source

Signature

public Twig_Markup, null getLink ( )

$next

Signature

public craft\base\ElementInterface, null getNext ( $criteria = false )
public void setNext ( $element )

$nextSibling

Signature

public craft\base\ElementInterface, null getNextSibling ( )

$parent

Signature

public craft\base\ElementInterface, null getParent ( )

$prev

Signature

public craft\base\ElementInterface, null getPrev ( $criteria = false )
public void setPrev ( $element )

$prevSibling

Signature

public craft\base\ElementInterface, null getPrevSibling ( )

$ref

Type
string, null
Access
Read-only

View source

Signature

public string, null getRef ( )

$route

Type
mixed
Access
Read-only

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

View source

Signature

public mixed getRoute ( )

$serializedFieldValues

Type
array
Access
Read-only

View source

Signature

public array getSerializedFieldValues ( array $fieldHandles = null )

$siblings

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getSiblings ( )

$site

Type
craft\models\Site
Access
Read-only

View source

Signature

public craft\models\Site getSite ( )

$status

Type
string, null
Access
Read-only

View source

Signature

public string, null getStatus ( )

$supportedSites

Type
integer[], array
Access
Read-only

View source

Signature

public integer[], array getSupportedSites ( )

$totalDescendants

Type
integer
Access
Read-only

View source

Signature

public integer getTotalDescendants ( )

$uriFormat

Type
string, null
Access
Read-only

View source

Signature

public string, null getUriFormat ( )

$url

Type
string, null
Access
Read-only

View source

Signature

public string, null getUrl ( )

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.
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.
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).
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.
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.
getSiblings()Returns all of the element’s siblings.
getSite()Returns the site the element is associated with.
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.
getThumbUrl()Returns the URL to the element’s thumbnail, if there is one.
getTotalDescendants()Returns the total number of descendants that the element has.
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().
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.
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.
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.

__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

View source

Arguments

  • $name (string) – The method name
  • $params (array) – Method parameters

Returns

mixed – The method return value

Throws

Signature

public mixed __call ( $name, $params )

__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

View source

Arguments

  • $name (string) – The property name

Returns

mixed – The property value or the value of a behavior's property

Throws

Signature

public mixed __get ( $name )

__isset()

Checks if a property is set. This method will check if $name is one of the following:

View source

Arguments

  • $name (string) – The property name

Returns

boolean – Whether the property is set

Signature

public boolean __isset ( $name )

__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

View source

Arguments

  • $name (string) – The property name or the event name
  • $value (mixed) – The property value

Throws

Signature

public void __set ( $name, $value )

__toString()

Returns the string representation of the element.

View source

Returns

string

Signature

public string __toString ( )

actions()

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

The actions can either be represented by their class handle (e.g. 'SetStatus'), or by an craft\base\ElementActionInterface instance.

View source

Arguments

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

Returns

array – The available element actions.

Signature

public static array actions ( \craft\base\string $source )

addError()

Adds a new error to the specified attribute.

View source

Arguments

  • $attribute (string) – Attribute name
  • $error (string) – New error message

Signature

public void addError ( $attribute, $error = '' )

afterDelete()

Performs actions after an element is deleted.

View source

Signature

public void afterDelete ( )

afterMoveInStructure()

Performs actions after an element is moved within a structure.

View source

Arguments

  • $structureId (integer) – The structure ID

Signature

public void afterMoveInStructure ( \craft\base\int $structureId )

afterSave()

Performs actions after an element is saved.

View source

Arguments

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

Signature

public void afterSave ( \craft\base\bool $isNew )

attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

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

View source

Returns

array – Attribute labels (name => label)

Signature

public array attributeLabels ( )

attributes()

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source

Returns

array – List of attribute names.

Signature

public array attributes ( )

beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

Signature

public boolean beforeDelete ( )

beforeMoveInStructure()

Performs actions before an element is moved within a structure.

View source

Arguments

  • $structureId (integer) – The structure ID

Returns

boolean – Whether the element should be moved within the structure

Signature

public boolean beforeMoveInStructure ( \craft\base\int $structureId )

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\base\bool $isNew )

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\base\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.

Signature

public array behaviors ( )

defaultTableAttributes()

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

This method should return an array where each element in the array maps to one of the keys of the array returned by tableAttributes().

View source

Arguments

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

Returns

string[] – The table attribute keys

Signature

public static string[] defaultTableAttributes ( \craft\base\string $source )

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\base\string $handle )

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.

Signature

public array extraFields ( )

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\base\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\elements\db\ElementQueryInterface – The newly created craft\elements\db\ElementQueryInterface instance.

Signature

public static craft\elements\db\ElementQueryInterface find ( )

findAll()

Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.

The method accepts:

  • an int: query by a single ID value and return an array containing the corresponding element (or an empty array if not found).
  • an array of integers: query by a list of ID values and return the corresponding elements (or an empty array if none was found). Note that an empty array will result in an empty result as it will be interpreted as a search for primary keys and not an empty set of element criteria parameters.
  • an array of name-value pairs: query by a set of parameter values and return an array of elements matching all of them (or an empty array if none was found).

Note that this method will automatically call the all() method and return an array of \craft\base\Element instances. For example,

// find the entries whose ID is 10
$entries = Entry::findAll(10);
// the above code is equivalent to:
$entries = Entry::find()->id(10)->all();
// find the entries whose ID is 10, 11 or 12.
$entries = Entry::findAll([10, 11, 12]);
// the above code is equivalent to:
$entries = Entry::find()->id([10, 11, 12]])->all();
// find users whose email ends in "example.com"
$users = User::findAll(['email' => '*example.com']);
// the above code is equivalent to:
$users = User::find()->email('*example.com')->all();

View source

Arguments

  • $criteria (mixed) – The element ID, an array of IDs, or a set of element criteria parameters

Returns

static[] – An array of Element instances, or an empty array if nothing matches.

Signature

public static static[] findAll ( $criteria = null )

findOne()

Returns a single element instance by a primary key or a set of element criteria parameters.

The method accepts:

  • an int: query by a single ID value and return the corresponding element (or null if not found).
  • an array of name-value pairs: query by a set of parameter values and return the first element matching all of them (or null if not found).

Note that this method will automatically call the one() method and return an \craft\base\Element instance. For example,

// find a single entry whose ID is 10
$entry = Entry::findOne(10);
// the above code is equivalent to:
$entry = Entry::find->id(10)->one();
// find the first user whose email ends in "example.com"
$user = User::findOne(['email' => '*example.com']);
// the above code is equivalent to:
$user = User::find()->email('*example.com')->one();

View source

Arguments

  • $criteria (mixed) – The element ID or a set of element criteria parameters

Returns

static, null – Element instance matching the condition, or null if nothing matches.

Signature

public static static, null findOne ( $criteria = null )

getAncestors()

Returns the element’s ancestors.

View source

Arguments

Returns

craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getAncestors ( \craft\base\int $dist = null )

getAttributeLabel()

Returns the text label for the specified attribute.

View source

Arguments

  • $attribute (string) – The attribute name

Returns

string – The attribute label

Signature

public string getAttributeLabel ( $attribute )

getChildren()

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getChildren ( )

getContentTable()

Returns the name of the table this element’s content is stored in.

View source

Returns

string

Signature

public string getContentTable ( )

getCpEditUrl()

Returns the element’s CP edit URL.

View source

Returns

string, null

Signature

public string, null getCpEditUrl ( )

getDescendants()

Returns the element’s descendants.

View source

Arguments

Returns

craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getDescendants ( \craft\base\int $dist = null )

getEagerLoadedElements()

Returns the eager-loaded elements for a given handle.

View source

Arguments

  • $handle (string) – The handle of the eager-loaded elements

Returns

craft\base\ElementInterface[], null – The eager-loaded elements, or null

Signature

public craft\base\ElementInterface[], null getEagerLoadedElements ( \craft\base\string $handle )

getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

Signature

public string getEditorHtml ( )

getFieldColumnPrefix()

Returns the field column prefix this element’s content uses.

View source

Returns

string

Signature

public string getFieldColumnPrefix ( )

getFieldContext()

Returns the field context this element’s content uses.

View source

Returns

string

Signature

public string getFieldContext ( )

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

Signature

public craft\models\FieldLayout, null getFieldLayout ( )

getFieldParamNamespace()

Returns the namespace used by custom field params on the request.

View source

Returns

string, null – The field param namespace

Signature

public string, null getFieldParamNamespace ( )

getFieldValue()

Returns the value for a given field.

View source

Arguments

  • $fieldHandle (string) – The field handle whose value needs to be returned

Returns

mixed – The field value

Signature

public mixed getFieldValue ( \craft\base\string $fieldHandle )

getFieldValues()

Returns the element’s normalized custom field values, indexed by their handles.

View source

Arguments

  • $fieldHandles (string[], null) – The list of field handles whose values need to be returned. Defaults to null, meaning all fields’ values will be returned. If it is an array, only the fields in the array will be returned.

Returns

array – The field values (handle => value)

Signature

public array getFieldValues ( array $fieldHandles = null )

getHasDescendants()

Returns whether the element has descendants.

View source

Returns

boolean

Signature

public boolean getHasDescendants ( )

getHasFreshContent()

Returns whether the element’s content is "fresh" (unsaved and without validation errors).

View source

Returns

boolean – Whether the element’s content is fresh

Signature

public boolean getHasFreshContent ( )

getHtmlAttributes()

Returns any attributes that should be included in the element’s DOM representation in the Control Panel.

View source

Arguments

  • $context (string) – The context that the element is being rendered in ('index', 'field', etc.)

Returns

array

Signature

public array getHtmlAttributes ( \craft\base\string $context )

getId()

Returns the element’s ID.

View source

Returns

integer, null

Signature

public integer, null getId ( )

getIsEditable()

Returns whether the current user can edit the element.

View source

Returns

boolean

Signature

public boolean getIsEditable ( )

Returns an anchor pre-filled with this element’s URL and title.

View source

Returns

Twig_Markup, null

Signature

public Twig_Markup, null getLink ( )

getNext()

Returns the next element relative to this one, from a given set of criteria.

View source

Arguments

  • $criteria (mixed)

Returns

craft\base\ElementInterface, null

Signature

public craft\base\ElementInterface, null getNext ( $criteria = false )

getNextSibling()

Returns the element’s next sibling.

View source

Returns

craft\base\ElementInterface, null

Signature

public craft\base\ElementInterface, null getNextSibling ( )

getParent()

Returns the element’s parent.

View source

Returns

craft\base\ElementInterface, null

Signature

public craft\base\ElementInterface, null getParent ( )

getPrev()

Returns the previous element relative to this one, from a given set of criteria.

View source

Arguments

  • $criteria (mixed)

Returns

craft\base\ElementInterface, null

Signature

public craft\base\ElementInterface, null getPrev ( $criteria = false )

getPrevSibling()

Returns the element’s previous sibling.

View source

Returns

craft\base\ElementInterface, null

Signature

public craft\base\ElementInterface, null getPrevSibling ( )

getRef()

Returns the reference string to this element.

View source

Returns

string, null

Signature

public string, null getRef ( )

getRoute()

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

public mixed getRoute ( )

getSearchKeywords()

Returns the search keywords for a given search attribute.

View source

Arguments

Returns

string

Signature

public string getSearchKeywords ( \craft\base\string $attribute )

getSerializedFieldValues()

Returns an array of the element’s serialized custom field values, indexed by their handles.

View source

Arguments

  • $fieldHandles (string[], null) – The list of field handles whose values need to be returned. Defaults to null, meaning all fields’ values will be returned. If it is an array, only the fields in the array will be returned.

Returns

array

Signature

public array getSerializedFieldValues ( array $fieldHandles = null )

getSiblings()

Signature

public craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[] getSiblings ( )

getSite()

Returns the site the element is associated with.

View source

Returns

craft\models\Site

Throws

Signature

public craft\models\Site getSite ( )

getStatus()

Returns the element’s status.

View source

Returns

string, null

Signature

public string, null getStatus ( )

getSupportedSites()

Returns the sites this element is associated with.

The function can either return an array of site IDs, or an array of sub-arrays, each with the keys 'siteId' (int) and 'enabledByDefault' (bool).

View source

Returns

integer[], array

Signature

public integer[], array getSupportedSites ( )

getTableAttributeHtml()

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

This method can be used to completely customize what actually shows up within the table’s body for a given attribute, rather than simply showing the attribute’s raw value. For example, if your elements have an “email” attribute that you want to wrap in a mailto: link, your getTableAttributesHtml() method could do this:

switch ($attribute) {
    case 'email':
        return $this->email ? '<a href="mailto:'.$this->email.'">'.$this->email.'</a>' : '';
    // ...
}
return parent::getTableAttributeHtml($attribute);

craft\base\Element::getTableAttributeHtml() provides a couple handy attribute checks by default, so it is a good idea to let the parent method get called (as shown above). They are:

  • If the attribute name is ‘link’ or ‘uri’, it will be linked to the front-end URL.
  • If the attribute is a custom field handle, it will pass the responsibility off to the field class.
  • If the attribute value is a DateTime object, the date will be formatted with a localized date format.
  • For anything else, it will output the attribute value as a string.

View source

Arguments

  • $attribute (string) – The attribute name.

Returns

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

Signature

public string getTableAttributeHtml ( \craft\base\string $attribute )

getThumbUrl()

Returns the URL to the element’s thumbnail, if there is one.

View source

Arguments

Returns

string, null

Signature

public string, null getThumbUrl ( \craft\base\int $size )

getTotalDescendants()

Returns the total number of descendants that the element has.

View source

Returns

integer

Signature

public integer getTotalDescendants ( )

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 ( )

getUrl()

Returns the element’s full URL.

View source

Returns

string, null

Signature

public string, null getUrl ( )

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 ( )

hasEagerLoadedElements()

Returns whether elements have been eager-loaded with a given handle.

View source

Arguments

  • $handle (string) – The handle of the eager-loaded elements

Returns

boolean – Whether elements have been eager-loaded with the given handle

Signature

public boolean hasEagerLoadedElements ( \craft\base\string $handle )

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 ( )

indexHtml()

Returns the element index HTML.

View source

Arguments

Returns

string – The element index HTML

Signature

public static string indexHtml ( craft\elements\db\ElementQueryInterface $elementQuery, array $disabledElementIds = null, array $viewState, \craft\base\string $sourceKey = null, \craft\base\string $context = null, \craft\base\bool $includeContainer, \craft\base\bool $showCheckboxes )

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Signature

public void init ( )

isAncestorOf()

Returns whether this element is an ancestor of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isAncestorOf ( craft\base\ElementInterface $element )

isChildOf()

Returns whether this element is a direct child of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isChildOf ( craft\base\ElementInterface $element )

isDescendantOf()

Returns whether this element is a descendant of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isDescendantOf ( craft\base\ElementInterface $element )

isFieldEmpty()

Returns whether a field is empty.

View source

Arguments

Returns

boolean

Signature

public boolean isFieldEmpty ( \craft\base\string $handle )

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 ( )

isNextSiblingOf()

Returns whether this element is the direct next sibling of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isNextSiblingOf ( craft\base\ElementInterface $element )

isParentOf()

Returns whether this element is a direct parent of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isParentOf ( craft\base\ElementInterface $element )

isPrevSiblingOf()

Returns whether this element is the direct previous sibling of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isPrevSiblingOf ( craft\base\ElementInterface $element )

isSiblingOf()

Returns whether this element is a sibling of another one.

View source

Arguments

Returns

boolean

Signature

public boolean isSiblingOf ( craft\base\ElementInterface $element )

offsetExists()

Returns whether there is an element at the specified offset.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like isset($model[$offset]).

View source

Arguments

  • $offset (mixed) – The offset to check on.

Returns

boolean – Whether or not an offset exists.

Signature

public boolean offsetExists ( $offset )

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 yii\validators\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 built-in validators. 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 ( )

searchableAttributes()

Defines which element attributes should be searchable.

This method should return an array of attribute names that can be accessed on your elements. craft\services\Search will call this method when it is indexing keywords for one of your elements, and for each attribute it returns, it will fetch the corresponding property’s value on the element. For example, if your elements have a “color” attribute which you want to be indexed, this method could return:

return ['color'];

Not only will the “color” attribute’s values start getting indexed, but users will also be able to search directly against that attribute’s values using this search syntax:

color:blue

There is no need for this method to worry about the ‘title’ or ‘slug’ attributes, or custom field handles; those are indexed automatically.

View source

Returns

string[] – The element attributes that should be searchable

Signature

public static string[] searchableAttributes ( )

setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

Signature

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

setFieldParamNamespace()

Sets the namespace used by custom field params on the request.

View source

Arguments

  • $namespace (string) – The field param namespace

Signature

public void setFieldParamNamespace ( \craft\base\string $namespace )

setFieldValue()

Sets the value for a given field.

View source

Arguments

  • $fieldHandle (string) – The field handle whose value needs to be set
  • $value (mixed) – The value to set on the field

Signature

public void setFieldValue ( \craft\base\string $fieldHandle, $value )

setFieldValues()

Sets the element’s custom field values.

View source

Arguments

  • $values (array) – The custom field values (handle => value)

Signature

public void setFieldValues ( array $values )

setFieldValuesFromRequest()

Sets the element’s custom field values, when the values have come from post data.

View source

Arguments

  • $paramNamespace (string) – The field param namespace

Signature

public void setFieldValuesFromRequest ( \craft\base\string $paramNamespace = '' )

setNext()

Sets the default next element.

View source

Arguments

Signature

public void setNext ( $element )

setParent()

Sets the element’s parent.

View source

Arguments

Signature

public void setParent ( craft\base\ElementInterface $parent = null )

setPrev()

Sets the default previous element.

View source

Arguments

Signature

public void setPrev ( $element )

sortOptions()

Returns the sort options for the element type.

This method should return an array, where each item is a sub-array with the following keys:

  • label – The sort option label
  • orderBy – A comma-delimited string of columns to order the query by
  • attribute(optional) – The table attribute name that this option is associated with
return [
    [
        'label' => Craft::t('app', 'Attribute Label'),
        'orderBy' => 'columnName',
        'attribute' => 'attributeName'
    ],
];

A shorthand syntax is also supported, if there is no corresponding table attribute, or the table attribute has the exact same name as the column.

return [
    'columnName' => Craft::t('app', 'Attribute Label'),
];

Note that this method will only get called once for the entire index; not each time that a new source is selected.

View source

Returns

array – The attributes that elements can be sorted by

Signature

public static array sortOptions ( )

sources()

Returns the source definitions that elements of this type may belong to.

This defines what will show up in the source list on element indexes and element selector modals. Each item in the array should be set to an array that has the following keys:

  • key – The source’s key. This is the string that will be passed into the $source argument of actions(), indexHtml(), and defaultTableAttributes().
  • label – The human-facing label of the source.
  • sites – An array of site IDs that the source should be shown for, on multi-site element indexes. (Optional; by default the source will be shown for all sites.)
  • criteria – An array of element criteria parameters that the source should use when the source is selected. (Optional)
  • data – An array of data-X attributes that should be set on the source’s <a> tag in the source list’s, HTML, where each key is the name of the attribute (without the “data-” prefix), and each value is the value of the attribute. (Optional)
  • defaultSort – A string identifying the sort attribute that should be selected by default, or an array where the first value identifies the sort attribute, and the second determines which direction to sort by. (Optional)
  • hasThumbs – A bool that defines whether this source supports Thumbs View. (Use your element’s getThumbUrl() method to define your elements’ thumb URL.) (Optional)
  • structureId – The ID of the Structure that contains the elements in this source. If set, Structure View will be available to this source. (Optional)
  • newChildUrl – The URL that should be loaded when a usel select’s the “New child” menu option on an element in this source while it is in Structure View. (Optional)
  • nested – An array of sources that are nested within this one. Each nested source can have the same keys as top-level sources.

View source

Arguments

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

Returns

array – The sources.

Signature

public static array sources ( \craft\base\string $context = null )

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 ( )

tableAttributes()

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

This method should return an array whose keys map to attribute names and database columns that can be sorted against when querying for elements, and whose values make up the table’s column headers. The first item that this array returns will just identify the database column name, and the table column’s header, but will not have any effect on what shows up in the table’s body. That’s because the first column is reserved for displaying whatever your element’s __toString() method returns. All other items besides the first one will also define which element attribute should be shown within the data cells. (The actual HTML to be shown can be customized with getTableAttributeHtml().)

View source

Returns

array – The table attributes.

Signature

public static array tableAttributes ( )

validateCustomFieldAttribute()

Calls a custom validation function on a custom field. This will be called by yii\validators\InlineValidator if a custom field specified a closure or the name of a class-level method as the validation type.

View source

Arguments

Signature

public void validateCustomFieldAttribute ( \craft\base\string $attribute, array $params = null )

validateCustomFieldContentSize()

Validates that the content size is going to fit within the field’s database column.

View source

Arguments

Signature

public void validateCustomFieldContentSize ( \craft\base\string $attribute )

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.
prepElementQueryForTableAttribute()Preps the element criteria for a given table attribute
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).

See also actions()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\base\string $source = null )

defineDefaultTableAttributes()

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

See also:

View source

Arguments

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

Returns

string[] – The table attributes.

Signature

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

defineSearchableAttributes()

Defines which element attributes should be searchable.

See also searchableAttributes()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.

See also sortOptions()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.

See also sources()View source

Arguments

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

Returns

array – The sources.

Signature

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

defineTableAttributes()

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

See also tableAttributes()View source

Returns

array – The table attributes.

Signature

protected static array defineTableAttributes ( )

fieldByHandle()

Returns the field with a given handle.

View source

Arguments

Returns

craft\base\Field, null

Signature

protected craft\base\Field, null fieldByHandle ( \craft\base\string $handle )

fieldLayoutFields()

Returns each of this element’s fields.

View source

Returns

craft\base\Field[] – This element’s fields

Signature

protected craft\base\Field[] fieldLayoutFields ( )

findByCondition()

Finds Element instance(s) by the given condition. This method is internally called by findOne() and findAll().

View source

Arguments

Returns

static, static[], null

Signature

protected static static, static[], null findByCondition ( $criteria, \craft\base\bool $one )

htmlAttributes()

Returns any attributes that should be included in the element’s DOM representation in the Control Panel.

See also getHtmlAttributes()View source

Arguments

  • $context (string) – The context that the element is being rendered in ('index', 'field', etc.)

Returns

array

Signature

protected array htmlAttributes ( \craft\base\string $context )

normalizeFieldValue()

Normalizes a field’s value.

View source

Arguments

  • $fieldHandle (string) – The field handle

Throws

Signature

protected void normalizeFieldValue ( \craft\base\string $fieldHandle )

prepElementQueryForTableAttribute()

Preps the element criteria for a given table attribute

View source

Arguments

Signature

protected static void prepElementQueryForTableAttribute ( craft\elements\db\ElementQueryInterface $elementQuery, \craft\base\string $attribute )

route()

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

See also getRoute()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.

See also getTableAttributeHtml()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\base\string $attribute )

Constants

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

Events

EVENT_AFTER_DELETE

Type
yii\base\Event

The event that is triggered after the element is deleted

EVENT_AFTER_MOVE_IN_STRUCTURE

Type
craft\events\ElementStructureEvent

The event that is triggered after the element is moved in a structure.

EVENT_AFTER_SAVE

Type
craft\events\ModelEvent

The event that is triggered after the element is saved

EVENT_BEFORE_DELETE

Type
craft\events\ModelEvent

The event that is triggered before the element is deleted You may set craft\events\ModelEvent::$isValid to false to prevent the element from getting deleted.

EVENT_BEFORE_MOVE_IN_STRUCTURE

Type
craft\events\ElementStructureEvent

The event that is triggered before the element is moved in a structure.

You may set craft\events\ElementStructureEvent::$isValid to false to prevent the element from getting moved.

EVENT_BEFORE_SAVE

Type
craft\events\ModelEvent

The event that is triggered before the element is saved You may set craft\events\ModelEvent::$isValid to false to prevent the element from getting saved.

EVENT_REGISTER_ACTIONS

Type
craft\events\RegisterElementActionsEvent

The event that is triggered when registering the available actions for the element type.

EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES

Type
craft\events\RegisterElementTableAttributesEvent

The event that is triggered when registering the table attributes for the element type.

EVENT_REGISTER_HTML_ATTRIBUTES

Type
craft\events\RegisterElementHtmlAttributesEvent

The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the Control Panel.

EVENT_REGISTER_SEARCHABLE_ATTRIBUTES

Type
craft\events\RegisterElementSearchableAttributesEvent

The event that is triggered when registering the searchable attributes for the element type.

EVENT_REGISTER_SORT_OPTIONS

Type
craft\events\RegisterElementSortOptionsEvent

The event that is triggered when registering the sort options for the element type.

EVENT_REGISTER_SOURCES

Type
craft\events\RegisterElementSourcesEvent

The event that is triggered when registering the available sources for the element type.

EVENT_REGISTER_TABLE_ATTRIBUTES

Type
craft\events\RegisterElementTableAttributesEvent

The event that is triggered when registering the table attributes for the element type.

EVENT_SET_ROUTE

Type
craft\events\SetElementRouteEvent

The event that is triggered when defining the route that should be used when this element’s URL is requested

Event::on(craft\elements\Entry::class, craft\base\Element::EVENT_SET_ROUTE, function(craft\events\SetElementRouteEvent $e) {
    // @var craft\elements\Entry $entry
    $entry = $e->sender;

    if ($entry->uri === 'pricing') {
        $e->route = 'module/pricing/index';
    }
}

EVENT_SET_TABLE_ATTRIBUTE_HTML

Type
craft\events\SetElementTableAttributeHtmlEvent

The event that is triggered when defining the HTML to represent a table attribute.