Spec-Zone.ru › Laravel 7

FreshCommand

класс FreshCommand расширяет Command (View source)

Трейты

ConfirmableTrait
CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

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

 из InteractsWithIO
protected OutputStyle $output

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

 из InteractsWithIO
protected int $verbosity

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

 из InteractsWithIO
protected array $verbosityMap

Сопоставление уровней подробности, понятных человеку, и уровней Symfony's OutputInterface.

 из InteractsWithIO
static protected array $macros

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

 из Macroable
protected Application $laravel

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

 из Command
protected string $signature

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

 из Command
protected string $name

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

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

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

 из Command
protected bool $hidden

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

 из Command

Методы

Команда resolveCommand(Команда|строка $command)

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

 из CallsCommands
int call(Команда|строка $command, массив $arguments = [])

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

 из CallsCommands
int callSilent(Команда|строка $command, массив $arguments = [])

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

 из CallsCommands
int runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

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

 из CallsCommands
ArrayInput createInputFromArguments(массив $arguments)

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

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

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

 из CallsCommands
void specifyParameters()

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

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

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

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

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

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

 из InteractsWithIO
строка|массив|null argument(строка|null $key = null)

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

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

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

 из InteractsWithIO
bool hasOption(строка $name)

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

 из InteractsWithIO
строка|массив|bool|null option(строка|null $key = null)

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

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

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

 из InteractsWithIO
bool confirm(строка $question, bool $default = false)

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

 из InteractsWithIO
mixed ask(строка $question, строка|null $default = null)

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

 из InteractsWithIO
mixed anticipate(строка $question, массив|вызов $choices, строка|null $default = null)

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

 из InteractsWithIO
mixed askWithCompletion(строка $question, массив|вызов $choices, строка|null $default = null)

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

 из InteractsWithIO
mixed secret(строка $question, bool $fallback = true)

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

 из InteractsWithIO
строка|массив choice(строка $question, массив $choices, строка|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

 из InteractsWithIO
void table(массив $headers, Arrayable|массив $rows, строка $tableStyle = 'default', массив $columnStyles = [])

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

 из InteractsWithIO
void info(строка $string, int|строка|null $verbosity = null)

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

 из InteractsWithIO
void line(строка $string, строка|null $style = null, int|строка|null $verbosity = null)

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

 из InteractsWithIO
void comment(строка $string, int|строка|null $verbosity = null)

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

 из InteractsWithIO
void question(строка $string, int|строка|null $verbosity = null)

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

 из InteractsWithIO
void error(строка $string, int|строка|null $verbosity = null)

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

 из InteractsWithIO
void warn(строка $string, int|строка|null $verbosity = null)

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

 из InteractsWithIO
void alert(строка $string)

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

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

{@inheritdoc}

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

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

Определить, запросил ли разработчик посев базы данных.
void runSeeder(string $database)

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

Подробности

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

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

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

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

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

void setInput(InputInterface $input)

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

Parameters

InputInterface $input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle $output

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

OutputStyle getOutput()

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

Return Value

OutputStyle

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

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

isHidden()

{@inheritdoc}

setHidden(bool $hidden)

{@inheritdoc}

Parameters

bool $hidden

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container $laravel

Return Value

void

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

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

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

Parameters

string $warning
Closure|bool|null $callback

Return Value

bool

protected Closure getDefaultConfirmCallback()

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

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

Closure

int handle()

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

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

int

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/7.x/Illuminate/Database/Console/Migrations/FreshCommand.html

Spec-Zone.ru

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