class Command

Traits

Properties

protected $signature
protected $options
protected $description
protected $argv
$context
$command

Methods

mixed
__get(string $name)

Return the value of the method get{Name}Attribute.

__set(string $name, mixed $value)

Set the value of the method set{Name}Attribute.

__isset(string $name)

Extend the __isset method to check for the method get{Name}Attribute.

__unset(string $name)

Extend the __unset method to check for the method get{Name}Attribute.

bool
hasGetMutator(string $key)

Determine if a get mutator exists for an attribute.

mixed
mutateAttribute(string $key)

Get the value of an attribute using its mutator.

bool
hasSetMutator(string $key)

Determine if a set mutator exists for an attribute.

mixed
setMutatedAttributeValue(string $key, mixed $value)

Set the value of an attribute using its mutator.

line($str)

Display a colored line in the console.

info(string $str)

Display a colored line in the console.

string
ask(string $str, string $default = '')

Make a request to end user in the console and return the user input or the default value.

__construct()

No description

bool|mixed
options(string $value)

Return true if the options exists.

displayHelp()

Display the help well formatted.

string
getDescriptionAttribute()

Return the description of command console.

setArgvAttribute(mixed $value)

Set the argv.

handle()

No description

Details

in HasAttributes at line 16
mixed __get(string $name)

Return the value of the method get{Name}Attribute.

Parameters

string $name Usually the protected property name.

Return Value

mixed

in HasAttributes at line 32
__set(string $name, mixed $value)

Set the value of the method set{Name}Attribute.

Parameters

string $name Usually the protected property name.
mixed $value

in HasAttributes at line 45
__isset(string $name)

Extend the __isset method to check for the method get{Name}Attribute.

Parameters

string $name Usually the protected property name.

in HasAttributes at line 58
__unset(string $name)

Extend the __unset method to check for the method get{Name}Attribute.

Parameters

string $name Usually the protected property name.

in HasAttributes at line 72
bool hasGetMutator(string $key)

Determine if a get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 83
protected mixed mutateAttribute(string $key)

Get the value of an attribute using its mutator.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 94
bool hasSetMutator(string $key)

Determine if a set mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 106
protected mixed setMutatedAttributeValue(string $key, mixed $value)

Set the value of an attribute using its mutator.

Parameters

string $key
mixed $value

Return Value

mixed

at line 29
protected line($str)

Display a colored line in the console.

Parameters

$str String to display.

at line 40
protected info(string $str)

Display a colored line in the console.

Parameters

string $str String to display.

at line 54
protected string ask(string $str, string $default = '')

Make a request to end user in the console and return the user input or the default value.

Parameters

string $str The question string.
string $default Optional. A default value whether the user press return.

Return Value

string

at line 66
__construct()

at line 107
bool|mixed options(string $value)

Return true if the options exists.

Parameters

string $value The option.

Return Value

bool|mixed

at line 148
displayHelp()

Display the help well formatted.

at line 173
string getDescriptionAttribute()

Return the description of command console.

Return Value

string

at line 183
setArgvAttribute(mixed $value)

Set the argv.

Parameters

mixed $value Usually a string.

at line 188
abstract handle()