Spec-Zone.ru › Laravel 8

WipeCommand

class WipeCommand extends Command (View source)

Свойства

ConfirmableTrait
CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

Реализация интерфейса ввода.

 from InteractsWithIO
protected OutputStyle $output

Реализация интерфейса вывода.

 from InteractsWithIO
protected int $verbosity

Уровень подробности вывода по умолчанию.

 from InteractsWithIO
protected array $verbosityMap

Сопоставление удобочитаемых уровней подробности и уровней Symfony OutputInterface.

 from InteractsWithIO
static protected array $macros

Зарегистрированные макросы строк.

 from Macroable
protected Application $laravel

Экземпляр приложения Laravel.

 from Command
protected string $signature

Имя и сигнатура командной строки.

 from Command
protected string $name

Имя команды консоли.
protected string $description

Описание команды консоли.
protected string $help

Текст справки по команде консоли.

 from Command
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

 from Command

Методы

Команда resolveCommand(Command|string $command)

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

 из CallsCommands
int call(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilent(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilently(Command|string $command, array $arguments = [])

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

 из CallsCommands
int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

 из CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

 из CallsCommands
массив context()

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

 из CallsCommands
void specifyParameters()

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

 из HasParameters
массив getArguments()

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

 из HasParameters
массив getOptions()

Получить параметры консольной команды.
bool hasArgument(string|int $name)

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

 из InteractsWithIO
string|массив|null argument(string|null $key = null)

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

 из InteractsWithIO
массив arguments()

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

 из InteractsWithIO
bool hasOption(string $name)

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

 из InteractsWithIO
string|массив|bool|null option(string|null $key = null)

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

 из InteractsWithIO
массив options()

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

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

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

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

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

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

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

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

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

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

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

 из InteractsWithIO
string|массив choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

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

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

 из InteractsWithIO
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, продвигая полосу прогресса.

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

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

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

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

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

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

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

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

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

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

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

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

 из InteractsWithIO
void alert(string $string)

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

 из InteractsWithIO
void newLine(int $count = 1)

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

 из InteractsWithIO
void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

 из InteractsWithIO
void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

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

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

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

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

 из InteractsWithIO
OutputStyle getOutput()

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

 из InteractsWithIO
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 void flushMacros()

Очистить существующие макросы.

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

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

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

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

 из Macroable
void __construct()

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

 из Command
void configureUsingFluentDefinition()

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

 из Command
int run(InputInterface $input, OutputInterface $output)

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

 из Command
int execute(InputInterface $input, OutputInterface $output)

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

 из Command
bool isHidden()

{@inheritdoc}

 из Command
Command setHidden(bool $hidden)

{@inheritdoc}

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
bool confirmToProceed(string $warning = 'Application In Production!', Closure|bool|null $callback = null)

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

 из ConfirmableTrait
Closure getDefaultConfirmCallback()

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

 из ConfirmableTrait
int handle()

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

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

Удалить все представления базы данных.
void dropAllTypes(string $database)

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

Details

abstract protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string $command

Return Value

Command

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Параметры

Command|string $command
array $arguments

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

int

int callSilently(Command|string $command, array $arguments = [])

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

Параметры

Command|string $command
array $arguments

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

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

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

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

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

array

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

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

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

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|callable $choices, string|null $default = null)

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

Параметры

string $question
array|callable $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array|callable $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

void

смешанный|пустое значение withProgressBar(последовательность|целое число $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, одновременно продвигая индикатор прогресса.

Параметры

последовательность|целое число $totalSteps
Closure $callback

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

смешанный|пустое значение

пустое значение info(строка $string, целое число|строка|нулевое значение $verbosity = null)

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

Параметры

строка $string
целое число|строка|нулевое значение $verbosity

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

пустое значение

пустое значение line(строка $string, строка|нулевое значение $style = null, целое число|строка|нулевое значение $verbosity = null)

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

Параметры

строка $string
строка|нулевое значение $style
целое число|строка|нулевое значение $verbosity

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

пустое значение

пустое значение comment(строка $string, целое число|строка|нулевое значение $verbosity = null)

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

Параметры

строка $string
целое число|строка|нулевое значение $verbosity

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

пустое значение

пустое значение question(строка $string, целое число|строка|нулевое значение $verbosity = null)

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

Параметры

строка $string
целое число|строка|нулевое значение $verbosity

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

пустое значение

пустое значение error(строка $string, целое число|строка|нулевое значение $verbosity = null)

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

Параметры

строка $string
целое число|строка|нулевое значение $verbosity

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

пустое значение

пустое значение warn(строка $string, целое число|строка|нулевое значение $verbosity = null)

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

Параметры

строка $string
целое число|строка|нулевое значение $verbosity

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

пустое значение

пустое значение alert(строка $string)

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

Параметры

строка $string

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

пустое значение

пустое значение newLine(целое число $count = 1)

Вставить пустую строку.

Параметры

целое число $count

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

пустое значение

пустое значение setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface $input

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

пустое значение

пустое значение setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle $output

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

пустое значение

protected пустое значение setVerbosity(строка|целое число $level)

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

Параметры

строка|целое число $level

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

пустое значение

protected целое число parseVerbosity(строка|целое число|нулевое значение $level = null)

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

Параметры

строка|целое число|нулевое значение $level

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

целое число

OutputStyle getOutput()

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

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

OutputStyle

static пустое значение macro(строка $name, объект|вызываемый $macro)

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

Параметры

строка $name
объект|вызываемый $macro

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

пустое значение

static пустое значение mixin(объект $mixin, логическое значение $replace = true)

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

Параметры

объект $mixin
логическое значение $replace

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

пустое значение

Исключения

ReflectionException

static логическое значение hasMacro(строка $name)

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

Параметры

строка $name

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

логическое значение

static пустое значение flushMacros()

Очистить существующие макросы.

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

пустое значение

static смешанный __callStatic(строка $method, массив $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

смешанный __call(строка $method, массив $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException
END_OF_DOCUMENT_MARKER

void __construct()

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

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

void

protected void configureUsingFluentDefinition()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

protected int execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden)

{@inheritdoc}

Параметры

bool $hidden

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

Command

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

bool confirmToProceed(string $warning = 'Application In Production!', Closure|bool|null $callback = null)

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

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

Параметры

string $warning
Closure|bool|null $callback

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

bool

protected Closure getDefaultConfirmCallback()

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

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

Closure

int handle()

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

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

int

protected void dropAllTables(string $database)

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

Параметры

string $database

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

void

protected void dropAllViews(string $database)

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

Параметры

string $database

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

void

protected void dropAllTypes(string $database)

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

Параметры

string $database

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

void

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

Spec-Zone.ru

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