BaseCommand
in package
BaseCommand is the base class used in creating CLI commands.
Table of Contents
Properties
- $arguments : array<string, string>
- $commands : Commands
- $description : string
- $group : string
- $logger : LoggerInterface
- $name : string
- $options : array<string, string>
- $usage : string
- $arguments : array<string, string>
- the Command's Arguments description
- $commands : Commands
- Instance of Commands so commands can call other commands.
- $description : string
- the Command's short description
- $group : string
- The group the command is lumped under when listing commands.
- $logger : LoggerInterface
- The Logger to use for a command
- $name : string
- The Command's name
- $options : array<string, string>
- the Command's options description
- $usage : string
- the Command's usage description
Methods
- __construct() : mixed
- __get() : array<string, string>|Commands|LoggerInterface|string|null
- Makes it simple to access our protected properties.
- __isset() : bool
- Makes it simple to check our protected properties.
- getPad() : int
- Get pad for $key => $value array output
- run() : int|void
- Actually execute a command.
- setPad() : string
- Pads our string out so that all titles are the same length to nicely line up descriptions.
- showHelp() : void
- Show Help includes (Usage, Arguments, Description, Options).
- call() : int|void
- Can be used by a command to run other commands.
- showError() : void
- A simple method to display an error with line/file, in child commands.
Properties
$arguments
public
array<string, string>
$arguments
$commands
public
Commands
$commands
$description
public
string
$description
$group
public
string
$group
$logger
public
LoggerInterface
$logger
$name
public
string
$name
$options
public
array<string, string>
$options
$usage
public
string
$usage
$arguments
the Command's Arguments description
protected
array<string, string>
$arguments
= []
$commands
Instance of Commands so commands can call other commands.
protected
Commands
$commands
$description
the Command's short description
protected
string
$description
$group
The group the command is lumped under when listing commands.
protected
string
$group
$logger
The Logger to use for a command
protected
LoggerInterface
$logger
$name
The Command's name
protected
string
$name
$options
the Command's options description
protected
array<string, string>
$options
= []
$usage
the Command's usage description
protected
string
$usage
Methods
__construct()
public
__construct(LoggerInterface $logger, Commands $commands) : mixed
Parameters
- $logger : LoggerInterface
- $commands : Commands
__get()
Makes it simple to access our protected properties.
public
__get(string $key) : array<string, string>|Commands|LoggerInterface|string|null
Parameters
- $key : string
Return values
array<string, string>|Commands|LoggerInterface|string|null__isset()
Makes it simple to check our protected properties.
public
__isset(string $key) : bool
Parameters
- $key : string
Return values
boolgetPad()
Get pad for $key => $value array output
public
getPad(array<string, string> $array, int $pad) : int
Use setPad() instead.
Parameters
- $array : array<string, string>
- $pad : int
Tags
Return values
intrun()
Actually execute a command.
public
abstract run(array<int|string, string|null> $params) : int|void
Parameters
- $params : array<int|string, string|null>
Return values
int|voidsetPad()
Pads our string out so that all titles are the same length to nicely line up descriptions.
public
setPad(string $item, int $max[, int $extra = 2 ][, int $indent = 0 ]) : string
Parameters
- $item : string
- $max : int
- $extra : int = 2
-
How many extra spaces to add at the end
- $indent : int = 0
Return values
stringshowHelp()
Show Help includes (Usage, Arguments, Description, Options).
public
showHelp() : void
call()
Can be used by a command to run other commands.
protected
call(string $command[, array<int|string, string|null> $params = [] ]) : int|void
Parameters
- $command : string
- $params : array<int|string, string|null> = []
Tags
Return values
int|voidshowError()
A simple method to display an error with line/file, in child commands.
protected
showError(Throwable $e) : void
Parameters
- $e : Throwable