PHP Interface Yosymfony\Spress\Plugin\CommandPluginInterface

Author: Victor Puertas ([email protected])

Inheritance: extends Yosymfony\Spress\Core\Plugin\PluginInterface

Mostra file Open project: spress/spress Interface Usage Examples

Public Methods

Method	Description
executeCommand ( Yosymfony\Spress\Core\IO\IOInterface $io, array $arguments, array $options ) : null \| integer	Executes the current command.
getCommandDefinition ( ) : Yosymfony\Spress\Plugin\CommandDefinition	Gets the command's definition.
getCommandEnvironment ( ) : Yosymfony\Spress\Plugin\Environment\CommandEnvironmentInterface	Gets the command environment.
setCommandEnvironment ( Yosymfony\Spress\Plugin\Environment\CommandEnvironmentInterface $environment )	Sets the command environment.

Method Details

executeCommand() public method

Executes the current command.

public executeCommand ( Yosymfony\Spress\Core\IO\IOInterface $io, array $arguments, array $options ) : null \| integer
$io	Yosymfony\Spress\Core\IO\IOInterface	Input/output interface
$arguments	array	Arguments passed to the command
$options	array	Options passed to the command
return	null \| integer	null or 0 if everything went fine, or an error code

getCommandDefinition() public method

Gets the command's definition.

public getCommandDefinition ( ) : Yosymfony\Spress\Plugin\CommandDefinition
return	Yosymfony\Spress\Plugin\CommandDefinition	Definition of the command

getCommandEnvironment() public method

Gets the command environment.

public getCommandEnvironment ( ) : Yosymfony\Spress\Plugin\Environment\CommandEnvironmentInterface
return	Yosymfony\Spress\Plugin\Environment\CommandEnvironmentInterface

setCommandEnvironment() public method

Sets the command environment.

public setCommandEnvironment ( Yosymfony\Spress\Plugin\Environment\CommandEnvironmentInterface $environment )
$environment	Yosymfony\Spress\Plugin\Environment\CommandEnvironmentInterface	The environment