FieldLayoutElement

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\FieldLayoutElement » yii\base\BaseObject (opens new window)
Implements
craft\base\FieldLayoutElementInterface, yii\base\Configurable (opens new window)
Uses traits
yii\base\ArrayableTrait (opens new window)
Extended by
craft\fieldlayoutelements\BaseField, craft\fieldlayoutelements\BaseUiElement, craft\fieldlayoutelements\CustomField, craft\fieldlayoutelements\EntryTitleField, craft\fieldlayoutelements\Heading, craft\fieldlayoutelements\HorizontalRule, craft\fieldlayoutelements\StandardField, craft\fieldlayoutelements\StandardTextField, craft\fieldlayoutelements\Template, craft\fieldlayoutelements\Tip, craft\fieldlayoutelements\TitleField
Since
3.5.0

FieldLayoutElementInterface defines the common interface to be implemented by field layout element classes.

View source (opens new window)

# Public Properties

Property Description
width integer (opens new window) – The width (%) of the field

# width

Type
integer (opens new window)
Default value
100

The width (%) of the field

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
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.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields()
formHtml() Returns the element’s form HTMl.
hasCustomWidth() Returns whether the element can have a custom width.
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.
init() (opens new window) Initializes the object.
selectorHtml() Returns the selector HTML that should be displayed within field layout designers.
settingsHtml() Returns the settings HTML for the layout element.
toArray() (opens new window) Converts the model into an array.

# fields()

View source (opens new window)

# hasCustomWidth()

Returns whether the element can have a custom width.

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)

# Protected Methods

Method Description
containerAttributes() Returns the element container HTML 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).

# containerAttributes()

Returns the element container HTML attributes.

View source (opens new window)

Arguments

Returns

array (opens new window)