Skip to content

FieldLayoutBehavior

Type
Class
Namespace
craft\behaviors
Inherits
craft\behaviors\FieldLayoutBehavior » yii\base\Behavior » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Field Layout behavior.

View source

Public Properties

PropertyDescription
customFieldscraft\base\FieldInterface[]
elementTypestring, null – The element type that the field layout will be associated with
fieldLayoutcraft\models\FieldLayout
fieldLayoutIdinteger
idAttributestring, null – The attribute on the owner that holds the field layout ID
ownercraft\base\ElementInterface, yii\base\Model

customFields

Type
craft\base\FieldInterface[]
Default value
null
Access
Read-only
Since
4.0.0

View source

elementType

Type
string, null
Default value
null

The element type that the field layout will be associated with

View source

fieldLayout

Type
craft\models\FieldLayout
Default value
null

View source

fieldLayoutId

Type
integer
Default value
null

View source

idAttribute

Type
string, null
Default value
null

The attribute on the owner that holds the field layout ID

View source

owner

Type
craft\base\ElementInterface, yii\base\Model
Default value
null

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__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.
attach()Attaches the behavior object to the component.
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.
detach()Detaches the behavior object from the component.
events()Declares event handlers for the owner's events.
getCustomFields()Returns the custom fields associated with the owner's field layout.
getFieldLayout()Returns the owner's field layout.
getFieldLayoutId()Returns the owner's field layout ID.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
setFieldLayout()Sets the owner's field layout.
setFieldLayoutId()Sets the owner's field layout ID.

getCustomFields()

Since
4.0.0

Returns the custom fields associated with the owner's field layout.

View source

Returns

craft\base\FieldInterface[]

getFieldLayout()

Returns the owner's field layout.

View source

Returns

craft\models\FieldLayout

Throws

getFieldLayoutId()

Returns the owner's field layout ID.

View source

Returns

integer

Throws

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Throws

setFieldLayout()

Sets the owner's field layout.

View source

Arguments

setFieldLayoutId()

Sets the owner's field layout ID.

View source

Arguments