BaseElementAction

Type

Abstract Class

Namespace

Craft

Inherits

Craft\BaseElementAction » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)

Implements

Craft\IComponentType, Craft\IElementAction, IApplicationComponent

Extended by

Craft\CopyReferenceTagElementAction, Craft\DeleteAssetsElementAction, Craft\DeleteElementAction, Craft\DeleteUsersElementAction, Craft\DownloadFileElementAction, Craft\EditElementAction, Craft\NewChildElementAction, Craft\RenameFileElementAction, Craft\ReplaceFileElementAction, Craft\SetStatusElementAction, Craft\SuspendUsersElementAction, Craft\UnsuspendUsersElementAction, Craft\ViewElementAction

Since

2.3

Element Action base class

View source (opens new window)

Public Properties

Property	Description
$behaviors (opens new window)	array (opens new window) – The behaviors that should be attached to this component.

Protected Properties

Property	Description
$componentType	string (opens new window)

$componentType

Type

string (opens new window)

View source (opens new window)

Signature

protected string $componentType = 'ElementAction'

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__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.
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.
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.
getClassHandle()	Returns the component’s handle, ideally based on the class name.
getConfirmationMessage()	Returns a confirmation message that should be displayed before the action is performed.
getEventHandlers() (opens new window)	Returns the list of attached event handlers for an event.
getIsInitialized() (opens new window)	Checks if this application component has been initialized.
getMessage()	Returns the message that should be displayed to the user after the action is performed.
getName()	Returns the component’s name.
getParams()	Returns the action’s params model.
getTriggerHtml()	Returns the action’s trigger HTML.
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.
init() (opens new window)	Initializes the application component.
isDestructive()	Returns whether this action is destructive in nature.
isInitialized()	Checks if this application component has been initialized yet, or not.
isSelectable()	Returns whether this component should be shown when the user is creating a component of this type.
performAction()	Performs the action on any elements that match the given criteria.
raiseEvent() (opens new window)	Raises an event.
setParams()	Sets the param values.

getConfirmationMessage()

Returns a confirmation message that should be displayed before the action is performed.

IElementAction::getConfirmationMessage()

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The confirmation message, if any.

Signature

public string, null getConfirmationMessage ( )

getMessage()

Returns the message that should be displayed to the user after the action is performed.

IElementAction::getMessage()

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The message that should be displayed to the user.

Signature

public string, null getMessage ( )

getParams()

Returns the action’s params model.

IElementAction::getParams()

View source (opens new window)

Returns

Craft\BaseModel – The action’s params model.

Signature

public Craft\BaseModel getParams ( )

getTriggerHtml()

Returns the action’s trigger HTML.

IElementAction::getTriggerHtml()

View source (opens new window)

Returns

string (opens new window), null (opens new window) – The action’s trigger HTML.

Signature

public string, null getTriggerHtml ( )

isDestructive()

Returns whether this action is destructive in nature.

IElementAction::isDestructive()

View source (opens new window)

Returns

boolean (opens new window) – Whether this action is destructive in nature.

Signature

public boolean isDestructive ( )

performAction()

Performs the action on any elements that match the given criteria.

IElementAction::performAction()

View source (opens new window)

Arguments

• $criteria (Craft\ElementCriteriaModel) – The criteria defining which elements the action should affect.

Returns

boolean (opens new window) – Whether the action was performed successfully.

Signature

public boolean performAction ( Craft\ElementCriteriaModel $criteria )

setParams()

Sets the param values.

The values may come as a key/value array, or a {@link BaseModel} object. Either way, this method should store the values on the model that is returned by {@link getParams()}.

IElementAction::setParams()

View source (opens new window)

Arguments

• $values (array (opens new window), Craft\BaseModel) – The new param values.

Returns

null (opens new window)

Signature

public null setParams ( $values )

Protected Methods

Method	Description
defineParams()	Defines the params.
getParamsModel()	Returns the params model.
setMessage()	Sets the message that should be displayed to the user after the action is performed.

defineParams()

Defines the params.

View source (opens new window)

Returns

array (opens new window)

Signature

protected array defineParams ( )

getParamsModel()

Returns the params model.

View source (opens new window)

Returns

Craft\BaseModel

Signature

protected Craft\BaseModel getParamsModel ( )

setMessage()

Sets the message that should be displayed to the user after the action is performed.

View source (opens new window)

Arguments

• $message

Returns

null (opens new window)

Signature

protected null setMessage ( $message )