Spec-Zone.ru › Laravel 5.8

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

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

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

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

 из 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|bool|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|null $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)

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

 from Команда
void warn(string $string, int|string|null $verbosity = null)

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

 from Команда
void alert(string $string)

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

 from Команда
void setVerbosity(string|int $level)

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

 from Команда
int parseVerbosity(string|int|null $level = null)

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

 from Команда
isHidden()

{@inheritdoc}

 from Команда
setHidden($hidden)

{@inheritdoc}

 from Команда
array getArguments()

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

 from Команда
array getOptions()

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

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

 from Команда
Application getLaravel()

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

 from Команда
void setLaravel(Container $laravel)

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

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

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

 from ConfirmableTrait
Closure getDefaultConfirmCallback()

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

 from ConfirmableTrait
void handle()

Выполнить команду консоли.
void dropAllTables(string $database)

Удалить все таблицы базы данных.
void dropAllViews(string $database)

Удалить все представления базы данных.
void dropAllTypes(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, 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
END_OF_DOCUMENT_MARKER

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)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

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

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

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

Parameters

string|null $key

Return Value

string|array|bool|null

array options()

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

Return Value

array

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

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

Parameters

string $question
bool $default

Return Value

bool

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

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

Parameters

string $question
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
bool $fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string

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

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

Parameters

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

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

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

Return Value

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

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Параметры

$hidden

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputStyle getOutput()

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

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

OutputStyle

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

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

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

Этот метод запрашивает подтверждение только в режиме эксплуатации.

Параметры

string $warning
Closure|bool|null $callback

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

bool

protected Closure getDefaultConfirmCallback()

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

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

Closure

void handle()

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

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

void

protected void dropAllTables(string $database)

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

Параметры

string $database

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

void

protected void dropAllViews(string $database)

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

Параметры

string $database

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

void

protected void dropAllTypes(string $database)

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

Параметры

string $database

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

void

protected bool needsSeeding()

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

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

bool

protected void runSeeder(string $database)

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

Параметры

string $database

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

void

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

Spec-Zone.ru

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