FieldLayoutComponent

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\FieldLayoutComponent » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ModelInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
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\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\AddressesField, 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 (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
elementCondition craft\elements\conditions\ElementConditionInterface, null (opens new window) – The element condition for this layout element
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
layout craft\models\FieldLayout – The layout this element belongs to
scenario (opens new window) string (opens new window) – The scenario that this model is in.
settingsHtml string (opens new window)
uid string (opens new window), null (opens new window) – The UUID of the layout element.
userCondition craft\elements\conditions\users\UserCondition, null (opens new window) – The user condition for this layout element
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# elementCondition

Type
craft\elements\conditions\ElementConditionInterface, null (opens new window)
Default value
null

The element condition for this layout element

View source (opens new window)

# layout

Type
craft\models\FieldLayout
Default value
null

The layout this element belongs to

View source (opens new window)

# settingsHtml

Type
string (opens new window)
Default value
null
Access
Read-only
Since
4.0.0

View source (opens new window)

# uid

Type
string (opens new window), null (opens new window)
Default value
null

The UUID of the layout element.

View source (opens new window)

# userCondition

Type
craft\elements\conditions\users\UserCondition, null (opens new window)
Default value
null

The user condition for this layout element

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct()
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__unset() (opens new window) Sets a component property to be null.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() (opens new window) Returns the attribute labels.
attributes() (opens new window) Returns the list of attribute names.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getElementCondition() Returns the element condition for this layout element.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getLayout() Returns the layout this element belongs to.
getScenario() (opens new window) 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() (opens new window) Returns all the validators declared in rules() (opens new window).
hasConditions() Returns whether this element has any conditions.
hasErrors() Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) 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() (opens new window) 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() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.

# fields()

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

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

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:

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.
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 (opens new window) 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() (opens new window) indexed by the same attribute names.

View source (opens new window)

Returns

array (opens new window) – The list of field names or field definitions.

# getElementCondition()

Returns the element condition for this layout element.

View source (opens new window)

Returns

craft\elements\conditions\ElementConditionInterface, null (opens new window)

# getLayout()

Returns the layout this element belongs to.

View source (opens new window)

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 (opens new window)

Returns

string (opens new window)

# getUserCondition()

Returns the user condition for this layout element.

View source (opens new window)

Returns

craft\elements\conditions\users\UserCondition, null (opens new window)

# hasConditions()

Returns whether this element has any conditions.

View source (opens new window)

Returns

boolean (opens new window)

# setElementCondition()

Sets the element condition for this layout element.

View source (opens new window)

Arguments

# setLayout()

Sets the layout this element belongs to.

View source (opens new window)

Arguments

# setUserCondition()

Sets the user condition for this layout element.

View source (opens new window)

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 (opens new window)

Arguments

Returns

boolean (opens new window)

# Protected Methods

Method Description
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() (opens new window) 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() (opens new window) Extracts the root field names from nested fields.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
settingsHtml() Returns the settings HTML for the layout element.

# conditional()

Returns whether this element can be conditional.

View source (opens new window)

Returns

boolean (opens new window)

# settingsHtml()

Returns the settings HTML for the layout element.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.