UsersController
- Type
- Class
- Namespace
- craft\console\controllers
- Inherits
- craft\console\controllers\UsersController » craft\console\Controller » yii\console\Controller (opens new window) » yii\base\Controller (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window), yii\base\ViewContextInterface (opens new window)
- Uses traits
- craft\console\ControllerTrait
- Since
- 3.6.0
Manages user accounts.
View source (opens new window)
# Public Properties
# activate
- Type
- boolean (opens new window), null (opens new window)
- Default value
null- Since
- 4.1.0
Whether teh user account should be activated.
View source (opens new window)
# admin
- Type
- boolean (opens new window), null (opens new window)
- Default value
null- Since
- 3.7.0
Whether the user should be an admin.
View source (opens new window)
# deleteContent
- Type
- boolean (opens new window)
- Default value
false- Since
- 3.7.0
Whether to delete the user’s content if no inheritor is specified.
View source (opens new window)
# email
- Type
- string (opens new window), null (opens new window)
- Default value
null- Since
- 3.7.0
The user’s email address.
View source (opens new window)
# groupIds
- Type
- integer (opens new window)[]
- Default value
[]- Since
- 3.7.0
The group IDs to assign the user to the created user to.
View source (opens new window)
# groups
- Type
- string (opens new window)[]
- Default value
[]- Since
- 3.7.0
The group handles to assign the created user to.
View source (opens new window)
# hard
- Type
- boolean (opens new window)
- Default value
false- Since
- 3.7.0
Whether the user should be hard-deleted immediately, instead of soft-deleted.
View source (opens new window)
# inheritor
- Type
- string (opens new window), null (opens new window)
- Default value
null- Since
- 3.7.0
The email or username of the user to inherit content when deleting a user.
View source (opens new window)
# password
- Type
- string (opens new window), null (opens new window)
- Default value
null
The user’s new password.
View source (opens new window)
# username
- Type
- string (opens new window), null (opens new window)
- Default value
null- Since
- 3.7.0
The user’s username.
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | |
| __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() (opens new window) | Sets a component property to be null. |
| actionActivationUrl() | Generates an activation URL for a pending user. |
| actionCreate() | Creates a user. |
| actionDelete() | Deletes a user. |
| actionImpersonate() | Generates a URL to impersonate a user. |
| actionListAdmins() | Lists admin users. |
| actionLogoutAll() | Logs all users out of the system. |
| actionPasswordResetUrl() | Generates a password reset URL for a user. |
| actionSetPassword() | Changes a user’s password. |
| actionUnlock() | Unlocks a user's account. |
| actions() | Declares external actions for the controller. |
| afterAction() (opens new window) | This method is invoked right after an action is executed. |
| ansiFormat() (opens new window) | Formats a string with ANSI codes. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| beforeAction() | This method is invoked right before an action is executed. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| bindActionParams() (opens new window) | Binds the parameters to the action. |
| 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. |
| confirm() (opens new window) | Asks user to confirm by typing y or n. |
| createAction() (opens new window) | Creates an action based on the given action ID. |
| createDirectory() | Creates a directory, and outputs to the console. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| do() | Performs an action with descriptive output. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| failure() | Outputs a failure message to the console. |
| findLayoutFile() (opens new window) | Finds the applicable layout file. |
| getActionArgsHelp() | Returns the help information for the anonymous arguments for the action. |
| getActionHelp() | Returns the detailed help information for the specified action. |
| getActionHelpSummary() | Returns a one-line short summary describing the specified action. |
| getActionOptionsHelp() | Returns the help information for the options for the action. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getHelp() (opens new window) | Returns help information for this controller. |
| getHelpSummary() (opens new window) | Returns one-line short summary describing this controller. |
| getModules() (opens new window) | Returns all ancestor modules of this controller. |
| getOptionValues() (opens new window) | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. |
| getPassedOptionValues() (opens new window) | Returns the properties corresponding to the passed options. |
| getPassedOptions() (opens new window) | Returns the names of valid options passed during execution. |
| getRoute() (opens new window) | Returns the route of the current request. |
| getUniqueId() (opens new window) | Returns the unique ID of the controller. |
| getView() (opens new window) | Returns the view object that can be used to render views or view files. |
| getViewPath() (opens new window) | Returns the directory containing view files for this controller. |
| 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. |
| isColorEnabled() (opens new window) | Returns a value indicating whether ANSI color is enabled. |
| markdownToAnsi() | Converts Markdown to be better readable in console environments by applying some ANSI format. |
| note() | Outputs a note to the console. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| optionAliases() (opens new window) | Returns option alias names. |
| options() | Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. |
| passwordPrompt() | Prompts the user for a password and validates it. |
| prompt() (opens new window) | Prompts the user for input and validates it. |
| render() (opens new window) | Renders a view and applies layout if available. |
| renderContent() (opens new window) | Renders a static string by applying a layout. |
| renderFile() (opens new window) | Renders a view file. |
| renderPartial() (opens new window) | Renders a view without applying layout. |
| run() | Runs a request specified in terms of a route. |
| runAction() | Runs an action within this controller with the specified action ID and parameters. |
| select() (opens new window) | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. |
| setView() (opens new window) | Sets the view object to be used by this controller. |
| setViewPath() (opens new window) | Sets the directory that contains the view files. |
| stderr() (opens new window) | Prints a string to STDERR. |
| stdout() (opens new window) | Prints a string to STDOUT. |
| success() | Outputs a success message to the console. |
| table() | Outputs a table via craft\helpers\Console::table(). |
| tip() | Outputs a tip to the console. |
| trigger() (opens new window) | Triggers an event. |
| warning() | Outputs a warning to the console. |
| writeJson() | JSON-encodes a value and writes it to a file. |
| writeToFile() | Writes contents to a file, and outputs to the console. |
# actionActivationUrl()
Generates an activation URL for a pending user.
View source (opens new window)
Arguments
$user(string (opens new window)) – The ID, username, or email address of the user account.
Returns
# actionCreate()
- Since
- 3.7.0
Creates a user.
View source (opens new window)
Returns
# actionDelete()
Deletes a user.
View source (opens new window)
Arguments
$user(string (opens new window)) – The ID, username, or email address of the user account.
Returns
# actionImpersonate()
- Since
- 3.7.15
Generates a URL to impersonate a user.
View source (opens new window)
Arguments
$user(string (opens new window)) – The ID, username, or email address of the user account.
Returns
# actionListAdmins()
Lists admin users.
View source (opens new window)
Returns
# actionLogoutAll()
- Since
- 3.7.33
Logs all users out of the system.
View source (opens new window)
Returns
# actionPasswordResetUrl()
Generates a password reset URL for a user.
View source (opens new window)
Arguments
$user(string (opens new window)) – The ID, username, or email address of the user account.
Returns
# actionSetPassword()
Changes a user’s password.
View source (opens new window)
Arguments
$user(string (opens new window)) – The ID, username, or email address of the user account.
Returns
# actionUnlock()
- Since
- 4.4.0
Unlocks a user's account.
View source (opens new window)
Arguments
$user(string (opens new window)) – The ID, username, or email address of the user account.
Returns
# options()
Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.
Child classes may override this method to specify possible options.
Note that the values setting via options are not available until beforeAction() is being called.
View source (opens new window)
Arguments
$actionID(string (opens new window)) – The action id of the current request
Returns
string (opens new window)[] – The names of the options valid for the action
# Protected Methods
| Method | Description |
|---|---|
| bindInjectedParams() (opens new window) | Fills parameters based on types and names in action method signature. |
| checkRootUser() | Returns whether a command should be executed depending on whether it's being run as a root user, and whether they're OK with that. |
| checkTty() | Sets yii\console\Controller::$interactive (opens new window) to false if this isn’t a TTY shell. |
| createAttributeValidator() | Creates a function for the validator option of Controller::prompt. |
| defineActions() | Returns an array of custom actions that should be available on the controller. |
| getActionMethodReflection() | |
| outputCommand() | |
| parseDocCommentDetail() (opens new window) | Returns full description from the docblock. |
| parseDocCommentSummary() (opens new window) | Returns the first line of docblock. |
| parseDocCommentTags() (opens new window) | Parses the comment block into tags. |
# Constants
| Constant | Description |
|---|---|
EXIT_CODE_ERROR | |
EXIT_CODE_NORMAL |