Spec-Zone.ru › Laravel 5.7

FreshCommand

class FreshCommand extends Command (View source)

Трейты

ConfirmableTrait
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 Имя и сигнатура командной строки. from Command
protected string $name Имя командной строки.
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)

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

из Macroable
static void mixin(object $mixin)

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

из Macroable
static bool hasMacro(string $name)

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

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

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

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

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

из Macroable
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
ArrayInput createInputFromArguments(array $arguments)

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

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

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

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

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

из Command
array arguments()

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

из 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)

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

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

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

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

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

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

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

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

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

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

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

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

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

из 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
array getArguments()

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

из Command
array getOptions()

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

OutputStyle getOutput()

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

из Command
Application getLaravel()

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

из Command
void setLaravel(Container $laravel)

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

из Command
bool confirmToProceed(string $warning = 'Приложение в рабочем состоянии!', Closure|bool|null $callback = null)

Подтвердить перед продолжением действия.

из ConfirmableTrait
Closure getDefaultConfirmCallback()

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

из ConfirmableTrait
void handle()

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

void dropAllTables(string $database)

Удалить все таблицы базы данных.

void dropAllViews(string $database)

Удалить все представления базы данных.

bool needsSeeding()

Определить, потребовал ли разработчик заполнения базы данных.

void runSeeder(string $database)

Выполнить команду седера базы данных.

Подробности

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

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

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

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

Parameters

object $mixin

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

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

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

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

массив

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

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

Параметры

строка $question
bool $default

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

bool

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

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

Параметры

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

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

смешанный тип

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

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

Параметры

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

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

смешанный тип

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

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

Параметры

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

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

смешанный тип

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

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

Параметры

строка $question
bool $fallback

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

смешанный тип

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

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

Параметры

строка $question
массив $choices
строка|null $default
смешанный тип|null $attempts
bool|null $multiple

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

строка

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

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

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputStyle getOutput()

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

Return Value

OutputStyle

Приложение getLaravel()

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

Return Value

Приложение

void setLaravel(Контейнер $laravel)

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

Parameters

Контейнер $laravel

Return Value

void

bool confirmToProceed(string $warning = 'Приложение в режиме разработки!', Closure|bool|null $callback = null)

Подтвердить перед выполнением действия.

Этот метод запрашивает подтверждение только в режиме разработки.

Parameters

string $warning
Closure|bool|null $callback

Return Value

bool

protected Closure getDefaultConfirmCallback()

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

Return Value

Closure

void handle()

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

Return Value

void

protected void dropAllTables(string $database)

Удалить все таблицы базы данных.

Parameters

string $database

Return Value

void

protected void dropAllViews(string $database)

Удалить все представления базы данных.

Parameters

string $database

Return Value

void

protected bool needsSeeding()

Определить, запросил ли разработчик загрузку данных.

Return Value

bool

protected void runSeeder(string $database)

Выполнить команду загрузки данных.

Parameters

string $database

Return Value

void

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

Spec-Zone.ru

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