FieldLayoutBehavior
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\FieldLayoutBehavior » Craft\BaseBehavior » CBehavior (opens new window) » CComponent (opens new window)
- Implements
IBehavior- Since
- 1.2
Field layout behavior.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $elementType | string (opens new window) – The element type that the field layout will be associated with |
| $idAttribute | string (opens new window) – The name of the attribute on the owner class that is used to store the field layout’s ID |
# $elementType
The element type that the field layout will be associated with
Signature
public string $elementType = null
# $idAttribute
The name of the attribute on the owner class that is used to store the field layout’s ID
Signature
public string $idAttribute = 'fieldLayoutId'
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() | Constructor |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attach() (opens new window) | Attaches the behavior object to the component. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detach() (opens new window) | Detaches the behavior object from the component. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| events() (opens new window) | Declares events and the corresponding event handler methods. |
| getEnabled() (opens new window) | |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getFieldLayout() | Returns the owner's field layout. |
| getOwner() (opens new window) | |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| raiseEvent() (opens new window) | Raises an event. |
| setEnabled() (opens new window) | |
| setFieldLayout() | Sets the owner's field layout. |
# __construct()
Constructor
View source (opens new window)
Arguments
$elementType(string (opens new window), null (opens new window)) – The element type that the field layout will be associated with$idAttribute(string (opens new window), null (opens new window)) – The name of the attribute on the owner class that is used to store the field layout’s ID
Signature
public void __construct ( $elementType = null, $idAttribute = null )
# getFieldLayout()
Signature
public Craft\FieldLayoutModel getFieldLayout ( )
# setFieldLayout()
Sets the owner's field layout.
View source (opens new window)
Arguments
$fieldLayout(Craft\FieldLayoutModel)
Returns
Signature
public null setFieldLayout ( Craft\FieldLayoutModel $fieldLayout )