Skip to content

FieldLayoutComponent

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\FieldLayoutComponent » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ModelInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\base\FieldLayoutElement, craft\fieldlayoutelements\BaseField, craft\fieldlayoutelements\BaseNativeField, craft\fieldlayoutelements\BaseUiElement, craft\fieldlayoutelements\CustomField, craft\fieldlayoutelements\FullNameField, craft\fieldlayoutelements\Heading, craft\fieldlayoutelements\HorizontalRule, craft\fieldlayoutelements\Html, craft\fieldlayoutelements\LineBreak, craft\fieldlayoutelements\Template, craft\fieldlayoutelements\TextField, craft\fieldlayoutelements\TextareaField, craft\fieldlayoutelements\Tip, craft\fieldlayoutelements\TitleField, craft\fieldlayoutelements\addresses\AddressField, craft\fieldlayoutelements\addresses\CountryCodeField, craft\fieldlayoutelements\addresses\LabelField, craft\fieldlayoutelements\addresses\LatLongField, craft\fieldlayoutelements\addresses\OrganizationField, craft\fieldlayoutelements\addresses\OrganizationTaxIdField, craft\fieldlayoutelements\assets\AltField, craft\fieldlayoutelements\assets\AssetTitleField, craft\fieldlayoutelements\entries\EntryTitleField, craft\fieldlayoutelements\users\EmailField, craft\fieldlayoutelements\users\FullNameField, craft\fieldlayoutelements\users\PhotoField, craft\fieldlayoutelements\users\UsernameField, craft\models\FieldLayoutTab
Since
4.0.0

FieldLayoutComponent is the base class for classes representing field layout components (tabs or elements) in terms of objects.

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
elementConditioncraft\elements\conditions\ElementConditionInterface, null – The element condition for this layout element
elementTypestring, null – The element type the field layout is for
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
iteratorArrayIterator – An iterator for traversing the items in the list.
layoutcraft\models\FieldLayout – The layout this element belongs to
scenariostring – The scenario that this model is in.
settingsHtmlstring
uidstring, null – The UUID of the layout element.
userConditioncraft\elements\conditions\users\UserCondition, null – The user condition for this layout element
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

elementCondition

Type
craft\elements\conditions\ElementConditionInterface, null
Default value
null

The element condition for this layout element

View source

elementType

Type
string, null
Default value
null
Since
5.0.0

The element type the field layout is for

View source

layout

Type
craft\models\FieldLayout
Default value
null

The layout this element belongs to

View source

settingsHtml

Type
string
Default value
null
Access
Read-only
Since
4.0.0

View source

uid

Type
string, null
Default value
null

The UUID of the layout element.

View source

userCondition

Type
craft\elements\conditions\users\UserCondition, null
Default value
null

The user condition for this layout element

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be 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.
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.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getElementCondition()Returns the element condition for this layout element.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
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.
getLayout()Returns the layout this element belongs to.
getScenario()Returns the scenario that this model is used in.
getSettingsHtml()Returns the settings HTML for the layout element.
getUserCondition()Returns the user condition for this layout element.
getValidators()Returns all the validators declared in rules().
hasConditions()Returns whether this element has any conditions.
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 for this component.
hasSettings()Returns whether the layout element has settings.
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.
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.
setElementCondition()Sets the element condition for this layout element.
setLayout()Sets the layout this element belongs to.
setScenario()Sets the scenario for the model.
setUserCondition()Sets the user condition for this layout element.
showInForm()Returns whether the layout element should be shown in an edit form for the given element.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

fields()

Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.

A field is a named element in the returned array by toArray().

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

php
function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

  • email: the field name is the same as the property name email;
  • firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
  • fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.
php
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on scenario or the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

The default implementation of this method returns attributes() indexed by the same attribute names.

View source

Returns

array – The list of field names or field definitions.

getElementCondition()

Returns the element condition for this layout element.

View source

Returns

craft\elements\conditions\ElementConditionInterface, null

getLayout()

Returns the layout this element belongs to.

View source

Returns

craft\models\FieldLayout

getSettingsHtml()

Since
4.0.0

Returns the settings HTML for the layout element.

TIP

Subclasses should override settingsHtml() instead of this method.

View source

Returns

string

getUserCondition()

Returns the user condition for this layout element.

View source

Returns

craft\elements\conditions\users\UserCondition, null

hasConditions()

Returns whether this element has any conditions.

View source

Returns

boolean

hasSettings()

Since
5.0.0

Returns whether the layout element has settings.

View source

Returns

boolean

setElementCondition()

Sets the element condition for this layout element.

View source

Arguments

setLayout()

Sets the layout this element belongs to.

View source

Arguments

setUserCondition()

Sets the user condition for this layout element.

View source

Arguments

showInForm()

Since
4.0.0

Returns whether the layout element should be shown in an edit form for the given element.

This will only be called if the field layout component has been saved with a UUID already.

View source

Arguments

Returns

boolean

Protected Methods

MethodDescription
conditional()Returns whether this element can be conditional.
defineBehaviors()Returns the behaviors to attach to this class.
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().
settingsHtml()Returns the settings HTML for the layout element.

conditional()

Returns whether this element can be conditional.

View source

Returns

boolean

settingsHtml()

Returns the settings HTML for the layout element.

View source

Returns

string, null

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.