PHP Class Joomlatools\Console\Application

Inheritance: extends Symfony\Component\Console\Application
Datei anzeigen Open project: joomlatools/joomla-console Class Usage Examples

Protected Properties

Property Type Description
$_input Reference to the Input\ArgvInput object
$_output Reference to the Output\ConsoleOutput object
$_plugin_path string The path to the plugin directory
$_plugins List of installed plugins

Public Methods

Method Description
__construct ( string $name = 'UNKNOWN', string $version = 'UNKNOWN' )
getPluginPath ( ) : string Get the plugin path
getPlugins ( ) : array Get the list of installed plugin packages.
run ( Symfony\Component\Console\Input\InputInterface $input = null, Symfony\Component\Console\Output\OutputInterface $output = null ) : integer Runs the current application.

Protected Methods

Method Description
_loadPlugins ( ) Loads plugins into the application.
getDefaultCommands ( ) : Command[] Gets the default commands that should always be available.

Method Details

__construct() public method

public __construct ( string $name = 'UNKNOWN', string $version = 'UNKNOWN' )
$name string
$version string

_loadPlugins() protected method

Loads plugins into the application.
protected _loadPlugins ( )

getDefaultCommands() protected method

Gets the default commands that should always be available.
protected getDefaultCommands ( ) : Command[]
return Command[] An array of default Command instances

getPluginPath() public method

Get the plugin path
public getPluginPath ( ) : string
return string Path to the plugins directory

getPlugins() public method

Get the list of installed plugin packages.
public getPlugins ( ) : array
return array Array of package names as key and their version as value

run() public method

Runs the current application.
public run ( Symfony\Component\Console\Input\InputInterface $input = null, Symfony\Component\Console\Output\OutputInterface $output = null ) : integer
$input Symfony\Component\Console\Input\InputInterface An Input instance
$output Symfony\Component\Console\Output\OutputInterface An Output instance
return integer 0 if everything went fine, or an error code

Property Details

$_input protected_oe property

Reference to the Input\ArgvInput object
protected $_input

$_output protected_oe property

Reference to the Output\ConsoleOutput object
protected $_output

$_plugin_path protected_oe property

The path to the plugin directory
protected string $_plugin_path
return string

$_plugins protected_oe property

List of installed plugins
protected $_plugins