W3cubDocs

/Laravel 5.2

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

void __construct()

Create a new console command instance.

Return Value

void

int run( InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

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

Call another console command.

Parameters

string	$command
array	$arguments

Return Value

int

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

Call another console command silently.

Parameters

string	$command
array	$arguments

Return Value

int

string|array argument( string $key = null)

Get the value of a command argument.

Parameters

string

$key

Return Value

string|array

string|array option( string $key = null)

Get the value of a command option.

Parameters

string

$key

Return Value

string|array

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

Confirm a question with the user.

Parameters

string	$question
bool	$default

Return Value

bool

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

Prompt the user for input.

Parameters

string	$question
string	$default

Return Value

string

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

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

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

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

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

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

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

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

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

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

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

OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel( Container $laravel)

Set the Laravel application instance.

Parameters

Container

$laravel

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Console/Command.html