Elgg\Cli Class Reference

CLI bootstrap. More...

Public Member Functions
	__construct (protected EventsService $events, protected InputInterface $input, protected OutputInterface $output)
	Constructor. More...
	add (string $command)
	Add a new CLI command. More...
	run (bool $bootstrap=true)
	Bootstrap and run console application. More...
	getInput ()
	Returns console input. More...
	getOutput ()
	Returns console output. More...

Protected Member Functions
	bootstrap ()
	Add CLI tools to the console application. More...
	getCoreCommands ()
	Returns the core cli commands. More...
	getPluginCommands ()
	Returns the cli commands registered in plugins. More...

Protected Attributes
	$console

Detailed Description

CLI bootstrap.

Definition at line 16 of file Cli.php.

Constructor & Destructor Documentation

Elgg\Cli::__construct	(	protected EventsService	$events,
		protected InputInterface	$input,
		protected OutputInterface	$output
	)

Constructor.

Parameters

EventsService	$events	Events service
InputInterface	$input	Console input
OutputInterface	$output	Console output

Definition at line 32 of file Cli.php.

Member Function Documentation

Elgg\Cli::add

(

string

$command

)

Add a new CLI command.

Parameters

string

$command

Command class Must extend

Returns

void

Definition at line 96 of file Cli.php.

Elgg\Cli::bootstrap ( )

protected

Add CLI tools to the console application.

Returns

void

Definition at line 48 of file Cli.php.

Elgg\Cli::getCoreCommands ( )

protected

Returns the core cli commands.

Returns

array

Definition at line 62 of file Cli.php.

Elgg\Cli::getInput

(

)

Returns console input.

Returns

InputInterface

Definition at line 147 of file Cli.php.

Elgg\Cli::getOutput

(

)

Returns console output.

Returns

OutputInterface

Definition at line 156 of file Cli.php.

Elgg\Cli::getPluginCommands ( )

protected

Returns the cli commands registered in plugins.

Returns

array

Definition at line 72 of file Cli.php.

Elgg\Cli::run

(

bool

$bootstrap = true

)

Bootstrap and run console application.

Parameters

bool

$bootstrap

Is bootstrap needed?

Returns

void

Definition at line 134 of file Cli.php.

Member Data Documentation

Elgg\Cli::$console

protected

Definition at line 23 of file Cli.php.

---

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

• engine/classes/Elgg/Cli.php