AddUserToGroupCommand
Extends AbstractCommandConsole command to add a user to group
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Command constructor.
__construct(\Joomla\Database\DatabaseInterface db) :
| since |
4.2.0 |
|---|
Arguments
- db
DatabaseInterfaceThe database
Response
mixed
configure
Configure the command.
configure() :
| since |
4.0.0 |
|---|
Response
void
configureIO
Configure the IO.
configureIO(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInterfaceThe input to inject into the command.- output
OutputInterfaceThe output to inject into the command.
Response
void
doExecute
Internal function to execute the command.
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInterfaceThe input to inject into the command.- output
OutputInterfaceThe output to inject into the command.
Response
intThe command exit code
getGroupId
Method to get groupId by groupName
getGroupId( groupName) :
| since |
4.0.0 |
|---|
Arguments
- groupName
stringname of group
Response
int
getGroups
Method to get a value from option
getGroups(\Joomla\CMS\User\User user) : mixed||string|int
getStringFromOption
Method to get a value from option
getStringFromOption( option, question) :
| since |
4.0.0 |
|---|
Arguments
- option
stringset the option name- question
stringset the question if user enters no value to option
Response
string
getUserId
Method to get a user object
getUserId( username) :
| since |
4.0.0 |
|---|
Arguments
- username
stringusername
Response
object
Properties
defaultName
The default command name
| since |
4.0.0 |
|---|
Type(s)
string
ioStyle
SymfonyStyle Object
| since |
4.0.0 |
|---|
Type(s)
object
cliInput
Stores the Input Object
| since |
4.0.0 |
|---|
Type(s)
object
username
The username
| since |
4.0.0 |
|---|
Type(s)
string
userGroups
The usergroups
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>