AddUserToGroupCommand

Extends \Joomla\Console\Command\AbstractCommand

Console command to add a user to group

since

4.0.0

package

Application

Methods

configure

Configure the command.

configure() : void
since

4.0.0

configureIO

Configure the IO.

configureIO(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : void
since

4.0.0

Arguments

input

\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.

output

\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.

doExecute

Internal function to execute the command.

doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : int
since

4.0.0

Arguments

input

\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.

output

\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.

Response

intThe command exit code

getGroupId

Method to get groupId by groupName

getGroupId(string groupName) : int
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) : array
since

4.0.0

Arguments

user

\Joomla\CMS\User\Usera UserInstance

Response

array

getStringFromOption

Method to get a value from option

getStringFromOption(string option, string question) : string
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(string username) : object
since

4.0.0

Arguments

username

stringusername

Response

object

Properties

defaultName

The default command name

static
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