View

Type
Class
Namespace
craft\elements\actions
Inherits
craft\elements\actions\View » craft\base\ElementAction » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementActionInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0

View represents a View element action.

View source

Public Properties

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$confirmationMessagestring, null – The confirmation message, if any.
$dateCreatedDateTime, null – The date that the component was created
$dateUpdatedDateTime, null – The date that the component was last updated
$errorsarray – Errors for all attributes or the specified attribute.
$firstErrorsarray – The first errors.
$idinteger, string, null – The component’s ID (could be a temporary one: "new:X")
$isNewboolean – Whether the component is new
$iteratorArrayIterator – An iterator for traversing the items in the list.
$labelstring, null – The trigger label
$messagestring, null – The message that should be displayed to the user.
$scenariostring – The scenario that this model is in.
$settingsarray – The component’s settings.
$settingsHtmlstring, null
$triggerHtmlstring, null – The action’s trigger HTML.
$triggerLabelstring – The action’s trigger label
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$label

Type
string, null

The trigger label

View source

Signature

public string, null $label = null

$triggerHtml

Type
string, null
Access
Read-only

The action’s trigger HTML.

View source

Signature

public string, null getTriggerHtml ( )

$triggerLabel

Type
string
Access
Read-only

The action’s trigger label

View source

Signature

public string getTriggerLabel ( )

Public Methods

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

getTriggerHtml()

Returns the action’s trigger HTML.

View source

Returns

string, null – The action’s trigger HTML.

Signature

public string, null getTriggerHtml ( )

getTriggerLabel()

Returns the action’s trigger label.

View source

Returns

string – The action’s trigger label

Signature

public string getTriggerLabel ( )

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Signature

public void init ( )

Protected Methods

MethodDescription
extractFieldsFor()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()Extracts the root field names from nested fields.
resolveFields()Determines which fields can be returned by toArray().
setMessage()Sets the message that should be displayed to the user after the action is performed.

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.