Class craft\elements\actions\SetStatus

Inheritance: craft\elements\actions\SetStatus » 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\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/elements/actions/SetStatus.php

SetStatus represents a Set Status element action.

Public Properties
Property	Type	Description	Defined By
`$dateCreated`	DateTime, null	The date that the component was created	craft\base\SavableComponentTrait
`$dateUpdated`	DateTime, null	The date that the component was last updated	craft\base\SavableComponentTrait
`$id`	integer, string, null	The component’s ID (could be a temporary one: "new:X")	craft\base\SavableComponentTrait
`$status`	string, null	The status elements should be set to	craft\elements\actions\SetStatus

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

Protected Methods
Method	Description	Defined By
`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".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`resolveFields()`	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait
`setMessage()`	Sets the message that should be displayed to the user after the action is performed.	craft\base\ElementAction

Events
Event	Type	Description	Defined By
`EVENT_AFTER_DELETE`	yii\base\Event	The event that is triggered after the component is deleted	craft\base\SavableComponent
`EVENT_AFTER_SAVE`	craft\events\ModelEvent	The event that is triggered after the component is saved	craft\base\SavableComponent
`EVENT_AFTER_VALIDATE`	yii\base\Event	An event raised at the end of validate()	yii\base\Model
`EVENT_BEFORE_DELETE`	craft\events\ModelEvent	The event that is triggered before the component is deleted You may set craft\events\ModelEvent::$isValid to `false` to prevent the component from getting deleted.	craft\base\SavableComponent
`EVENT_BEFORE_SAVE`	craft\events\ModelEvent	The event that is triggered before the component is saved You may set craft\events\ModelEvent::$isValid to `false` to prevent the component from getting saved.	craft\base\SavableComponent
`EVENT_BEFORE_VALIDATE`	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model
`EVENT_DEFINE_BEHAVIORS`	craft\events\DefineBehaviorsEvent	The event that is triggered when defining the class behaviors	craft\base\Component
`EVENT_INIT`	yii\base\Event	The event that is triggered after the component's init cycle	craft\base\Component

Constants
Constant	Value	Description	Defined By
`SCENARIO_DEFAULT`	'default'	The name of the default scenario.	yii\base\Model

Property Details

`$status` public property #

The status elements should be set to

public string, null $status = null

Method Details

`getTriggerHtml()` public method #

Returns the action’s trigger HTML.

public string, null getTriggerHtml ( )

return	string, null	The action’s trigger HTML.

`getTriggerLabel()` public method #

Returns the action’s trigger label.

public string getTriggerLabel ( )

return	string	The action’s trigger label

`performAction()` public method #

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

public boolean performAction ( craft\elements\db\ElementQueryInterface $query )

`$query`	craft\elements\db\ElementQueryInterface	The element query defining which elements the action should affect.
return	boolean	Whether the action was performed successfully.

`rules()` public method #

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
on: optional, specifies the \craft\elements\actions\scenario array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\elements\actions\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\elements\actions\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

public array rules ( )

return	array	Validation rules

Property Details

$status public property #

Method Details

getTriggerHtml() public method #

getTriggerLabel() public method #

performAction() public method #

rules() public method #

`$status` public property #

`getTriggerHtml()` public method #

`getTriggerLabel()` public method #

`performAction()` public method #

`rules()` public method #