FieldLayout

Type
Class
Namespace
craft\models
Inherits
craft\models\FieldLayout » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

FieldLayout model class.

View source

# Public Properties

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
attributes array – Attribute values (name => value).
availableCustomFields \craft\fieldlayoutelements\BaseField[][]
availableStandardFields craft\fieldlayoutelements\BaseField[]
availableUiElements craft\base\FieldLayoutElementInterface[]
behaviors yii\base\Behavior – List of behaviors attached to this component
config array, null
errors array – Errors for all attributes or the specified attribute.
fieldIds integer[]
fields craft\base\FieldInterface[]
firstErrors array – The first errors.
id integer, null – ID
iterator ArrayIterator – An iterator for traversing the items in the list.
scenario string – The scenario that this model is in.
tabs craft\models\FieldLayoutTab[] – The layout’s tabs.
type string, null – The element type
uid string, null – UID
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.

# availableCustomFields

Type
\craft\fieldlayoutelements\BaseField[][]
Access
Read-only
Since
3.5.0

View source

# availableStandardFields

Type
craft\fieldlayoutelements\BaseField[]
Access
Read-only
Since
3.5.0

View source

# availableUiElements

Type
craft\base\FieldLayoutElementInterface[]
Access
Read-only
Since
3.5.0

View source

# config

Type
array, null
Access
Read-only
Since
3.1.0

View source

# fieldIds

Type
integer[]
Access
Read-only

View source

# fields

Type
craft\base\FieldInterface[]
Access
Read-only

View source

# id

Type
integer, null

ID

View source

# tabs

Type
craft\models\FieldLayoutTab[]

The layout’s tabs.

View source

# type

Type
string, null

The element type

View source

# uid

Type
string, null

UID

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct() Constructor.
__get() Returns the value of an object property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets value of an object property.
__unset() Sets an object property to null.
activeAttributes() Returns the attribute names that are subject to validation in the current scenario.
addError() Adds a new error to the specified attribute.
addErrors() Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterValidate() This method is invoked after validation ends.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
attributeHints() Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() Returns the list of attribute names.
beforeValidate() This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() Returns a value indicating whether a property can be read.
canSetProperty() Returns a value indicating whether a property can be set.
className() Returns the fully qualified name of this class.
clearErrors() Removes errors for all attributes or a single attribute.
createForm() Creates a new craft\models\FieldLayoutForm object for the given element.
createFromConfig() Creates a new field layout from the given config.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields() Returns the list of fields that can be expanded further and returned by toArray().
fields() Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName() Returns the form name that this model class should use.
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() Returns the validators applicable to the current scenario.
getAttributeHint() Returns the text hint for the specified attribute.
getAttributeLabel() Returns the text label for the specified attribute.
getAttributes() Returns attribute values.
getAvailableCustomFields() Returns the available fields, grouped by field group name.
getAvailableStandardFields() Returns the available standard fields.
getAvailableUiElements() Returns the layout elements that are available to the field layout, grouped by the type name and (optionally) group name.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getConfig() Returns the field layout config for this field layout.
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.
getField() Returns a field that’s included in the layout by its attribute.
getFieldByHandle() Returns a custom field by its handle.
getFieldIds() Returns the IDs of the custom fields included in the layout.
getFields() Returns the custom fields included in the layout.
getFirstError() Returns the first error of the specified attribute.
getFirstErrors() Returns the first error of every attribute in the model.
getIterator() Returns an iterator for traversing the attributes in the model.
getScenario() Returns the scenario that this model is used in.
getTabs() Returns the layout’s tabs.
getValidators() Returns all the validators declared in rules().
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.
init() Initializes the object.
instance() Returns static class instance, which can be used to obtain meta information.
isAttributeActive() Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() Returns a value indicating whether the attribute is required.
isAttributeSafe() Returns a value indicating whether the attribute is safe for massive assignments.
isFieldIncluded() Returns whether a field is included in the layout by its attribute.
load() Populates the model with input data.
loadMultiple() Populates a set of models with the data from end user.
off() Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() Returns the element at the specified offset.
offsetSet() Sets the element at the specified offset.
offsetUnset() Sets the element value at the specified offset to null.
on() Attaches an event handler to an event.
onUnsafeAttribute() This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() Returns a list of scenarios and the corresponding active attributes.
setAttributes() Sets the attribute values in a massive way.
setFields() Sets the custom fields included in this layout.
setScenario() Sets the scenario for the model.
setTabs() Sets the layout’s tabs.
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Performs the data validation.
validateMultiple() Validates multiple models.

# createForm()

Since
3.5.0

Creates a new craft\models\FieldLayoutForm object for the given element.

The $config array can contain the following keys:

  • tabIdPrefix – prefix that should be applied to the tab content containers’ id attributes
  • namespace – Namespace that should be applied to the tab contents

View source

Arguments

Returns

craft\models\FieldLayoutForm

# createFromConfig()

Since
3.1.0

Creates a new field layout from the given config.

View source

Arguments

Returns

self

# getAvailableCustomFields()

Since
3.5.0

Returns the available fields, grouped by field group name.

View source

Returns

\craft\fieldlayoutelements\BaseField[][]

# getAvailableStandardFields()

Since
3.5.0

Returns the available standard fields.

View source

Returns

craft\fieldlayoutelements\BaseField[]

# getAvailableUiElements()

Since
3.5.0

Returns the layout elements that are available to the field layout, grouped by the type name and (optionally) group name.

View source

Returns

craft\base\FieldLayoutElementInterface[]

# getConfig()

Since
3.1.0

Returns the field layout config for this field layout.

View source

Returns

array, null

# getField()

Since
3.5.0

Returns a field that’s included in the layout by its attribute.

View source

Arguments

Returns

craft\fieldlayoutelements\BaseField

Throws

# getFieldByHandle()

Returns a custom field by its handle.

View source

Arguments

  • $handle (string) – The field handle.

Returns

craft\base\FieldInterface, null

# getFieldIds()

DEPRECATED

Deprecated in 3.5.0.

Returns the IDs of the custom fields included in the layout.

View source

Returns

integer[]

# getFields()

Returns the custom fields included in the layout.

View source

Returns

craft\base\FieldInterface[]

# getTabs()

Returns the layout’s tabs.

View source

Returns

craft\models\FieldLayoutTab[] – The layout’s tabs.

# isFieldIncluded()

Since
3.5.0

Returns whether a field is included in the layout by its attribute.

View source

Arguments

Returns

boolean

# setFields()

Sets the custom fields included in this layout.

View source

Arguments

# setTabs()

Sets the layout’s tabs.

View source

Arguments

  • $tabs (array, craft\models\FieldLayoutTab[]) – An array of the layout’s tabs, which can either be FieldLayoutTab objects or arrays defining the tab’s attributes.

# Protected Methods

Method Description
defineRules() Returns the validation rules for attributes.
extractFieldsFor() Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() Extracts the root field names from nested fields.
resolveFields() Determines which fields can be returned by toArray().

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.

# Events

# EVENT_DEFINE_STANDARD_FIELDS

Type
craft\events\DefineFieldLayoutFieldsEvent
Since
3.5.0

The event that is triggered when defining the standard (not custom) fields for the layout.

use craft\models\FieldLayout;
use craft\events\DefineFieldLayoutFieldsEvent;
use yii\base\Event;

Event::on(
    FieldLayout::class,
    FieldLayout::EVENT_DEFINE_STANDARD_FIELDS,
    function(DefineFieldLayoutFieldsEvent $event) {
        // @var FieldLayout $layout
        $layout = $event->sender;

        if ($layout->type === MyElementType::class) {
            $event->fields[] = MyStandardField::class;
        }
    }
);

See also getAvailableStandardFields()

# EVENT_DEFINE_UI_ELEMENTS

Type
craft\events\DefineFieldLayoutElementsEvent
Since
3.5.0

The event that is triggered when defining UI elements for the layout.

use craft\models\FieldLayout;
use craft\events\DefineFieldLayoutElementsEvent;
use yii\base\Event;

Event::on(
    FieldLayout::class,
    FieldLayout::EVENT_DEFINE_UI_ELEMENTS,
    function(DefineFieldLayoutElementsEvent $event) {
        $event->elements[] = MyUiElement::class;
    }
);

See also getAvailableStandardFields()