Spec-Zone.ru › Laravel 5.7

TableCommand

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

Особенности

Macroable

Свойства

static protected array $macros Зарегистрированные макросы строк. from Macroable
protected Application $laravel Экземпляр приложения Laravel. from Команда
protected InputInterface $input Реализация интерфейса ввода. from Команда
protected OutputStyle $output Реализация интерфейса вывода. from Команда
protected string $signature Имя и сигнатура командной строки. from Команда
protected string $name Имя команды консоли.
protected string $description Описание команды консоли.
protected bool $hidden Указывает, следует ли показывать команду в списке команд Artisan. from Команда
protected int $verbosity Уровень детализации вывода по умолчанию. from Команда
protected array $verbosityMap Сопоставление удобочитаемых уровней детализации с уровнями OutputInterface Symfony. from Команда
protected Filesystem $files Экземпляр файловой системы.
protected Composer $composer

Методы

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

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

 from Macroable
static void mixin(object $mixin)

Смешать другой объект в класс.

 from Macroable
static bool hasMacro(string $name)

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

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

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

 from Macroable
mixed __call(string $method, array $parameters)

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

 from Macroable
void __construct(Filesystem $files, Composer $composer)

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

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

 from Command
void specifyParameters()

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

 from Command
int run(InputInterface $input, OutputInterface $output)

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

 from Command
mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

 from Command
ArrayInput createInputFromArguments(array $arguments)

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

 from Command
bool hasArgument(string|int $name)

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

 from Command
string|array|null argument(string|null $key = null)

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

 from Command
array arguments()

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

 from Command
bool hasOption(string $name)

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

 from Command
string|array|null option(string|null $key = null)

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

 from Command
array options()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 from Command
void comment(string $string, int|string|null $verbosity = null)

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

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

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

 from Command
void error(string $string, int|string|null $verbosity = null)

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

 from Command
void warn(string $string, int|string|null $verbosity = null)

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

 from Command
void alert(string $string)

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

 from Command
void setVerbosity(string|int $level)

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

 from Command
int parseVerbosity(string|int|null $level = null)

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

 from Command
array getArguments()

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

 from Command
array getOptions()

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

 from Command
OutputStyle getOutput()

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

 from Command
Приложение getLaravel()

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

 из Команда
void setLaravel(Контейнер $laravel)

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

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

Выполнить консольную команду.
string createBaseMigration(string $table = 'jobs')

Создать базовый файл миграции для таблицы.
void replaceMigration(string $path, string $table, string $tableClassName)

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

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin)

Смешать другой объект в класс.

Параметры

object $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

Filesystem $files
Composer $composer

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

void

protected void configureUsingFluentDefinition()

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

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

void

protected void specifyParameters()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

mixed

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

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

Параметры

string $command
array $arguments

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

int

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

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

Параметры

string $command
array $arguments

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

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|null option(string|null $key = null)

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

Параметры

string|null $key

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

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string

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 $style = null, int|string|null $verbosity = null)

Записать строку как стандартный вывод.

Параметры

string $string
string $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

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

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.7/Illuminate/Queue/Console/TableCommand.html

Spec-Zone.ru

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