Spec-Zone.ru › Laravel 6

Команда

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

Трейты

CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

Реализация интерфейса ввода.

 из InteractsWithIO
protected OutputStyle $output

Реализация интерфейса вывода.

 из InteractsWithIO
protected int $verbosity

Уровень детализации вывода команд по умолчанию.

 из InteractsWithIO
protected array $verbosityMap

Сопоставление удобочитаемых уровней детализации и уровней Symfony's OutputInterface.

 из InteractsWithIO
static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected Application $laravel

Экземпляр приложения Laravel.
protected string $signature

Имя и синтаксис команды консоли.
protected string $name

Имя команды консоли.
protected string|null $description

Описание команды консоли.
protected string|null $help

Текст справки по команде консоли.
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

Методы

Команда resolveCommand(Command|string $command)

Разрешить экземпляр консольной команды для заданной команды.
int call(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilent(Command|string $command, array $arguments = [])

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

 из CallsCommands
int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

 из CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

 из CallsCommands
массив context()

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

 из CallsCommands
void specifyParameters()

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

 из HasParameters
массив getArguments()

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

 из HasParameters
массив getOptions()

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

 из HasParameters
bool hasArgument(string|int $name)

Определить, присутствует ли заданный аргумент.

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

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

 из InteractsWithIO
массив arguments()

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

 из InteractsWithIO
bool hasOption(string $name)

Определить, присутствует ли заданный параметр.

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

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

 из InteractsWithIO
массив options()

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

 из InteractsWithIO
bool confirm(string $question, bool $default = false)

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

 из InteractsWithIO
смешанный ask(string $question, string|null $default = null)

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

 из InteractsWithIO
смешанный anticipate(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
смешанный askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
смешанный secret(string $question, bool $fallback = true)

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

 из InteractsWithIO
строка choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

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

 из InteractsWithIO
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

 из InteractsWithIO
void info(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

 из InteractsWithIO
void comment(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void question(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void error(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void warn(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void alert(string $string)

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

 из InteractsWithIO
void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

 из InteractsWithIO
void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

 из InteractsWithIO
void setVerbosity(string|int $level)

Установить уровень подробности.

 из InteractsWithIO
int parseVerbosity(string|int|null $level = null)

Получить уровень подробности с точки зрения уровня OutputInterface Symfony.

 из InteractsWithIO
OutputStyle getOutput()

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

 из InteractsWithIO
static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макрос.

 из Macroable
static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

 из Macroable
static bool hasMacro(string $name)

Проверка, зарегистрировано ли макрос.

 из Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

 из Macroable
mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

 из Macroable
void __construct()

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

Настроить команду консоли с помощью определения с плавным переходом.
int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.
mixed execute(InputInterface $input, OutputInterface $output)

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

{@inheritdoc}
setHidden($hidden)

{@inheritdoc}
Application getLaravel()

Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)

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

Подробности

protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string $command

Return Value

Command

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

Определить, присутствует ли заданный аргумент.

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

Определить, присутствует ли заданный параметр.

Parameters

string $name

Return Value

bool

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

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

Параметры

строка|null $key

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

строка|массив|логическое|null

массив options()

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

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

массив

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

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

Параметры

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

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

логическое

смешанное ask(строка $question, строка|null $default = null)

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

Параметры

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

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

смешанное

смешанное anticipate(строка $question, массив|вызываемый $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызываемый $choices
строка|null $default

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

смешанное

смешанное askWithCompletion(строка $question, массив|вызываемый $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызываемый $choices
строка|null $default

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

смешанное

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

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

Параметры

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

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

смешанное

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

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

Параметры

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

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

строка

пусто table(массив $headers, Arrayable|массив $rows, строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

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

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

пусто

пусто info(строка $string, целое|строка|null $verbosity = null)

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

Параметры

строка $string
целое|строка|null $verbosity

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

пусто

пусто line(строка $string, строка|null $style = null, целое|строка|null $verbosity = null)

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

Параметры

строка $string
строка|null $style
целое|строка|null $verbosity

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

пусто

пусто comment(строка $string, целое|строка|null $verbosity = null)

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

Параметры

строка $string
целое|строка|null $verbosity

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

пусто

пусто question(строка $string, целое|строка|null $verbosity = null)

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

Параметры

строка $string
целое|строка|null $verbosity

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

пусто

пусто error(строка $string, целое|строка|null $verbosity = null)

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

Параметры

строка $string
целое|строка|null $verbosity

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

пусто

пусто warn(строка $string, целое|строка|null $verbosity = null)

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

Параметры

строка $string
целое|строка|null $verbosity

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

пусто

пусто alert(строка $string)

Вывести строку в окне уведомления.

Параметры

строка $string

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

пусто

пусто setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface $input

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

пусто

пусто setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle $output

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

пусто

protected пусто setVerbosity(строка|целое $level)

Установить уровень подробности.

Параметры

строка|целое $level

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

пусто

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности в терминах уровня OutputInterface Symfony.

Parameters

string|int|null $level

Return Value

int

OutputStyle getOutput()

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

Return Value

OutputStyle

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct()

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

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Parameters

$hidden

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container $laravel

Return Value

void

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

Spec-Zone.ru

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