ElementAction

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\ElementAction » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\ElementActionInterface, craft\base\ModelInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by
craft\elements\actions\CopyReferenceTag, craft\elements\actions\CopyUrl, craft\elements\actions\Delete, craft\elements\actions\DeleteAssets, craft\elements\actions\DeleteForSite, craft\elements\actions\DeleteUsers, craft\elements\actions\DownloadAssetFile, craft\elements\actions\Duplicate, craft\elements\actions\Edit, craft\elements\actions\EditImage, craft\elements\actions\MoveAssets, craft\elements\actions\NewChild, craft\elements\actions\NewSiblingAfter, craft\elements\actions\NewSiblingBefore, craft\elements\actions\PreviewAsset, craft\elements\actions\RenameFile, craft\elements\actions\ReplaceFile, craft\elements\actions\Restore, craft\elements\actions\SetStatus, craft\elements\actions\SuspendUsers, craft\elements\actions\UnsuspendUsers, craft\elements\actions\View
Since
3.0.0

ElementAction is the base class for classes representing element actions in terms of objects.

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
confirmationMessage string (opens new window), null (opens new window) – The confirmation message, if any.
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
message string (opens new window), null (opens new window) – The message that should be displayed to the user.
scenario (opens new window) string (opens new window) – The scenario that this model is in.
settings array (opens new window) – The component’s settings.
settingsHtml string (opens new window), null (opens new window)
triggerHtml string (opens new window), null (opens new window) – The action’s trigger HTML.
triggerLabel string (opens new window) – The action’s trigger label
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# confirmationMessage

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only

The confirmation message, if any.

View source (opens new window)

# message

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only

The message that should be displayed to the user.

View source (opens new window)

# triggerHtml

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only

The action’s trigger HTML.

View source (opens new window)

# triggerLabel

Type
string (opens new window)
Default value
null
Access
Read-only

The action’s trigger label

View source (opens new window)

# Protected Properties

# elementType

Type
string (opens new window)
Default value
null
Since
3.0.30

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct()
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__unset() (opens new window) Sets a component property to be null.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() (opens new window) Returns the attribute labels.
attributes() (opens new window) Returns the list of attribute names.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
displayName() Returns the display name of this class.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getConfirmationMessage() Returns a confirmation message that should be displayed before the action is performed.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getMessage() Returns the message that should be displayed to the user after the action is performed.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSettings() Returns an array of the component’s settings.
getSettingsHtml() Returns the component’s settings HTML.
getTriggerHtml() Returns the action’s trigger HTML.
getTriggerLabel() Returns the action’s trigger label.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasErrors() Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined for this component.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
isDestructive() Returns whether this action is destructive in nature.
isDownload() Returns whether this is a download action.
isSelectable() Returns whether the component should be selectable in component Type selects.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
performAction() Performs the action on any elements that match the given criteria.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) Returns a list of scenarios and the corresponding active attributes.
setAttributes() Sets the attribute values in a massive way.
setElementType() Sets the element type on the action.
setScenario() (opens new window) Sets the scenario for the model.
settingsAttributes() Returns the list of settings attribute names.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.

# getConfirmationMessage()

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

View source (opens new window)

Returns

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

# getMessage()

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

View source (opens new window)

Returns

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

# getTriggerHtml()

Returns the action’s trigger HTML.

View source (opens new window)

Returns

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

# getTriggerLabel()

Returns the action’s trigger label.

View source (opens new window)

Returns

string (opens new window) – The action’s trigger label

# isDestructive()

Returns whether this action is destructive in nature.

View source (opens new window)

Returns

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

# isDownload()

Since
3.5.0

Returns whether this is a download action.

Download actions’ performAction() method should call one of these methods before returning true:

View source (opens new window)

Returns

boolean (opens new window) – Whether this is a download action

# performAction()

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

View source (opens new window)

Arguments

Returns

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

# setElementType()

Sets the element type on the action.

View source (opens new window)

Arguments

# Protected Methods

Method Description
defineBehaviors() Returns the behaviors to attach to this class.
defineRules() Returns the validation rules for attributes.
extractFieldsFor() (opens new window) Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
setMessage() Sets the message that should be displayed to the user after the action is performed.

# setMessage()

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

View source (opens new window)

Arguments

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.