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.
Public Properties
| Property | Description |
|---|---|
| elementType | string, null – The element type that the field layout will be associated with |
| fieldLayout | craft\models\FieldLayout |
| fieldLayoutId | integer |
| fields | craft\base\FieldInterface[] |
| idAttribute | string, null – The attribute on the owner that holds the field layout ID |
| owner | yii\base\Component, null – The owner of this behavior |
elementType
The element type that the field layout will be associated with
fieldLayout
fieldLayoutId
- Type
- integer
fields
idAttribute
The attribute on the owner that holds the field layout ID
Public Methods
| Method | Description |
|---|---|
| __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. |
| getFieldLayout() | Returns the owner's field layout. |
| getFieldLayoutId() | Returns the owner's field layout ID. |
| getFields() | Returns the fields associated with the owner's field layout. |
| 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. |
| setFields() | Sets the fields associated with the owner's field layout |
getFieldLayout()
Returns the owner's field layout.
Returns
Throws
- yii\base\InvalidConfigException
if the configured field layout ID is invalid
getFieldLayoutId()
Returns the owner's field layout ID.
Returns
Throws
- yii\base\InvalidConfigException
if the field layout ID could not be determined
getFields()
Returns the fields associated with the owner's field layout.
Returns
init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
Throws
- yii\base\InvalidConfigException
if the behavior was not configured properly
setFieldLayout()
Sets the owner's field layout.
Arguments
$fieldLayout(craft\models\FieldLayout)
setFieldLayoutId()
Sets the owner's field layout ID.
Arguments
setFields()
Sets the fields associated with the owner's field layout
Arguments
$fields(craft\base\FieldInterface[])