Spec-Zone.ru › Laravel 5.1

Команда

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

Свойства

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

Методы

void __construct()

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

void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения Fluent.

void specifyParameters()

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

int run(InputInterface $input, OutputInterface $output)

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

mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

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 anticipate(string $question, array $choices, string $default = null)

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

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

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

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

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

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

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

void table(array $headers, Arrayable|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)

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

void warn(string $string)

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

array getArguments()

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

array getOptions()

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

OutputInterface getOutput()

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

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

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

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

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

Подробности

void __construct()

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

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

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения Fluent.

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

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 = [])

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

Параметры

string $command
array $arguments

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

int

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

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

Параметры

string $command
array $arguments

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

int

строка|массив argument(строка $key = null)

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

Параметры

строка $key

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

строка|массив

строка|массив option(строка $key = null)

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

Параметры

строка $key

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

строка|массив

логическое confirm(строка $question, логическое $default = false)

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

Параметры

строка $question
логическое $default

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

логическое

строка ask(строка $question, строка $default = null)

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

Параметры

строка $question
строка $default

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

строка

строка anticipate(строка $question, массив $choices, строка $default = null)

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

Параметры

строка $question
массив $choices
строка $default

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

строка

строка askWithCompletion(строка $question, массив $choices, строка $default = null)

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

Параметры

строка $question
массив $choices
строка $default

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

строка

строка secret(строка $question, логическое $fallback = true)

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

Параметры

строка $question
логическое $fallback

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

строка

строка choice(строка $question, массив $choices, строка $default = null, смешанное $attempts = null, логическое $multiple = null)

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

Параметры

строка $question
массив $choices
строка $default
смешанное $attempts
логическое $multiple

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

строка

пустое значение table(массив $headers, Arrayable|массив $rows, строка $style = 'default')

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

Параметры

массив $headers
Arrayable|массив $rows
строка $style

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

пустое значение

пустое значение info(строка $string)

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

Параметры

строка $string

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

пустое значение

пустое значение line(строка $string)

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

Параметры

строка $string

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

пустое значение

пустое значение comment(строка $string)

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

Параметры

строка $string

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

пустое значение

пустое значение question(строка $string)

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

Параметры

строка $string

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

пустое значение

пустое значение error(строка $string)

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

Параметры

строка $string

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

пустое значение

пустое значение warn(строка $string)

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

Параметры

строка $string

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

пустое значение

защищенный массив getArguments()

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

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

массив

защищенный массив getOptions()

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

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

массив

OutputInterface getOutput()

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

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

OutputInterface

Application getLaravel()

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

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

Application

пустое значение setLaravel(Application $laravel)

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

Параметры

Application $laravel

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

пустое значение

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

Spec-Zone.ru

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