Spec-Zone.ru › Laravel 5.7

PresetCommand

class PresetCommand extends Command (View source)

Особенности

Macroable

Свойства

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

Методы

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()

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

 from Command
void configureUsingFluentDefinition()

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

 from Command
void specifyParameters()

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

 from Command
int run(InputInterface $input, OutputInterface $output)

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

 from Command
mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

 from Command
ArrayInput createInputFromArguments(array $arguments)

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

 from Command
bool hasArgument(string|int $name)

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

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

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

 from Command
array arguments()

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

 from Command
bool hasOption(string $name)

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

 из Command
string|array|null option(string|null $key = null)

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

 из Command
array options()

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

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

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

 из Command
mixed ask(string $question, string|null $default = null)

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

 из Command
mixed anticipate(string $question, array $choices, string|null $default = null)

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

 из Command
mixed askWithCompletion(string $question, array $choices, string|null $default = null)

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

 из Command
mixed secret(string $question, bool $fallback = true)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 from Command
void alert(string $string)

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

 from Command
void setVerbosity(string|int $level)

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

 from Command
int parseVerbosity(string|int|null $level = null)

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

 from Command
array getArguments()

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

 from Command
array getOptions()

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

 from Command
OutputStyle getOutput()

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

 from Command
Application getLaravel()

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

 from Command
void setLaravel(Container $laravel)

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

 from Command
void handle()

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

Установить предустановку "fresh".
void bootstrap()

Установить предустановку "bootstrap".
void vue()

Установить предустановку "vue".
void react()

Установить предустановку "react".

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin)

Добавить другой объект в класс.

Параметры

object $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $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 = [])

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

Параметры

string $command
array $arguments

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

int

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

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

Параметры

string $command
array $arguments

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

Массив $arguments

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

ArrayInput

bool hasArgument(string|int $name)

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

Параметры

Строка|Целое число $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()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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, int|string|null $verbosity = null)

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

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

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $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

OutputStyle getOutput()

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

Значение возвращаемого значения

OutputStyle

Application getLaravel()

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

Значение возвращаемого значения

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

Значение возвращаемого значения

void

void handle()

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

Значение возвращаемого значения

void

protected void none()

Установить пресет «fresh».

Значение возвращаемого значения

void

protected void bootstrap()

Установить пресет «bootstrap».

Значение возвращаемого значения

void

protected void vue()

Установить пресет "vue".

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

void

protected void react()

Установить пресет "react".

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

void

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

Spec-Zone.ru

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