BaseCommand

class BaseCommand extends Command (View source)

Свойства

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

Методы

void

__construct()

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

из Command

void

configureUsingFluentDefinition()

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

из Command

void

specifyParameters()

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

из Command

int

run(InputInterface $input, OutputInterface $output)

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

из Command

mixed

execute(InputInterface $input, OutputInterface $output)

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

из Command

int

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

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

из Command

int

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

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

из Command

string|array

argument(string $key = null)

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

из Command

string|array

option(string $key = null)

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

из Command

bool

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

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

из Command

string

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

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

из Command

string

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

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

из Command

string

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

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

из Command

string

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

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

из Command

string

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

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

из Command

void

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

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

из Command

void

info(string $string)

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

из Command

void

line(string $string)

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

из Command

void

comment(string $string)

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

из Command

void

question(string $string)

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

из Command

void

error(string $string)

Вывести строку в качестве сообщения об ошибке.

из Command

void

warn(string $string)

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

из Command

array

getArguments()

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

из Command

array

getOptions()

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

из Command

OutputInterface

getOutput()

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

из Command

Application

getLaravel()

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

из Command

void

setLaravel(Application $laravel)

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

из Command

string

getMigrationPath()

Получить путь к каталогу миграций.

Подробности

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)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

mixed

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

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

Parameters

string	$command
array	$arguments

Return Value

int

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

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

Parameters

string	$command
array	$arguments

Return Value

int

string|array argument(string $key = null)

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

Parameters

string

$key

Return Value

string|array

string|array option(string $key = null)

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

Parameters

string

$key

Return Value

string|array

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

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string	$default

Return Value

string

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

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

Parameters

string	$question
array	$choices
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

string 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

string

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

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

Parameters

array	$headers
Arrayable\|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

void warn(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.

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

Application

void setLaravel(Application $laravel)

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

Параметры

Application

$laravel

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

void

protected string getMigrationPath()

Получить путь к каталогу миграций.

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

string

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