UserCommands
final class UserCommands extends DrushCommands (View source)
Traits
A copy of \Drupal\Core\DependencyInjection\AutowireTrait with first params' type hint changed.
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
| INFORMATION |
|
| BLOCK |
|
| UNBLOCK |
|
| ROLE_ADD |
|
| ROLE_REMOVE |
|
| CREATE |
|
| CANCEL |
|
| PASSWORD |
|
| INF_LABELS |
|
| INF_DEFAULT_FIELDS |
|
Properties
| protected | $uri | from ExecTrait | |
| protected ConfigInterface | $config | from ConfigAwareTrait | |
| protected InputInterface | $input | from InputAwareTrait | |
| protected OutputInterface | $output | from OutputAwareTrait | |
| protected | $io | from IO | |
| protected | $obj | from IO | |
| protected CommandData|null | $commandData | from DrushCommands |
Methods
Starts a background browser/tab for the current site or a specified URL.
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
No description
No description
No description
Prompt the user until the given validation callback passes.
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
This method overrides the trait in order to provide a more specific return type.
Instantiates a new instance of the implementing class using autowiring.
Print information about the specified user(s).
Block the specified user(s).
Unblock the specified user(s).
Add a role to the specified user accounts.
Remove a role from the specified user accounts.
Create a user account.
Block or delete user account(s) with the specified name(s).
Set the password for the user account with the specified name.
A flatter and simpler array presentation of a Drupal $user object.
Get accounts from name variables or uid & mail options.
No description
Details
bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)
Starts a background browser/tab for the current site or a specified URL.
Uses a non-blocking Process call, so Drush execution will continue.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
$this
setConfig(ConfigInterface $config)
Set the config management object.
ConfigInterface
getConfig()
Get the config management object.
static protected string
configPrefix()
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
static protected
configClassIdentifier($classname)
No description
static protected
configPostfix()
No description
static
configure(string $key, mixed $value, ConfigInterface|null $config = null)
No description
protected mixed|null
getConfigValue(string $key, mixed|null $default = null)
No description
$this
setInput(InputInterface $input)
No description
protected InputInterface
input()
No description
protected InputInterface
getInput()
deprecated
deprecated
Backwards compatibility.
$this
setOutput(OutputInterface $output)
No description
protected OutputInterface
output()
No description
protected OutputInterface
stderr()
No description
protected OutputInterface
getOutput()
deprecated
deprecated
Backwards compatibility
in
IO at line 24
currentState()
No description
__construct(DateFormatterInterface $dateFormatter)
No description
in
IO at line 40
restore()
No description
protected void
configurePrompts(InputInterface $input)
Configure the prompt fallbacks.
protected mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Prompt the user until the given validation callback passes.
protected void
restorePrompts()
Restore the prompts output.
protected bool
runningUnitTests()
No description
protected DrushStyle
io()
Override Robo's IO function with our custom style.
DrushLoggerManager|null
logger()
Returns a logger object.
protected void
printFile(string $file)
Print the contents of a file.
preHook(CommandData $commandData)
Persist commandData for use in primary command callback. Used by 'topic' commands.
initHook($input, AnnotationData $annotationData)
Configure Laravel prompts package.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
ProcessManager
processManager()
This method overrides the trait in order to provide a more specific return type.
static AutowireTrait
create(ContainerInterface $container)
Instantiates a new instance of the implementing class using autowiring.
RowsOfFields
information(string $names = '', $options = ['format' => 'table', 'uid' => self::REQ, 'mail' => self::REQ])
Print information about the specified user(s).
renderRolesCell($key, $cellData, FormatterOptions $options)
No description
void
block(string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ])
Block the specified user(s).
void
unblock(string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ])
Unblock the specified user(s).
void
addRole(string $role, string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ])
Add a role to the specified user accounts.
void
removeRole(string $role, string $names = '', $options = ['uid' => self::REQ, 'mail' => self::REQ])
Remove a role from the specified user accounts.
CommandError
createUser(string $name, $options = ['format' => 'table', 'password' => self::REQ, 'mail' => self::REQ])
Create a user account.
void
createValidate(CommandData $commandData)
Assure that provided username is available.
void
cancel(string $names = '', $options = ['delete-content' => false, 'reassign-content' => false, 'uid' => self::REQ, 'mail' => self::REQ])
Block or delete user account(s) with the specified name(s).
- Existing content may be deleted or reassigned to the Anonymous user. See options.
- By default only nodes are deleted or reassigned. Custom entity types need own code to support cancellation. See https://www.drupal.org/project/drupal/issues/3043725 for updates.
void
password(string $name, string $password)
Set the password for the user account with the specified name.
array
infoArray($account)
A flatter and simpler array presentation of a Drupal $user object.
protected array
getAccounts(string $names = '', array $options = [])
Get accounts from name variables or uid & mail options.
void
roleComplete(CompletionInput $input, CompletionSuggestions $suggestions)
No description