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

CLI bootstrap. More...

Public Member Functions

 __construct (CliApplication $console, PluginHooksService $hooks, InputInterface $input, OutputInterface $output)
 Constructor. More...
 
 add ($command)
 Add a new CLI command. More...
 
 run ()
 Bootstrap and run console application. More...
 
 getInput ()
 Returns console input. More...
 
 getOutput ()
 Returns console output. More...
 

Public Attributes

trait Progressing
 Progress reporting. More...
 

Protected Member Functions

 bootstrap ()
 Add CLI tools to the console application. More...
 

Protected Attributes

 $console
 
 $hooks
 
 $input
 
 $output
 

Detailed Description

CLI bootstrap.

Definition at line 15 of file Cli.php.

Constructor & Destructor Documentation

Elgg\Cli::__construct ( CliApplication  $console,
PluginHooksService  $hooks,
InputInterface  $input,
OutputInterface  $output 
)

Constructor.

Parameters
CliApplication$consoleConsole application instance
PluginHooksService$hooksHooks registration service
InputInterface$inputConsole input
OutputInterface$outputConsole output

Definition at line 47 of file Cli.php.

Member Function Documentation

Elgg\Cli::add (   $command)

Add a new CLI command.

Parameters
string$commandCommand class Must extend
Returns
void

Definition at line 79 of file Cli.php.

Elgg\Cli::bootstrap ( )
protected

Add CLI tools to the console application.

Returns
void

Definition at line 63 of file Cli.php.

Elgg\Cli::getInput ( )

Returns console input.

Returns
InputInterface

Definition at line 117 of file Cli.php.

Elgg\Cli::getOutput ( )

Returns console output.

Returns
OutputInterface

Definition at line 125 of file Cli.php.

Elgg\Cli::run ( )

Bootstrap and run console application.

Returns
void
Exceptions
Exception

Definition at line 108 of file Cli.php.

Member Data Documentation

Elgg\Cli::$console
protected

Definition at line 22 of file Cli.php.

Elgg\Cli::$hooks
protected

Definition at line 27 of file Cli.php.

Elgg\Cli::$input
protected

Definition at line 32 of file Cli.php.

Elgg\Cli::$output
protected

Definition at line 37 of file Cli.php.

trait Elgg\Cli::Progressing
Initial value:
{
protected $progress

Progress reporting.

Definition at line 10 of file Progressing.php.


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