$name
$name :
Base command class.
$hidden :
run(\app\framework\Component\Console\Input\InputInterface $input, \app\framework\Component\Console\Output\ConsoleOutput $output) : integer
Runs the command.
The code to execute is either defined directly with the setCode() method or by overriding the execute() method in a sub-class.
| \app\framework\Component\Console\Input\InputInterface | $input | |
| \app\framework\Component\Console\Output\ConsoleOutput | $output |
setHidden(boolean $hidden) : \app\framework\Component\Console\Command\Command
| boolean | $hidden | Whether or not the command should be hidden from the list of commands |
The current instance
getNativeDefinition() : \app\framework\Component\Console\Input\InputDefinition
Gets the InputDefinition to be used to create representations of this Command.
Can be overridden to provide the original command representation when it would otherwise be changed by merging with the application InputDefinition.
This method is not part of public API and should not be used directly.
An InputDefinition instance
setDefinition(array|\app\framework\Component\Console\Input\InputDefinition $definition) : $this
Sets an array of argument and option instances.
| array|\app\framework\Component\Console\Input\InputDefinition | $definition | An array of argument and option instances or a definition instance |
getDefinition() : \app\framework\Component\Console\Input\InputDefinition
Gets the InputDefinition attached to this Command.
An InputDefinition instance
random_str(integer $length, string $keyspace = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ') : string
Generate a random string, using a cryptographically secure pseudorandom number generator (random_int)
For PHP 7, random_int is a PHP core function For PHP 5.x, depends on https://github.com/paragonie/random_compat
| integer | $length | How many characters do we want? |
| string | $keyspace | A string of all possible characters to select from |
interact(\app\framework\Component\Console\Input\InputInterface $input)
Interacts with the user.
This method is executed before the InputDefinition is validated. This means that this is the only place where the command can interactively ask for values of missing required arguments.
| \app\framework\Component\Console\Input\InputInterface | $input |
execute(\app\framework\Component\Console\Input\InputInterface $input, \app\framework\Component\Console\Output\ConsoleOutput $output)
| \app\framework\Component\Console\Input\InputInterface | $input | |
| \app\framework\Component\Console\Output\ConsoleOutput | $output |