Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AddUserToGroupCommand
+ Graphe d'héritage de AddUserToGroupCommand:

Fonctions membres publiques

 __construct (DatabaseInterface $db)
 
- Fonctions membres publiques hérités de AbstractCommand
 __construct (?string $name=null)
 
 addArgument (string $name, ?int $mode=null, string $description='', $default=null)
 
 addOption (string $name, $shortcut=null, ?int $mode=null, $description='', $default=null)
 
 execute (InputInterface $input, OutputInterface $output)
 
 getAliases ()
 
 getApplication ()
 
 getDefinition ()
 
 getDescription ()
 
 getHelp ()
 
 getHelperSet ()
 
 getName ()
 
 getProcessedHelp ()
 
 getSynopsis (bool $short=false)
 
 isEnabled ()
 
 isHidden ()
 
 mergeApplicationDefinition (bool $mergeArgs=true)
 
 setAliases (array $aliases)
 
 setApplication (?Application $application=null)
 
 setDefinition ($definition)
 
 setDescription (string $description)
 
 setHelp (string $help)
 
 setHelperSet (HelperSet $helperSet)
 
 setHidden (bool $hidden)
 
 setName (string $name)
 

Fonctions membres protégées

 doExecute (InputInterface $input, OutputInterface $output)
 
 getGroups ($user)
 
 getGroupId ($groupName)
 
 getUserId ($username)
 
 getStringFromOption ($option, $question)
 
 configure ()
 
- Fonctions membres protégées hérités de AbstractCommand
 configure ()
 
 doExecute (InputInterface $input, OutputInterface $output)
 
 initialise (InputInterface $input, OutputInterface $output)
 

Attributs protégés statiques

static $defaultName = 'user:addtogroup'
 
- Attributs protégés statiques hérités de AbstractCommand
static $defaultName
 

Fonctions membres privées

 configureIO (InputInterface $input, OutputInterface $output)
 

Attributs privés

 $ioStyle
 
 $cliInput
 
 $username
 
 $userGroups = []
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de AbstractCommand
static getDefaultName ()
 

Description détaillée

Console command to add a user to group

Depuis
4.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( DatabaseInterface  $db)

Command constructor.

Paramètres
DatabaseInterface$dbThe database
Depuis
4.2.0

Références Symfony\Contracts\Service\__construct(), et Joomla\Database\setDatabase().

Documentation des fonctions membres

◆ configure()

configure ( )
protected

Configure the command.

Renvoie
void
Depuis
4.0.0

Références null, et InputOption\VALUE_OPTIONAL.

◆ configureIO()

configureIO ( InputInterface  $input,
OutputInterface  $output 
)
private

Configure the IO.

Paramètres
InputInterface$inputThe input to inject into the command.
OutputInterface$outputThe output to inject into the command.
Renvoie
void
Depuis
4.0.0

Références $input, et $output.

◆ doExecute()

doExecute ( InputInterface  $input,
OutputInterface  $output 
)
protected

Internal function to execute the command.

Paramètres
InputInterface$inputThe input to inject into the command.
OutputInterface$outputThe output to inject into the command.
Renvoie
integer The command exit code
Depuis
4.0.0

Références $db, $input, $output, $query, $result, $user, $userId, UserHelper\addUserToGroup(), Command\FAILURE, Joomla\Database\getDatabase(), User\getInstance(), et Command\SUCCESS.

◆ getGroupId()

getGroupId (   $groupName)
protected

Method to get groupId by groupName

Paramètres
string$groupNamename of group
Renvoie
integer
Depuis
4.0.0

Références $db, $query, et Joomla\Database\getDatabase().

◆ getGroups()

getGroups (   $user)
protected

Method to get a value from option

Paramètres
User$usera UserInstance
Renvoie
array
Depuis
4.0.0

Références $db, $groups, $list, $query, $user, Joomla\Database\getDatabase(), et Access\getGroupsByUser().

◆ getStringFromOption()

getStringFromOption (   $option,
  $question 
)
protected

Method to get a value from option

Paramètres
string$optionset the option name
string$questionset the question if user enters no value to option
Renvoie
string
Depuis
4.0.0

Références $option.

◆ getUserId()

getUserId (   $username)
protected

Method to get a user object

Paramètres
string$usernameusername
Renvoie
object
Depuis
4.0.0

Références $db, $query, et Joomla\Database\getDatabase().

Documentation des champs

◆ $cliInput

$cliInput
private

◆ $defaultName

$defaultName = 'user:addtogroup'
staticprotected

◆ $ioStyle

$ioStyle
private

◆ $userGroups

$userGroups = []
private

◆ $username

$username
private

La documentation de cette classe a été générée à partir du fichier suivant :