Runner
in package
uses
ConfigAwareTrait
Toolkit Runner.
Tags
Table of Contents
Constants
- APPLICATION_NAME = 'Toolkit Runner'
Properties
- $application : Application
- The Robo Application.
- $classLoader : ClassLoader
- The autoloader class.
- $commandClasses : array<string|int, mixed>
- The loaded command classes.
- $container : Container|DefinitionContainerInterface|null
- The container.
- $input : InputInterface
- The input.
- $output : OutputInterface
- The output.
- $runner : Runner
- The Robo Runner.
- $workingDir : mixed
- The current working directory.
Methods
- __construct() : mixed
- Initialize the Toolkit Runner.
- run() : int
- Execute the Runner.
- discoverCommandClasses() : array<string|int, mixed>|array<string|int, string>
- Discover Command classes.
- getConfigDirFilesPaths() : array<string|int, mixed>
- Get runner config directory files.
- getWorkingDir() : mixed
- Returns the current working directory.
- parseConfigFiles() : array<string|int, mixed>
- Recursively merge config files.
- prepareApplication() : mixed
- Create and prepare the Application.
- prepareConfigurations() : mixed
- Create the configurations and process overrides.
- prepareContainer() : mixed
- Prepare the container with the configurations.
- prepareRunner() : mixed
- Create and configure the Robo runner.
- registerConfigurationCommands() : mixed
- Register commands in the runner.yml under 'commands:'.
Constants
APPLICATION_NAME
public
mixed
APPLICATION_NAME
= 'Toolkit Runner'
Properties
$application
The Robo Application.
private
Application
$application
$classLoader
The autoloader class.
private
ClassLoader
$classLoader
$commandClasses
The loaded command classes.
private
array<string|int, mixed>
$commandClasses
$container
The container.
private
Container|DefinitionContainerInterface|null
$container
$input
The input.
private
InputInterface
$input
$output
The output.
private
OutputInterface
$output
$runner
The Robo Runner.
private
Runner
$runner
$workingDir
The current working directory.
private
mixed
$workingDir
Methods
__construct()
Initialize the Toolkit Runner.
public
__construct(ClassLoader $classLoader, InputInterface $input, OutputInterface $output) : mixed
Parameters
- $classLoader : ClassLoader
-
The autoload file.
- $input : InputInterface
-
The input from CLI arguments.
- $output : OutputInterface
-
The CLI output.
run()
Execute the Runner.
public
run() : int
Return values
int —The status code.
discoverCommandClasses()
Discover Command classes.
private
discoverCommandClasses() : array<string|int, mixed>|array<string|int, string>
Return values
array<string|int, mixed>|array<string|int, string> —An array with the Command classes.
getConfigDirFilesPaths()
Get runner config directory files.
private
getConfigDirFilesPaths(string $runnerConfigDir) : array<string|int, mixed>
Parameters
- $runnerConfigDir : string
-
The directory to scan.
Return values
array<string|int, mixed>getWorkingDir()
Returns the current working directory.
private
getWorkingDir() : mixed
parseConfigFiles()
Recursively merge config files.
private
parseConfigFiles(array<string|int, mixed> $files[, array<string|int, mixed>|null $config = null ]) : array<string|int, mixed>
Parameters
- $files : array<string|int, mixed>
-
The file paths to fetch the configs.
- $config : array<string|int, mixed>|null = null
-
The given, the new configs will be merged.
Return values
array<string|int, mixed>prepareApplication()
Create and prepare the Application.
private
prepareApplication() : mixed
prepareConfigurations()
Create the configurations and process overrides.
private
prepareConfigurations() : mixed
prepareContainer()
Prepare the container with the configurations.
private
prepareContainer() : mixed
prepareRunner()
Create and configure the Robo runner.
private
prepareRunner() : mixed
registerConfigurationCommands()
Register commands in the runner.yml under 'commands:'.
private
registerConfigurationCommands() : mixed