FieldLayoutBehavior

Type
Class
Namespace
Craft
Inherits
Craft\FieldLayoutBehavior » Craft\BaseBehavior » CBehavior » CComponent
Implements
IBehavior
Since
1.2

Field layout behavior.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$elementTypestring – The element type that the field layout will be associated with
$idAttributestring – The name of the attribute on the owner class that is used to store the field layout’s ID

$elementType

Type
string

The element type that the field layout will be associated with

View source

Signature

public string $elementType = null

$idAttribute

Type
string

The name of the attribute on the owner class that is used to store the field layout’s ID

View source

Signature

public string $idAttribute = 'fieldLayoutId'

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attach()Attaches the behavior object to the component.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detach()Detaches the behavior object from the component.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
events()Declares events and the corresponding event handler methods.
getEnabled()
getEventHandlers()Returns the list of attached event handlers for an event.
getFieldLayout()Returns the owner's field layout.
getOwner()
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
raiseEvent()Raises an event.
setEnabled()
setFieldLayout()Sets the owner's field layout.

__construct()

Constructor

View source

Arguments

  • $elementType (string, null) – The element type that the field layout will be associated with
  • $idAttribute (string, null) – 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()

Returns the owner's field layout.

View source

Returns

Craft\FieldLayoutModel

Signature

public Craft\FieldLayoutModel getFieldLayout ( )

setFieldLayout()

Sets the owner's field layout.

View source

Arguments

Returns

null

Signature

public null setFieldLayout ( Craft\FieldLayoutModel $fieldLayout )