Properties

$name

$name : 

Type

$description

$description : 

Type

Methods

testCommand()

testCommand() 

this is a command's description message the second line text

Examples

text one the second line example
** File not found : example **

disabledCommand()

disabledCommand() 

this is a disabled command. please see 'disabledCommands()'

defArgCommand()

defArgCommand() 

exCommand()

exCommand() 

a command for test throw exception

Throws

\RuntimeException

errorCommand()

errorCommand() 

a command for test trigger error

subRunCommand()

subRunCommand() 

will run other command in the command.

dumpEnvCommand()

dumpEnvCommand() 

dump current env information

colorCheckCommand()

colorCheckCommand() 

check color support for current env.

artFontCommand()

artFontCommand() : integer

output art font text

Returns

integer

counterCommand()

counterCommand() : integer

dynamic notice message show: counterTxt. It is like progress txt, but no max value.

Returns

integer

Examples

{command}
** File not found : {script} **

spinnerCommand()

spinnerCommand() 

dynamic spinner message, by Show::spinner()

pendingCommand()

pendingCommand() 

dynamic notice message show: pending

pointingCommand()

pointingCommand() 

dynamic notice message show: pointing

dynamicTextCommand()

dynamicTextCommand() 

dynamic text message example, by Show::dynamicText

progressCommand()

progressCommand(\Inhere\Console\IO\Input  $input) : integer

a progress bar example show, by Show::progressBar()

Parameters

\Inhere\Console\IO\Input $input

Returns

integer

Examples

{command} {script} {command} --done-char '#' --wait-char ' '
** File not found : {script} **

progressBarCommand()

progressBarCommand() 

a progress bar example show, by class ProgressBar

Throws

\LogicException

listCommand()

listCommand() 

output format message: list

multiListCommand()

multiListCommand() 

output format message: multiList

tableCommand()

tableCommand() 

output format message: table

paddingCommand()

paddingCommand() 

output format message: padding

useArgCommand()

useArgCommand() 

a example for use arguments on command

Examples

status=2 name=john arg0 -s=test --page=23 -d -rf --debug --test=false -a v1 --ab -c -g --cd val -h '' -i stat=online home:useArg status=2 name=john name=tom name=jack arg0 -s=test --page=23 --id=23 --id=154 --id=456 -d -rf --debug --test=false
** File not found : home:useArg **

envCommand()

envCommand() 

output current env info

downCommand()

downCommand() 

This is a demo for download a file to local

Examples

url=https://github.com/inhere/php-console/archive/master.zip type=bar
** File not found : {command} **

commandAliases()

commandAliases() : array

Returns

array

init()

init() 

groupOptions()

groupOptions() : array

Returns

array

disabledCommands()

disabledCommands() 

afterExecute()

afterExecute() 

defArgConfigure()

defArgConfigure() 

command `defArgCommand` config

Throws

\LogicException