Elgg  Version 3.0
Public Member Functions | Protected Member Functions | List of all members
Elgg\Cli\Command Class Reference

Abstract command with some utility methods. More...

Inheritance diagram for Elgg\Cli\Command:
Elgg\Cli\BaseCommand Elgg\Cli\CronCommand Elgg\Cli\DatabaseSeedCommand Elgg\Cli\DatabaseUnseedCommand Elgg\Cli\FlushCommand Elgg\Cli\PluginsActivateCommand Elgg\Cli\PluginsDeactivateCommand Elgg\Cli\PluginsListCommand Elgg\Cli\SimpletestCommand

Public Member Functions

 execute (InputInterface $input, OutputInterface $output)
 {} More...
 
- Public Member Functions inherited from Elgg\Cli\BaseCommand
 ask ($question, $default=null, $hidden=false, $required=true)
 Ask a question. More...
 
 dump ($data)
 Dump a variable. More...
 
 write ($messages, $level=LogLevel::INFO)
 Write messages to output buffer. More...
 
 error ($message)
 Print an error. More...
 
 notice ($message)
 Print a notce. More...
 
 option ($name)
 Returns option value. More...
 
 argument ($name)
 Returns argument value. More...
 
 assertNotEmpty ($answer)
 Question validator for required user response. More...
 

Protected Member Functions

 command ()
 Command to be executed. More...
 
 login ()
 Login a user defined by –as option. More...
 
 logout ()
 Logout a user. More...
 
- Protected Member Functions inherited from Elgg\Cli\BaseCommand
 dumpRegisters ()
 Dump and output system and error messages. More...
 

Additional Inherited Members

- Public Attributes inherited from Elgg\Cli\BaseCommand
const DEFAULT_VERBOSITY = OutputInterface::VERBOSITY_NORMAL
 
- Protected Attributes inherited from Elgg\Cli\BaseCommand
 $input
 
 $output
 

Detailed Description

Abstract command with some utility methods.

Definition at line 12 of file Command.php.

Member Function Documentation

Elgg\Cli\Command::command ( )
abstractprotected

Command to be executed.

This method method should return an integer code of the error (or 0 for success). Optionally, the method can return a callable that will receive the instance of this command as an argument

Returns
mixed
See also
Command::execute()
Elgg\Cli\Command::execute ( InputInterface  $input,
OutputInterface  $output 
)
final

{}

Definition at line 17 of file Command.php.

Elgg\Cli\Command::login ( )
finalprotected

Login a user defined by –as option.

Returns
void
Exceptions
RuntimeException

Definition at line 63 of file Command.php.

Elgg\Cli\Command::logout ( )
finalprotected

Logout a user.

Returns
void

Definition at line 85 of file Command.php.


The documentation for this class was generated from the following file: