Spec-Zone.ru › Laravel 8

PruneCommand

class PruneCommand extends Команда (Просмотреть исходный код)

Трейты

ВыполнениеКоманд
ИмеетПараметры
ВзаимодействиеСВводомВыводом
Макрообъект

Свойства

protected InputInterface $input

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

 из ВзаимодействиеСВводомВыводом
protected СтильВывода $output

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

 из ВзаимодействиеСВводомВыводом
protected int $verbosity

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

 из ВзаимодействиеСВводомВыводом
protected array $verbosityMap

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

 из ВзаимодействиеСВводомВыводом
static protected array $macros

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

 из Макрообъект
protected Приложение $laravel

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

 из Команда
protected string $signature

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

Имя команды консоли.

 из Команда
protected string $description

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

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

 из Команда
protected bool $hidden

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

 из Команда

Методы

Команда 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()

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

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

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

 из 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
void handle(Dispatcher $events)

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

Определить модели, которые должны быть удалены.
string getDefaultPath()

Получить путь по умолчанию, где находятся модели.
bool isPrunable(string $model)

Определить, может ли данный класс модели быть удалён.
void pretendToPrune(string $model)

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

Подробности

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 = [])

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

Parameters

Command|string $command
array $arguments

Return Value

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

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

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

Параметры

iterable|int $totalSteps
Closure $callback

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

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

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

Параметры

string $string
int|string|null $verbosity

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

void

void alert(string $string)

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

Параметры

string $string

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

void

void newLine(int $count = 1)

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

Параметры

int $count

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

void

void setInput(InputInterface $input)

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

Параметры

InputInterface $input

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

void

void setOutput(OutputStyle $output)

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

Параметры

OutputStyle $output

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

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

OutputStyle getOutput()

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

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

OutputStyle

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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
END_OF_DOCUMENT_MARKER

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

void handle(Dispatcher $events)

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

Параметры

Dispatcher $events

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

void

protected Collection models()

Определить модели, которые должны быть удалены.

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

Collection

protected string getDefaultPath()

Получить путь по умолчанию, где находятся модели.

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

string

protected bool isPrunable(string $model)

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

Параметры

string $model

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

bool

protected void pretendToPrune(string $model)

Показать, сколько моделей будет удалено.

Параметры

string $model

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

void

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

Spec-Zone.ru

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