W3cubDocs

/Laravel 4.2

WorkCommand

class WorkCommand extends Command (View source)

Methods

void __construct(Worker $worker)

Create a new queue listen command.

int run(InputInterface $input, OutputInterface $output)

Run the console command.

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

Call another console command.

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

Call another console command silently.

from Command
string|array argument(string $key = null)

Get the value of a command argument.

from Command
string|array option(string $key = null)

Get the value of a command option.

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

Confirm a question with the user.

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

Prompt the user for input.

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

Prompt the user for input with auto completion.

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

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

from Command
bool 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.

from Command
void table(array $headers, array $rows, string $style = 'default')

Format input to textual table

from Command
void info(string $string)

Write a string as information output.

from Command
void line(string $string)

Write a string as standard output.

from Command
void comment(string $string)

Write a string as comment output.

from Command
void question(string $string)

Write a string as question output.

from Command
void error(string $string)

Write a string as error output.

from Command
OutputInterface getOutput()

Get the output implementation.

from Command
Application getLaravel()

Get the Laravel application instance.

from Command
void setLaravel(Application $laravel)

Set the Laravel application instance.

from Command
void fire()

Execute the console command.

Details

void __construct(Worker $worker)

Create a new queue listen command.

Parameters

Worker $worker

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 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

bool 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

bool

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

Format input to textual table

Parameters

array $headers
array $rows
string $style

Return Value

void

void info(string $string)

Write a string as information output.

Parameters

string $string

Return Value

void

void line(string $string)

Write a string as standard output.

Parameters

string $string

Return Value

void

void comment(string $string)

Write a string as comment output.

Parameters

string $string

Return Value

void

void question(string $string)

Write a string as question output.

Parameters

string $string

Return Value

void

void error(string $string)

Write a string as error output.

Parameters

string $string

Return Value

void

OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel(Application $laravel)

Set the Laravel application instance.

Parameters

Application $laravel

Return Value

void

void fire()

Execute the console command.

Return Value

void

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