BaseCommand

class BaseCommand extends Command (View source)

Трейты

Свойства

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

Методы

Команда	resolveCommand(Command\|string $command) Разрешить экземпляр консольной команды для данной команды.	из CallsCommands
int	call(Command\|string $command, array $arguments = []) Вызвать другую консольную команду.	из CallsCommands
int	callSilent(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	из CallsCommands
int	runCommand(Command\|string $command, array $arguments, OutputInterface $output) Выполнить заданную консольную команду.	из CallsCommands
ArrayInput	createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов.	из CallsCommands
array	context() Получить весь контекст, переданный команде.	из CallsCommands
void	specifyParameters() Указать аргументы и опции в команде.	из HasParameters
array	getArguments() Получить аргументы консольной команды.	из HasParameters
array	getOptions() Получить опции консольной команды.	из HasParameters
bool	hasArgument(string\|int $name) Определить, присутствует ли данный аргумент.	из InteractsWithIO
string\|array\|null	argument(string\|null $key = null) Получить значение аргумента команды.	из InteractsWithIO
array	arguments() Получить все аргументы, переданные команде.	из InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли данная опция.	из InteractsWithIO
string\|array\|bool\|null	option(string\|null $key = null) Получить значение опции команды.	из InteractsWithIO
array	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\|null $multiple = null) Предложить пользователю выбрать один вариант из списка ответов.	из InteractsWithIO
void	table(array $headers, Arrayable\|array $rows, string $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу.	из 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	setInput(InputInterface $input) Установить реализацию интерфейса ввода.	from InteractsWithIO
void	setOutput(OutputStyle $output) Установить реализацию интерфейса вывода.	from InteractsWithIO
void	setVerbosity(string\|int $level) Установить уровень подробности.	from InteractsWithIO
int	parseVerbosity(string\|int\|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony.	from InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	from InteractsWithIO
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	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
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	from Command
mixed	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	from Command
isHidden() {@inheritdoc}	from Command
setHidden($hidden) {@inheritdoc}	from Command
Application	getLaravel() Получить экземпляр приложения Laravel.	from Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	from Command
array	getMigrationPaths() Получить все пути миграций.
bool	usingRealPath() Определить, являются ли заданные пути разрешенными "реальными" путями.
string	getMigrationPath() Получить путь к каталогу миграций.

Подробности

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

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

Return Value

void

protected array getArguments()

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

Return Value

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

END_OF_DOCUMENT_MARKER

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.

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

mixed

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Параметры

$hidden

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container

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