Spec-Zone.ru › Laravel 5.8

ScheduleRunCommand

class ScheduleRunCommand 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's OutputInterface. from Command
protected Schedule $schedule Экземпляр планировщика.
protected $startedAt Отметка времени начала работы команды планировщика (24-часовой формат).
protected bool $eventsRan Флаг, указывающий, были ли запущены какие-либо события.

Методы

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(Schedule $schedule)

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

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

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

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|bool|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|null $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)

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

из Команды
void setVerbosity(string|int $level)

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

из Команды
int parseVerbosity(string|int|null $level = null)

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

из Команды
isHidden()

{@inheritdoc}

из Команды
setHidden($hidden)

{@inheritdoc}

из Команды
array getArguments()

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

из Команды
array getOptions()

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

из Команды
OutputStyle getOutput()

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

из Команды
Application getLaravel()

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

из Команды
void setLaravel(Container $laravel)

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

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

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

void runSingleServerEvent(Event $event)

Выполнить заданное событие single server.

void runEvent(Event $event)

Выполнить заданное событие.

Подробности

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(Schedule $schedule)

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

Parameters

Schedule $schedule

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
END_OF_DOCUMENT_MARKER

protected array context()

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

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

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

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 void runSingleServerEvent(Event $event)

Выполнить заданное событие сервера.

Параметры

Event $event

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

void

protected void runEvent(Event $event)

Выполнить заданное событие.

Параметры

Event $event

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

void

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

Spec-Zone.ru

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