Property Details

$collapsed public property #

Collapsed

public boolean $collapsed = false

$fieldId public property #

Field ID

public integer, null $fieldId = null

$ownerId public property #

Owner ID

public integer, null $ownerId = null

$ownerSiteId public property #

Owner site ID

public integer, null $ownerSiteId = null

$sortOrder public property #

Sort order

public integer, null $sortOrder = null

$typeId public property #

Type ID

public integer, null $typeId = null

Method Details

afterDelete() public method #

Performs actions after an element is deleted.

public void afterDelete ( )

afterSave() public method #

Performs actions after an element is saved.

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

displayName() public static method #

Returns the display name of this class.

public static string displayName ( )

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

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\MatrixBlockQuery find ( )

getContentTable() public method #

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

public string getContentTable ( )

getEagerLoadedElements() public method #

Returns the eager-loaded elements for a given handle.

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

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

getHasFreshContent() public method #

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

public boolean getHasFreshContent ( )

getOwner() public method #

Returns the owner.

public craft\base\ElementInterface, null getOwner ( )

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

getType() public method #

Returns the block type.

public craft\models\MatrixBlockType getType ( )

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

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

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

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\elements\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 \craft\elements\Validator, or a model class method (called inline validator) that has the following signature:

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

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

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

Below are some examples:

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

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

public array rules ( )

setEagerLoadedElements() public method #

Sets some eager-loaded elements on a given handle.

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

setOwner() public method #

Sets the owner

public void setOwner ( craft\base\ElementInterface $owner = null )