Spec-Zone.ru › Laravel 4.2

Команда

класс Команда расширяет Command (Просмотреть исходный код)

Свойства

protected Приложение $laravel Экземпляр приложения Laravel.
protected InputInterface $input Реализация интерфейса ввода.
protected OutputInterface $output Реализация интерфейса вывода.
protected string $name Имя команды консоли.
protected string $description Описание команды консоли.

Методы

void __construct()

Создать новый экземпляр команды консоли.

void specifyParameters()

Указать аргументы и параметры команды.

int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

mixed execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

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

Вызвать другую команду консоли.

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

Вызвать другую команду консоли без отображения вывода.

string|array argument(string $key = null)

Получить значение аргумента команды.

string|array option(string $key = null)

Получить значение параметра команды.

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

Подтвердить вопрос у пользователя.

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

Задать вопрос пользователю.

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

Задать вопрос пользователю с автозаполнением.

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

Задать вопрос пользователю, скрыв ответ в консоли.

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

Предложить пользователю один вариант из массива ответов.

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

Форматирование ввода в текстовую таблицу

void info(string $string)

Вывести строку как информацию.

void line(string $string)

Вывести строку в стандартный вывод.

void comment(string $string)

Вывести строку как комментарий.

void question(string $string)

Вывести строку как вопрос.

void error(string $string)

Вывести строку как ошибку.

array getArguments()

Получить аргументы команды консоли.

array getOptions()

Получить параметры команды консоли.

OutputInterface getOutput()

Получить реализацию вывода.

Приложение getLaravel()

Получить экземпляр приложения Laravel.

void setLaravel(Приложение $laravel)

Установить экземпляр приложения Laravel.

Подробности

void __construct()

Создать новый экземпляр команды консоли.

Возвращаемое значение

void

protected void specifyParameters()

Указать аргументы и параметры команды.

Возвращаемое значение

void

int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

Параметры

InputInterface $input
OutputInterface $output

Возвращаемое значение

int

protected mixed execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

Параметры

InputInterface $input
OutputInterface $output

Возвращаемое значение

mixed

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

Вызвать другую команду консоли.

Параметры

string $command
array $arguments

Возвращаемое значение

int

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

Вызвать другую команду консоли без отображения вывода.

Параметры

string $command
array $arguments

Возвращаемое значение

int

string|array argument(string $key = null)

Получить значение аргумента команды.

Параметры

string $key

Возвращаемое значение

string|array

string|array option(string $key = null)

Получить значение параметра команды.

Параметры

string $key

Возвращаемое значение

string|array

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

Подтвердить вопрос у пользователя.

Параметры

string $question
bool $default

Возвращаемое значение

bool

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

Запросить у пользователя ввод.

Parameters

string $question
string $default

Return Value

string

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

Запросить у пользователя ввод с автозаполнением.

Parameters

string $question
array $choices
string $default

Return Value

string

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

Запросить у пользователя ввод, но скрыть ответ из консоли.

Parameters

string $question
bool $fallback

Return Value

string

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

Предложить пользователю единственный выбор из массива ответов.

Parameters

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

Return Value

bool

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

Форматировать ввод в текстовую таблицу

Parameters

array $headers
array $rows
string $style

Return Value

void

void info(string $string)

Вывести строку как информационное сообщение.

Parameters

string $string

Return Value

void

void line(string $string)

Вывести строку в стандартный вывод.

Parameters

string $string

Return Value

void

void comment(string $string)

Вывести строку как комментарий.

Parameters

string $string

Return Value

void

void question(string $string)

Вывести строку как вопрос.

Parameters

string $string

Return Value

void

void error(string $string)

Вывести строку как ошибку.

Parameters

string $string

Return Value

void

protected array getArguments()

Получить аргументы команды консоли.

Return Value

array

protected array getOptions()

Получить опции команды консоли.

Return Value

array

OutputInterface getOutput()

Получить реализацию вывода.

Return Value

OutputInterface

Application getLaravel()

Получить экземпляр приложения Laravel.

Return Value

Application

void setLaravel(Application $laravel)

Установить экземпляр приложения Laravel.

Parameters

Application $laravel

Return Value

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API