Spec-Zone.ru › Laravel 5.6

UpCommand

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

Методы

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

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

из Macroable
static void mixin(object $mixin)

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

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

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

из Command
int run(InputInterface $input, OutputInterface $output)

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

из Command
mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

из Command
ArrayInput createInputFromArguments(array $arguments)

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

из Command
bool hasArgument(string|int $name)

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

из Command
string|array argument(string|null $key = null)

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

из Command
array arguments()

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

из Command
bool hasOption(string $name)

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

из Command
string|array option(string $key = null)

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

из Command
array options()

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

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

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

из Command
string ask(string $question, string $default = null)

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

из Command
string anticipate(string $question, array $choices, string $default = null)

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

из Command
string askWithCompletion(string $question, array $choices, string $default = null)

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

из Command
string secret(string $question, bool $fallback = true)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Command
void alert(string $string)

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

from Command
void setVerbosity(string|int $level)

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

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

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

from Command
array getArguments()

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

from Command
array getOptions()

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

from Command
OutputInterface getOutput()

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

from Command
Application getLaravel()

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

from Command
void setLaravel(Container $laravel)

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

from Command
void handle()

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

Details

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

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

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Включить другой объект в класс.

Parameters

object $mixin

Return Value

void

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

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

bool hasArgument(string|int $name)

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

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string $name

Return Value

bool

string|array option(string $key = null)

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

Parameters

string $key

Return Value

string|array

array options()

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

Return Value

array

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

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

Parameters

string $question
bool $default

Return Value

bool

string ask(string $question, string $default = null)

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

Parameters

string $question
string $default

Return Value

string

string anticipate(string $question, array $choices, string $default = null)

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

Parameters

string $question
array $choices
string $default

Return Value

string

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

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

Parameters

string $question
array $choices
string $default

Return Value

string

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

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

Parameters

string $question
bool $fallback

Return Value

string

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

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

Parameters

string $question
array $choices
string $default
mixed $attempts
bool $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, null|int|string $verbosity = null)

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

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

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

Parameters

string $string
string $style
null|int|string $verbosity

Return Value

void

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

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

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

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

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

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

Parameters

string $string
null|int|string $verbosity

Return Value

void

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

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

Parameters

string $string
null|int|string $verbosity

Return Value

void

void alert(string $string)

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

Parameters

string $string

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int $level

Return Value

void

protected int parseVerbosity(string|int $level = null)

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

Parameters

string|int $level

Return Value

int

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Значение результата

array

OutputInterface getOutput()

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

Значение результата

OutputInterface

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

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

Значение результата

Приложение

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

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

Параметры

Контейнер $laravel

Значение результата

void

void handle()

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

Значение результата

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Foundation/Console/UpCommand.html

Spec-Zone.ru

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