Spec-Zone.ru › Laravel 5.6

Команда

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

Трейты

Macroable

Свойства

статический защищенный массив $macros Зарегистрированные строковые макросы. из Macroable
защищенный Application $laravel Экземпляр приложения Laravel.
защищенный InputInterface $input Реализация интерфейса ввода.
защищенный OutputStyle $output Реализация интерфейса вывода.
защищенная строка $signature Имя и сигнатура командной строки.
защищенная строка $name Имя командной строки.
защищенная строка $description Описание командной строки.
защищенный bool $hidden Указывает, должна ли команда отображаться в списке команд Artisan.
защищенный int $verbosity По умолчанию уровень подробности команд вывода.
защищенный массив $verbosityMap Сопоставление уровней подробности удобочитаемого текста и Symfony OutputInterface.

Методы

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

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

 from Macroable
static void mixin(object $mixin)

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

 from Macroable
static bool hasMacro(string $name)

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

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

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

 from Macroable
mixed __call(string $method, array $parameters)

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

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

Вызвать другую команду консоли без вывода.
ArrayInput createInputFromArguments(array $arguments)

Создать экземпляр ввода из заданных аргументов.
bool hasArgument(string|int $name)

Определить, присутствует ли данный аргумент.
string|array|null argument(string|null $key = null)

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

Получить все переданные аргументы команды.
bool hasOption(string $name)

Определить, присутствует ли данная опция.
string|array|null option(string|null $key = null)

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

Получить все переданные опции команды.
bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.
string ask(string $question, string|null $default = null)

Задать вопрос пользователю.
string anticipate(string $question, array $choices, string|null $default = null)

Задать вопрос пользователю с автодополнением.
string askWithCompletion(string $question, array $choices, string|null $default = null)

Задать вопрос пользователю с автодополнением.
string secret(string $question, bool $fallback = true)

Задать вопрос пользователю, но скрыть ответ в консоли.
string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

Предложить пользователю один вариант из массива ответов.
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

Форматировать ввод в текстовую таблицу.
void info(string $string, null|int|string $verbosity = null)

Вывести строку как информационное сообщение.
void line(string $string, string $style = null, null|int|string $verbosity = null)

Вывести строку как стандартное сообщение.
void comment(string $string, null|int|string $verbosity = null)

Вывести строку как комментарий.
void question(string $string, null|int|string $verbosity = null)

Вывести строку как вопрос.
void error(string $string, null|int|string $verbosity = null)

Вывести строку как сообщение об ошибке.
void warn(string $string, null|int|string $verbosity = null)

Вывести строку как предупреждение.
void alert(string $string)

Вывести строку в всплывающем окне.
void setVerbosity(string|int $level)

Установить уровень подробности.
int parseVerbosity(string|int|null $level = null)

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

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

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

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

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

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

Details

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

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

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

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

Параметры

объект $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

строка $method
массив $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

строка $command
массив $arguments

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

int

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

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

Параметры

строка $command
массив $arguments

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив $arguments

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

ArrayInput

bool hasArgument(string|int $name)

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

Параметры

строка|int $name

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

bool

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

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

Параметры

строка|null $key

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

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

array arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

строка|null $key

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

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

array options()

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

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

массив

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

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

Параметры

строка $question
bool $default

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

bool

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

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

Параметры

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

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

строка

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

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

Параметры

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

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

строка

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

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

Параметры

string $question
array $choices
string|null $default

Значение результата

string

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

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

Параметры

string $question
bool $fallback

Значение результата

string

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

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

Параметры

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

Значение результата

string

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

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

Параметры

array $headers
Arrayable|array $rows
string $tableStyle
array $columnStyles

Значение результата

void

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

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

Параметры

string $string
null|int|string $verbosity

Значение результата

void

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

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

Параметры

string $string
string $style
null|int|string $verbosity

Значение результата

void

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

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

Параметры

string $string
null|int|string $verbosity

Значение результата

void

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

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

Параметры

string $string
null|int|string $verbosity

Значение результата

void

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

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

Параметры

string $string
null|int|string $verbosity

Значение результата

void

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

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

Параметры

string $string
null|int|string $verbosity

Значение результата

void

void alert(string $string)

Вывести строку в всплывающем окне.

Параметры

string $string

Значение результата

void

protected void setVerbosity(string|int $level)

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

Параметры

string|int $level

Значение результата

void

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

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

Параметры

string|int|null $level

Значение результата

int

protected array getArguments()

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

Значение результата

array

protected array getOptions()

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

Значение результата

array

OutputInterface getOutput()

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

Значение результата

OutputInterface

Application getLaravel()

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

Значение результата

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

Значение результата

void

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

Spec-Zone.ru

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