Spec-Zone.ru › Laravel 5.8

TableCommand

class TableCommand extends Command (View source)

Свойства

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
protected Filesystem $files Экземпляр файловой системы.
protected Composer $composer

Traits

Macroable

Методы

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(Filesystem $files, Composer $composer)

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

void configureUsingFluentDefinition()

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

из Команда
void specifyParameters()

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

из Команда
int run(InputInterface $input, OutputInterface $output)

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

из Команда
mixed execute(InputInterface $input, OutputInterface $output)

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

из Команда
int call(string $command, array $arguments = [])

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

из Команда
int callSilent(string $command, array $arguments = [])

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

из Команда
ArrayInput createInputFromArguments(array $arguments)

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

из Команда
array context()

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

из Команда
bool hasArgument(string|int $name)

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

из Команда
string|array|null argument(string|null $key = null)

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

из Команда
array arguments()

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

из Команда
bool hasOption(string $name)

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

из Команда
string|array|bool|null option(string|null $key = null)

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

из Команда
array options()

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

из Команда
bool confirm(string $question, bool $default = false)

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

из Команда
mixed ask(string $question, string|null $default = null)

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

из Команда
mixed anticipate(string $question, array $choices, string|null $default = null)

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

из Команда
mixed askWithCompletion(string $question, array $choices, string|null $default = null)

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

из Команда
mixed secret(string $question, bool $fallback = true)

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

из Команда
string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

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

из Команда
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

из Команда
void info(string $string, int|string|null $verbosity = null)

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

из Команда
void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

из Команда
void comment(string $string, int|string|null $verbosity = null)

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

из Команда
void question(string $string, int|string|null $verbosity = null)

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

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

{@inheritdoc}

из Command
setHidden($hidden)

{@inheritdoc}

из Command
array getArguments()

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

из Command
array getOptions()

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

из Command
OutputStyle getOutput()

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

из Command
Application getLaravel()

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

из Command
void setLaravel(Container $laravel)

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

из Command
void handle()

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

string createBaseMigration(string $table = 'jobs')

Создать файл базовой миграции для таблицы.

void replaceMigration(string $path, string $table, string $tableClassName)

Заменить сгенерированную миграцию на шаблон таблицы очереди задач.

Подробности

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(Filesystem $files, Composer $composer)

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

Parameters

Filesystem $files
Composer $composer

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)

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

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)

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

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

void handle()

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

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

void

protected string createBaseMigration(string $table = 'jobs')

Создать базовый файл миграции для таблицы.

Параметры

string $table

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

string

protected void replaceMigration(string $path, string $table, string $tableClassName)

Заменить сгенерированную миграцию на шаблон таблицы заданий.

Параметры

string $path
string $table
string $tableClassName

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

void

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

Spec-Zone.ru

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