Spec-Zone.ru › Laravel 5.6

ServeCommand

class ServeCommand 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 Сопоставление удобочитаемых уровней детализации с уровнями 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
string ask(string $question, string|null $default = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from Command
void warn(string $string, null|int|string $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()

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

OutputInterface getOutput()

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

from Command
Application getLaravel()

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

from Command
void setLaravel(Container $laravel)

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

from Command
int handle()

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

string serverCommand()

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

string host()

Получить хост для команды.

string port()

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

Подробности

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

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.

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

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

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

Параметры

string $question
string|null $default

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

string

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

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

Параметры

string $question
array $choices
string|null $default

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

string

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

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

Параметры

string $question
array $choices
string|null $default

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

string

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

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

Параметры

string $question
bool $fallback

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

string

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

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

Параметры

string $string
null|int|string $verbosity

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

void

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

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

Параметры

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

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

void

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

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

Параметры

string $string
null|int|string $verbosity

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

void

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

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

Параметры

string $string
null|int|string $verbosity

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

void

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

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

Параметры

string $string
null|int|string $verbosity

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

void

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

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

Параметры

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

OutputInterface getOutput()

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

Значение, возвращаемое функцией

OutputInterface

Application getLaravel()

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

Значение, возвращаемое функцией

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

Значение, возвращаемое функцией

void

int handle()

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

Значение, возвращаемое функцией

int

Исключения

Exception

protected string serverCommand()

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

Значение, возвращаемое функцией

string

protected string host()

Получить хост для команды.

Значение, возвращаемое функцией

string

protected string port()

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

Значение, возвращаемое функцией

string

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

Spec-Zone.ru

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