1. class
  2. Illuminate
  3. Console
  4. Command

Command

class Command extends Command (View source)

Methods

void
__construct()

Create a new console command instance.

int
run( InputInterface $input, OutputInterface $output)

Run the console command.

int
call( string $command, array $arguments = array())

Call another console command.

int
callSilent( string $command, array $arguments = array())

Call another console command silently.

string|array
argument( string $key = null)

Get the value of a command argument.

string|array
option( string $key = null)

Get the value of a command option.

bool
confirm( string $question, bool $default = false)

Confirm a question with the user.

string
ask( string $question, string $default = null)

Prompt the user for input.

string
anticipate( string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

string
askWithCompletion( string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

string
secret( string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

string
choice( string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

Give the user a single choice from an array of answers.

void
table( array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

void
info( string $string, null|int|string $verbosity = null)

Write a string as information output.

void
line( string $string, string $style = null, null|int|string $verbosity = null)

Write a string as standard output.

void
comment( string $string, null|int|string $verbosity = null)

Write a string as comment output.

void
question( string $string, null|int|string $verbosity = null)

Write a string as question output.

void
error( string $string, null|int|string $verbosity = null)

Write a string as error output.

void
warn( string $string, null|int|string $verbosity = null)

Write a string as warning output.

OutputInterface
getOutput()

Get the output implementation.

Application
getLaravel()

Get the Laravel application instance.

void
setLaravel( Container $laravel)

Set the Laravel application instance.

Details

at line line 85
void __construct()

Create a new console command instance.

Return Value

void

at line line 149
int run( InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

at line line 179
int call( string $command, array $arguments = array())

Call another console command.

Parameters

string $command
array $arguments

Return Value

int

at line line 195
int callSilent( string $command, array $arguments = array())

Call another console command silently.

Parameters

string $command
array $arguments

Return Value

int

at line line 210
string|array argument( string $key = null)

Get the value of a command argument.

Parameters

string $key

Return Value

string|array

at line line 225
string|array option( string $key = null)

Get the value of a command option.

Parameters

string $key

Return Value

string|array

at line line 241
bool confirm( string $question, bool $default = false)

Confirm a question with the user.

Parameters

string $question
bool $default

Return Value

bool

at line line 253
string ask( string $question, string $default = null)

Prompt the user for input.

Parameters

string $question
string $default

Return Value

string

at line line 266
string anticipate( string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

at line line 279
string askWithCompletion( string $question, array $choices, string $default = null)

Prompt the user for input with auto completion.

Parameters

string $question
array $choices
string $default

Return Value

string

at line line 295
string secret( string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

Parameters

string $question
bool $fallback

Return Value

string

at line line 314
string choice( string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

Give the user a single choice from an array of answers.

Parameters

string $question
array $choices
string $default
mixed $attempts
bool $multiple

Return Value

string

at line line 331
void table( array $headers, Arrayable|array $rows, string $style = 'default')

Format input to textual table.

Parameters

array $headers
Arrayable|array $rows
string $style

Return Value

void

at line line 349
void info( string $string, null|int|string $verbosity = null)

Write a string as information output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

at line line 362
void line( string $string, string $style = null, null|int|string $verbosity = null)

Write a string as standard output.

Parameters

string $string
string $style
null|int|string $verbosity

Return Value

void

at line line 376
void comment( string $string, null|int|string $verbosity = null)

Write a string as comment output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

at line line 388
void question( string $string, null|int|string $verbosity = null)

Write a string as question output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

at line line 400
void error( string $string, null|int|string $verbosity = null)

Write a string as error output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

at line line 412
void warn( string $string, null|int|string $verbosity = null)

Write a string as warning output.

Parameters

string $string
null|int|string $verbosity

Return Value

void

at line line 476
OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

at line line 486
Application getLaravel()

Get the Laravel application instance.

Return Value

Application

at line line 497
void setLaravel( Container $laravel)

Set the Laravel application instance.

Parameters

Container $laravel

Return Value

void