DeleteUsers ​
- Type
- Class
- Namespace
- craft\elements\actions
- Inherits
- craft\elements\actions\DeleteUsers » craft\base\ElementAction » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\ElementActionInterface, craft\base\ModelInterface, craft\elements\actions\DeleteActionInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses traits
- craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Since
- 3.0.0
DeleteUsers represents a Delete Users element action.
Public Properties ​
| Property | Description |
|---|---|
| activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
| attributes | array – Attribute values (name => value). |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| confirmationMessage | string, null – The confirmation message, if any. |
| errors | array – Errors for all attributes or the specified attribute. |
| firstErrors | array – The first errors. |
| hard | boolean – Whether to permanently delete the elements. |
| iterator | ArrayIterator – An iterator for traversing the items in the list. |
| message | string, null – The message that should be displayed to the user. |
| scenario | string – The scenario that this model is in. |
| settings | array – The component’s settings. |
| settingsHtml | string, null |
| transferContentTo | integer, integer[], null – The user ID that the deleted user’s content should be transferred to |
| triggerHtml | string, null – The action’s trigger HTML. |
| triggerLabel | string – The action’s trigger label |
| validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
confirmationMessage ​
The confirmation message, if any.
hard ​
- Type
- boolean
- Default value
false- Since
- 3.6.5
Whether to permanently delete the elements.
transferContentTo ​
The user ID that the deleted user’s content should be transferred to
triggerHtml ​
The action’s trigger HTML.
triggerLabel ​
- Type
- string
- Default value
null- Access
- Read-only
The action’s trigger label
Protected Properties ​
| Property | Description |
|---|---|
| elementType | class-string<\craft\base\ElementInterface> |
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be 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. |
| 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. |
| 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. |
| canHardDelete() | Returns whether the action is capable of hard-deleting elements. |
| 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. |
| 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. |
| 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 for this component. |
| 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. |
| isDownload() | Returns whether this is a download action. |
| 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. |
| setElementType() | Sets the element type on the action. |
| setHardDelete() | Instructs the action that the elements should be hard-deleted. |
| 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() | Performs the data validation. |
| validateMultiple() | Validates multiple models. |
canHardDelete() ​
Returns whether the action is capable of hard-deleting elements.
Returns ​
getConfirmationMessage() ​
Returns a confirmation message that should be displayed before the action is performed.
Returns ​
string, null – The confirmation message, if any.
getTriggerHtml() ​
Returns the action’s trigger HTML.
Returns ​
string, null – The action’s trigger HTML.
getTriggerLabel() ​
Returns the action’s trigger label.
Returns ​
string – The action’s trigger label
isDestructive() ​
Returns whether this action is destructive in nature.
Returns ​
boolean – Whether this action is destructive in nature.
performAction() ​
Performs the action on any elements that match the given criteria.
Arguments ​
$query(craft\elements\db\ElementQueryInterface) – The element query defining which elements the action should affect.
Returns ​
boolean – Whether the action was performed successfully.
setHardDelete() ​
Instructs the action that the elements should be hard-deleted.
Protected Methods ​
| Method | Description |
|---|---|
| defineBehaviors() | Returns the behaviors to attach to this class. |
| defineRules() | Returns the validation rules for attributes. |
| 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 ​
| Constant | Description |
|---|---|
SCENARIO_DEFAULT | The name of the default scenario. |