Command extends Command Uses CommandActionTrait
Table of Contents
- $cliBenchmark : Benchmark
- $commandBenchmark : Benchmark
- $commandDefinition : CommandDefinition
- $commandMode : string
- $input : InputInterface
- $io : SymfonyStyle
- $output : OutputInterface
- $parentCommand : Command
- $selectableArgumentChoices : array<string|int, mixed>
- $selectableArgumentValues : array<string|int, mixed>
- $taskInfo : string
- __construct() : mixed
- execute() : mixed
- getCommandMode() : string|null
- getLocalName() : string
- getLocalParentName() : string|null
- getParentCommand() : Command|null
- run() : mixed
- setCommandDefinition() : mixed
- setCommandMode() : mixed
- setParentCommand() : mixed
- toArray() : mixed
- abortCommand() : mixed
- addSelectableArgument() : mixed
- configure() : mixed
- executeCommand() : mixed
- getArgument() : mixed
- getCommandTitle() : mixed
- getCommandUsed() : string
- getOption() : mixed
- printActionTitle() : mixed
- printBullet() : mixed
- printCaution() : mixed
- printChoice() : mixed
- printCommandFinish() : void
- printCommandStart() : mixed
- printCommandTitle() : mixed
- printConfirm() : mixed
- printIndentedOutput() : mixed
- printInfo() : mixed
- printList() : mixed
- printNewLine() : mixed
- printQuestion() : mixed
- printShellCommand() : mixed
- printSubActionTitle() : mixed
- printText() : mixed
- renderFile() : mixed
- File replace
- replaceInFile() : mixed
- runAction() : mixed
- Action
- runActionWithoutTitle() : mixed
- runProcess() : mixed
- Process
- runProcessAndGetContents() : string
- runProcesses() : mixed
- runSubAction() : mixed
- setArguments() : mixed
- doRunAction() : mixed
- doRunProcess() : string
- getDefinitionsWithBeforeActions() : array<string|int, mixed>
Properties
$cliBenchmark
protected
static Benchmark
$cliBenchmark
$commandBenchmark
protected
Benchmark
$commandBenchmark
$commandDefinition
protected
CommandDefinition
$commandDefinition
$commandMode
protected
string
$commandMode
$input
protected
InputInterface
$input
$io
protected
SymfonyStyle
$io
$output
protected
OutputInterface
$output
$parentCommand
protected
Command
$parentCommand
$selectableArgumentChoices
protected
array<string|int, mixed>
$selectableArgumentChoices
= []
$selectableArgumentValues
protected
array<string|int, mixed>
$selectableArgumentValues
= []
$taskInfo
protected
string
$taskInfo
Methods
__construct()
public
__construct(Application $application[, string $name = null ]) : mixed
Parameters
- $application : Application
- $name : string = null
Return values
mixed —execute()
public
execute(InputInterface $input, OutputInterface $output) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
Return values
mixed —getCommandMode()
public
getCommandMode([string|null $default = null ]) : string|null
Parameters
- $default : string|null = null
Return values
string|null —getLocalName()
public
getLocalName() : string
Return values
string —getLocalParentName()
public
getLocalParentName() : string|null
Return values
string|null —getParentCommand()
public
getParentCommand() : Command|null
Return values
Command|null —run()
public
run(InputInterface $input, OutputInterface $output) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
Return values
mixed —setCommandDefinition()
public
setCommandDefinition(CommandDefinition $commandDefinition) : mixed
Parameters
- $commandDefinition : CommandDefinition
Return values
mixed —setCommandMode()
public
setCommandMode(string|null $commandMode) : mixed
Parameters
- $commandMode : string|null
Return values
mixed —setParentCommand()
public
setParentCommand([Command $parentCommand = null ]) : mixed
Parameters
- $parentCommand : Command = null
Return values
mixed —toArray()
public
toArray() : mixed
Return values
mixed —abortCommand()
protected
abortCommand([mixed $text = null ]) : mixed
Parameters
- $text : mixed = null
Return values
mixed —addSelectableArgument()
protected
addSelectableArgument(string $name, mixed $choices[, string $description = '' ][, mixed $default = null ]) : mixed
Parameters
- $name : string
- $choices : mixed
- $description : string = ''
- $default : mixed = null
Return values
mixed —configure()
protected
configure() : mixed
Return values
mixed —executeCommand()
protected
executeCommand() : mixed
Return values
mixed —getArgument()
protected
getArgument(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
Return values
mixed —getCommandTitle()
protected
getCommandTitle() : mixed
Return values
mixed —getCommandUsed()
protected
getCommandUsed() : string
Return values
string —getOption()
protected
getOption(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
Return values
mixed —printActionTitle()
protected
printActionTitle(string $title) : mixed
Parameters
- $title : string
Return values
mixed —printBullet()
protected
printBullet(string $text) : mixed
Parameters
- $text : string
Return values
mixed —printCaution()
protected
printCaution(string $text) : mixed
Parameters
- $text : string
Return values
mixed —printChoice()
protected
printChoice(mixed ...$arguments) : mixed
Parameters
- $arguments : mixed
Return values
mixed —printCommandFinish()
protected
printCommandFinish() : void
Return values
void —printCommandStart()
protected
printCommandStart(mixed $info) : mixed
Parameters
- $info : mixed
Return values
mixed —printCommandTitle()
protected
printCommandTitle(string $title) : mixed
Parameters
- $title : string
Return values
mixed —printConfirm()
protected
printConfirm(mixed ...$arguments) : mixed
Parameters
- $arguments : mixed
Return values
mixed —printIndentedOutput()
protected
printIndentedOutput(mixed $callback) : mixed
Parameters
- $callback : mixed
Return values
mixed —printInfo()
protected
printInfo(string $text) : mixed
Parameters
- $text : string
Return values
mixed —printList()
protected
printList(array<string|int, mixed> $list) : mixed
Parameters
- $list : array<string|int, mixed>
Return values
mixed —printNewLine()
protected
printNewLine() : mixed
Return values
mixed —printQuestion()
protected
printQuestion(string $question[, mixed $default = null ]) : mixed
Parameters
- $question : string
- $default : mixed = null
Return values
mixed —printShellCommand()
protected
printShellCommand(string $command[, mixed $cwd = null ]) : mixed
Parameters
- $command : string
- $cwd : mixed = null
Return values
mixed —printSubActionTitle()
protected
printSubActionTitle(string $title) : mixed
Parameters
- $title : string
Return values
mixed —printText()
protected
printText(string $text) : mixed
Parameters
- $text : string
Return values
mixed —renderFile()
File replace
protected
renderFile(string $file, array<string|int, mixed> $data) : mixed
Parameters
- $file : string
- $data : array<string|int, mixed>
Return values
mixed —replaceInFile()
protected
replaceInFile(string $file, Closure $callback) : mixed
Parameters
- $file : string
- $callback : Closure
Return values
mixed —runAction()
Action
protected
runAction(string $Action[, array<string|int, mixed> $args = [] ][, string $cwd = null ]) : mixed
Parameters
- $Action : string
- $args : array<string|int, mixed> = []
- $cwd : string = null
Return values
mixed —runActionWithoutTitle()
protected
runActionWithoutTitle(string $Action[, array<string|int, mixed> $args = [] ][, string $cwd = null ]) : mixed
Parameters
- $Action : string
- $args : array<string|int, mixed> = []
- $cwd : string = null
Return values
mixed —runProcess()
Process
protected
runProcess(mixed $command[, string $cwd = null ][, array<string|int, mixed> $env = [] ]) : mixed
Parameters
- $command : mixed
- $cwd : string = null
- $env : array<string|int, mixed> = []
Return values
mixed —runProcessAndGetContents()
protected
runProcessAndGetContents(mixed $command[, string $cwd = null ][, array<string|int, mixed> $env = [] ]) : string
Parameters
- $command : mixed
- $cwd : string = null
- $env : array<string|int, mixed> = []
Return values
string —runProcesses()
protected
runProcesses(mixed $commands[, string $cwd = null ][, array<string|int, mixed> $env = [] ]) : mixed
Parameters
- $commands : mixed
- $cwd : string = null
- $env : array<string|int, mixed> = []
Return values
mixed —runSubAction()
protected
runSubAction(string $Action[, array<string|int, mixed> $args = [] ][, string $cwd = null ]) : mixed
Parameters
- $Action : string
- $args : array<string|int, mixed> = []
- $cwd : string = null
Return values
mixed —setArguments()
protected
setArguments() : mixed
Return values
mixed —doRunAction()
private
doRunAction(string $Action, array<string|int, mixed> $args[, string $cwd = null ][, mixed $titleFormat = Action::TITLE_NORMAL ]) : mixed
Parameters
- $Action : string
- $args : array<string|int, mixed>
- $cwd : string = null
- $titleFormat : mixed = Action::TITLE_NORMAL
Return values
mixed —doRunProcess()
private
doRunProcess(mixed $command[, string $cwd = null ][, array<string|int, mixed> $env = [] ][, mixed $hideOutput = false ]) : string
Parameters
- $command : mixed
- $cwd : string = null
- $env : array<string|int, mixed> = []
- $hideOutput : mixed = false
Return values
string —getDefinitionsWithBeforeActions()
private
getDefinitionsWithBeforeActions(CommandDefinition $commandDefinition) : array<string|int, mixed>
Parameters
- $commandDefinition : CommandDefinition