Spec-Zone.ru › Laravel 5.8

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, bool $replace = true)

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

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

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

 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)

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

 from Command
string|array|bool|null option(string|null $key = null)

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

 from Command
array options()

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

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

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

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

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

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

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

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

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

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

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

 from 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|null $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)

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

 из Command
void alert(string $string)

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

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

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

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

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

 из Command
isHidden()

{@inheritdoc}

 из Command
setHidden($hidden)

{@inheritdoc}

 из Command
array getArguments()

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

 из Command
array getOptions()

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

 из Command
OutputStyle getOutput()

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

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
void handle()

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

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

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

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

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

Подробности

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

protected void specifyParameters()

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

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

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
END_OF_DOCUMENT_MARKER

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив $arguments

Значение возврата

ArrayInput

protected array context()

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

Значение возврата

массив

bool hasArgument(string|int $name)

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

Параметры

string|int $name

Значение возврата

bool

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

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

Параметры

string|null $key

Значение возврата

string|array|null

array arguments()

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

Значение возврата

массив

bool hasOption(string $name)

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

Параметры

string $name

Значение возврата

bool

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

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

Параметры

string|null $key

Значение возврата

string|array|bool|null

array options()

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

Значение возврата

массив

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
массив $choices
string|null $default

Значение возврата

mixed

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

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

Параметры

string $question
массив $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
массив $choices
string|null $default
mixed|null $attempts
bool|null $multiple

Значение возврата

string

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

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

Параметры

массив $headers
Arrayable|массив $rows
string $tableStyle
массив $columnStyles

Значение возврата

void

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

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

Параметры

string $string
int|string|null $verbosity

Значение возврата

void

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

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

Параметры

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

void alert(string $string)

Вывести строку в виде всплывающего сообщения об ошибке.

Parameters

string $string

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int $level

Return Value

void

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

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

Parameters

string|int|null $level

Return Value

int

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Parameters

$hidden

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputStyle getOutput()

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

Return Value

OutputStyle

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container $laravel

Return Value

void

void handle()

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

Return Value

void

Exceptions

InvalidArgumentException

protected void none()

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

Return Value

void

protected void bootstrap()

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

Return Value

void

protected void vue()

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

Return Value

void

protected void react()

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

Return Value

void

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

Spec-Zone.ru

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