ElementActionEvent

Type
Class
Namespace
Craft
Inherits
Craft\ElementActionEvent » Craft\Event » CEvent » CComponent
Since
1.0

Element Action Event class.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$handledboolean – Whether the event is handled.
$messageboolean – The message that should be displayed in the Control Panel if {@link $performAction} is false
$paramsmixed – Additional event parameters.
$performActionboolean – Whether the caller should go through with the action.
$senderobject – The sender of this event

$message

Type
boolean

The message that should be displayed in the Control Panel if {@link $performAction} is false

View source

Signature

public boolean $message = null

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.
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.
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.
getEventHandlers()Returns the list of attached event handlers for an event.
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.