BaseElementAction

Type
Abstract Class
Namespace
Craft
Inherits
Craft\BaseElementAction » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
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

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Protected Properties

PropertyDescription
$componentTypestring

$componentType

Signature

protected string $componentType = 'ElementAction'

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__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.
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()Returns the list of attached event handlers for an event.
getIsInitialized()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()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()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

Returns

string, null – 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

Returns

string, null – 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

Returns

Craft\BaseModel – The action’s params model.

Signature

public Craft\BaseModel getParams ( )

getTriggerHtml()

Returns the action’s trigger HTML.

IElementAction::getTriggerHtml()

View source

Returns

string, null – The action’s trigger HTML.

Signature

public string, null getTriggerHtml ( )

isDestructive()

Returns whether this action is destructive in nature.

IElementAction::isDestructive()

View source

Returns

boolean – 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

Arguments

Returns

boolean – 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

Arguments

Returns

null

Signature

public null setParams ( $values )

Protected Methods

MethodDescription
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

Returns

array

Signature

protected array defineParams ( )

getParamsModel()

Returns the params model.

View source

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

Arguments

  • $message

Returns

null

Signature

protected null setMessage ( $message )