Spec-Zone.ru › Laravel 5.7

BaseCommand

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

Свойства

Macroable

Свойства

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 Имя командной строки. from Command
protected string $description Описание командной строки. from Command
protected bool $hidden Указывает, следует ли отображать команду в списке команд Artisan. from Command
protected int $verbosity Уровень подробности вывода команд по умолчанию. from Command
protected array $verbosityMap Сопоставление удобочитаемых уровней подробности и OutputInterface Symfony. from Command

Методы

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

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

 from Command
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.

 из Команда
массив getMigrationPaths()

Получить все пути миграций.
bool usingRealPath()

Определить, являются ли заданные пути предварительно разрешёнными «реальными» путями.
строка getMigrationPath()

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

Подробности

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

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

Параметры

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

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

void

static void mixin(object $mixin)

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

Параметры

объект $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()

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

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

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

Вывод getOutput()

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

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

Вывод

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

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

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

Приложение

void setLaravel(Контейнер $laravel)

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

Параметры

Контейнер $laravel

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

void

protected array getMigrationPaths()

Получить все пути миграций.

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

array

protected bool usingRealPath()

Определить, являются ли заданные путь(и) предопределенными "реальными" путями.

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

bool

protected string getMigrationPath()

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

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

string

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

Spec-Zone.ru

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