Documentation

Action Uses CommandActionTrait

Table of Contents

TITLE_HIDDEN  = 'hide-title'
TITLE_NORMAL  = 'normal-title'
TITLE_SMALL  = 'small-title'
$args  : array<string|int, mixed>
$cwd  : string
$io  : SymfonyStyle
$titleFormat  : string
__construct()  : mixed
run()  : mixed
abortCommand()  : mixed
executeAction()  : mixed
getActionTitle()  : mixed
getArgument()  : mixed
printActionTitle()  : mixed
printBullet()  : mixed
printCaution()  : mixed
printChoice()  : 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
doRunAction()  : mixed
doRunProcess()  : string

Constants

TITLE_HIDDEN

public mixed TITLE_HIDDEN = 'hide-title'

TITLE_NORMAL

public mixed TITLE_NORMAL = 'normal-title'

TITLE_SMALL

public mixed TITLE_SMALL = 'small-title'

Properties

$args

protected array<string|int, mixed> $args = []

$cwd

protected string $cwd = null

$titleFormat

protected string $titleFormat = null

Methods

__construct()

public __construct(SymfonyStyle $io, string $titleFormat) : mixed
Parameters
$io : SymfonyStyle
$titleFormat : string
Return values
mixed

run()

public run([array<string|int, mixed> $args = [] ]) : mixed
Parameters
$args : array<string|int, mixed> = []
Return values
mixed

abortCommand()

protected abortCommand([mixed $text = null ]) : mixed
Parameters
$text : mixed = null
Return values
mixed

executeAction()

protected executeAction() : mixed
Return values
mixed

getActionTitle()

protected getActionTitle() : mixed
Return values
mixed

getArgument()

protected getArgument(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

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

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

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

Search results