Method Details

__call() public method #

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.

public mixed __call ( $name, $params )

__get() public method #

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

public mixed __get ( $name )

__isset() public method #

Checks if a property is set.

This method will check if $name is one of the following:

• "title"
• a magic property supported by yii\base\Component::__isset()
• a custom field handle

public boolean __isset ( $name )

__set() public method #

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

public void __set ( $name, $value )

__toString() public method #

Returns the string representation of the element.

public string __toString ( )

actions() public static method #

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.

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

addError() public method #

Adds a new error to the specified attribute.

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

afterDelete() public method #

Performs actions after an element is deleted.

public void afterDelete ( )

afterMoveInStructure() public method #

Performs actions after an element is moved within a structure.

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

afterSave() public method #

Performs actions after an element is saved.

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

attributeLabels() public method #

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

public array attributeLabels ( )

attributes() public method #

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.

public array attributes ( )

beforeDelete() public method #

Performs actions before an element is deleted.

public boolean beforeDelete ( )

beforeMoveInStructure() public method #

Performs actions before an element is moved within a structure.

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

beforeSave() public method #

Performs actions before an element is saved.

public boolean beforeSave ( \craft\base\bool $isNew )

behaviors() public method #

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

public array behaviors ( )

defaultTableAttributes() public static method #

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

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

defineActions() protected static method #

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

See also actions().

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

defineDefaultTableAttributes() protected static method #

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

See also:

• defaultTableAttributes()
• tableAttributes()

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

defineSearchableAttributes() protected static method #

Defines which element attributes should be searchable.

See also searchableAttributes().

protected static string[] defineSearchableAttributes ( )

defineSortOptions() protected static method #

Returns the sort options for the element type.

See also sortOptions().

protected static array defineSortOptions ( )

defineSources() protected static method #

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

See also sources().

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

defineTableAttributes() protected static method #

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

See also tableAttributes().

protected static array defineTableAttributes ( )

eagerLoadingMap() public static method #

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.

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

extraFields() public method #

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

public array extraFields ( )

fieldByHandle() protected method #

Returns the field with a given handle.

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

fieldLayoutFields() protected method #

Returns each of this element’s fields.

protected craft\base\Field[] fieldLayoutFields ( )

find() public static method #

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);
    }
}

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

findAll() public static method #

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

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

findByCondition() protected static method #

Finds Element instance(s) by the given condition.

This method is internally called by findOne() and findAll().

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

findOne() public static method #

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

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

getAncestors() public method #

Returns the element’s ancestors.

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

getAttributeLabel() public method #

Returns the text label for the specified attribute.

public string getAttributeLabel ( $attribute )

getChildren() public method #

Returns the element’s children.

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

getContentTable() public method #

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

public string getContentTable ( )

getCpEditUrl() public method #

Returns the element’s CP edit URL.

public string, null getCpEditUrl ( )

getDescendants() public method #

Returns the element’s descendants.

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

getEagerLoadedElements() public method #

Returns the eager-loaded elements for a given handle.

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

getEditorHtml() public method #

Returns the HTML for the element’s editor HUD.

public string getEditorHtml ( )

getFieldColumnPrefix() public method #

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

public string getFieldColumnPrefix ( )

getFieldContext() public method #

Returns the field context this element’s content uses.

public string getFieldContext ( )

getFieldLayout() public method #

Returns the field layout used by this element.

public craft\models\FieldLayout, null getFieldLayout ( )

getFieldParamNamespace() public method #

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

public string, null getFieldParamNamespace ( )

getFieldValue() public method #

Returns the value for a given field.

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

getFieldValues() public method #

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

public array getFieldValues ( array $fieldHandles = null )

getHasDescendants() public method #

Returns whether the element has descendants.

public boolean getHasDescendants ( )

getHasFreshContent() public method #

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

public boolean getHasFreshContent ( )

getHtmlAttributes() public method #

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

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

getId() public method #

Returns the element’s ID.

public integer, null getId ( )

getIsEditable() public method #

Returns whether the current user can edit the element.

public boolean getIsEditable ( )

getLink() public method #

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

public Twig_Markup, null getLink ( )

getNext() public method #

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

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

getNextSibling() public method #

Returns the element’s next sibling.

public craft\base\ElementInterface, null getNextSibling ( )

getParent() public method #

Returns the element’s parent.

public craft\base\ElementInterface, null getParent ( )

getPrev() public method #

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

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

getPrevSibling() public method #

Returns the element’s previous sibling.

public craft\base\ElementInterface, null getPrevSibling ( )

getRef() public method #

Returns the reference string to this element.

public string, null getRef ( )

getRoute() public method #

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

public mixed getRoute ( )

getSearchKeywords() public method #

Returns the search keywords for a given search attribute.

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

getSerializedFieldValues() public method #

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

public array getSerializedFieldValues ( array $fieldHandles = null )

getSiblings() public method #

Returns all of the element’s siblings.

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

getSite() public method #

Returns the site the element is associated with.

public craft\models\Site getSite ( )

getStatus() public method #

Returns the element’s status.

public string, null getStatus ( )

getSupportedSites() public method #

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

public integer[], array getSupportedSites ( )

getTableAttributeHtml() public method #

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.

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

getThumbUrl() public method #

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

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

getTotalDescendants() public method #

Returns the total number of descendants that the element has.

public integer getTotalDescendants ( )

getUriFormat() public method #

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

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

public string, null getUriFormat ( )

getUrl() public method #

Returns the element’s full URL.

public string, null getUrl ( )

hasContent() public static method #

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

public static boolean hasContent ( )

hasEagerLoadedElements() public method #

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

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

hasStatuses() public static method #

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.

public static boolean hasStatuses ( )

hasTitles() public static method #

Returns whether elements of this type have traditional titles.

public static boolean hasTitles ( )

hasUris() public static method #

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.

public static boolean hasUris ( )

htmlAttributes() protected method #

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

See also getHtmlAttributes().

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

indexHtml() public static method #

Returns the element index HTML.

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() public method #

Initializes the object.

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

public void init ( )

isAncestorOf() public method #

Returns whether this element is an ancestor of another one.

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

isChildOf() public method #

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

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

isDescendantOf() public method #

Returns whether this element is a descendant of another one.

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

isFieldEmpty() public method #

Returns whether a field is empty.

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

isLocalized() public static method #

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.

public static boolean isLocalized ( )

isNextSiblingOf() public method #

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

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

isParentOf() public method #

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

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

isPrevSiblingOf() public method #

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

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

isSiblingOf() public method #

Returns whether this element is a sibling of another one.

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

normalizeFieldValue() protected method #

Normalizes a field’s value.

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

offsetExists() public method #

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]).

public boolean offsetExists ( $offset )

prepElementQueryForTableAttribute() protected static method #

Preps the element criteria for a given table attribute

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

refHandle() public static method #

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

public static string, null refHandle ( )

route() protected method #

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

See also getRoute().

protected mixed route ( )

rules() public method #

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 \craft\base\scenario 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().

public array rules ( )

searchableAttributes() public static method #

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.

public static string[] searchableAttributes ( )

setEagerLoadedElements() public method #

Sets some eager-loaded elements on a given handle.

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

setFieldParamNamespace() public method #

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

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

setFieldValue() public method #

Sets the value for a given field.

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

setFieldValues() public method #

Sets the element’s custom field values.

public void setFieldValues ( array $values )

setFieldValuesFromRequest() public method #

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

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

setNext() public method #

Sets the default next element.

public void setNext ( $element )

setParent() public method #

Sets the element’s parent.

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

setPrev() public method #

Sets the default previous element.

public void setPrev ( $element )

sortOptions() public static method #

Returns the sort options for the element type.

This method should return an array, where the keys reference database column names that should be sorted on, and where the values define the user-facing labels.

return [
    'columnName1' => Craft::t('app', 'Attribute Label 1'),
    'columnName2' => Craft::t('app', 'Attribute Label 2'),
];

If you want to sort by multilple columns simultaneously, you can specify multiple column names in the key, separated by commas.

return [
    'columnName1, columnName2 asc' => Craft::t('app', 'Attribute Label 1'),
    'columnName3'                  => Craft::t('app', 'Attribute Label 2'),
];

If you do that, you can specify the sort direction for the subsequent columns (asc or desc. There is no point in specifying the sort direction for the first column, though, since the end user has full control over that. Note that this method will only get called once for the entire index; not each time that a new source is selected.

public static array sortOptions ( )

sources() public static method #

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.

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

statuses() public static method #

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

public static array statuses ( )

tableAttributeHtml() protected method #

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

See also getTableAttributeHtml().

protected string tableAttributeHtml ( \craft\base\string $attribute )

tableAttributes() public static method #

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

public static array tableAttributes ( )

validateCustomFieldAttribute() public method #

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.

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

validateCustomFieldContentSize() public method #

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

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

Event Details

EVENT_AFTER_DELETE event of type yii\base\Event #

The event that is triggered after the element is deleted

EVENT_AFTER_MOVE_IN_STRUCTURE event of type craft\events\ElementStructureEvent #

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

EVENT_AFTER_SAVE event of type craft\events\ModelEvent #

The event that is triggered after the element is saved

EVENT_BEFORE_DELETE event of 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 event of 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 event of 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 event of type craft\events\RegisterElementActionsEvent #

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

EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES event of type craft\events\RegisterElementTableAttributesEvent #

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

EVENT_REGISTER_HTML_ATTRIBUTES event of 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 event of type craft\events\RegisterElementSearchableAttributesEvent #

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

EVENT_REGISTER_SORT_OPTIONS event of type craft\events\RegisterElementSortOptionsEvent #

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

EVENT_REGISTER_SOURCES event of type craft\events\RegisterElementSourcesEvent #

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

EVENT_REGISTER_TABLE_ATTRIBUTES event of type craft\events\RegisterElementTableAttributesEvent #

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

EVENT_SET_ROUTE event of 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 event of type craft\events\SetElementTableAttributeHtmlEvent #

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