ServerLogCommand

__construct(string|null $name = null)

Параметры

string|null

$name

Имя команды; передача null означает, что оно должно быть задано в configure()

Исключения

LogicException

При пустом имени команды

ignoreValidationErrors()

Игнорирует ошибки валидации.

Это в основном полезно для команды help.

setApplication(Application $application = null)

Параметры

Application

$application

setHelperSet(HelperSet $helperSet)

Параметры

HelperSet

$helperSet

HelperSet getHelperSet()

Получает набор помощников.

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

HelperSet

Экземпляр HelperSet

Application getApplication()

Получает экземпляр приложения для данной команды.

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

Application

Экземпляр Application

bool isEnabled()

Проверяет, включена ли команда в текущей среде.

Переопределите этот метод, чтобы проверить x или y и вернуть false, если команда не может работать должным образом в текущих условиях.

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

bool

int run(InputInterface $input, OutputInterface $output)

Выполняет команду.

Код для выполнения либо определяется непосредственно методом setCode(), либо путём переопределения метода execute() в подклассе.

Параметры

InputInterface	$input
OutputInterface	$output

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

int	Код выхода команды

Исключения

Exception

При сбое привязки входных данных. Можно обойти это, вызвав {@link ignoreValidationErrors()}.

См. также

setCode()
execute()

$this setCode(callable $code)

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

Если используется этот метод, он переопределяет код, определённый в методе execute().

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

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

$this

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

Объединяет определение приложения с определением команды.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

Объединять ли аргументы определения Application с аргументами определения Command

$this setDefinition(array|InputDefinition $definition)

Устанавливает массив экземпляров аргументов и опций.

Параметры

array|InputDefinition

$definition

Массив экземпляров аргументов и опций или экземпляр определения

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

$this

InputDefinition getDefinition()

Получает InputDefinition, прикреплённый к этой команде.

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

Можно переопределить, чтобы предоставить исходное представление команды, когда иначе оно будет изменено путём объединения с InputDefinition приложения.

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

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

InputDefinition

Экземпляр InputDefinition

$this addArgument(string $name, int $mode = null, string $description = '', mixed $default = null)

Добавляет аргумент.

Параметры

string	$name	Имя аргумента
int	$mode	Режим аргумента: InputArgument::REQUIRED или InputArgument::OPTIONAL
string	$description	Текст описания
mixed	$default	Значение по умолчанию (только для режима InputArgument::OPTIONAL)

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

$this

$this addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', mixed $default = null)

Добавляет опцию.

Параметры

string	$name	Имя опции
string	$shortcut	Сокращение (может быть null)
int	$mode	Режим опции: одно из констант InputOption::VALUE_*
string	$description	Текст описания
mixed	$default	Значение по умолчанию (должно быть null для InputOption::VALUE_NONE)

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

$this

$this setName(string $name)

Устанавливает имя команды.

Этот метод может установить как имя, так и пространство имён, если вы разделите их двоеточием (:)

$command->setName('foo:bar');

Параметры

string

$name

Имя команды

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

$this

Исключения

InvalidArgumentException

При некорректном имени

$this setProcessTitle(string $title)

Устанавливает заголовок процесса команды.

Эта функция должна использоваться только при создании команд длительного процесса, например, демона.

Требуется PHP 5.5+ или библиотека proctitle PECL.

Параметры

string

$title

Заголовок процесса

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

$this

string getName()

Возвращает имя команды.

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

string

Имя команды

Command setHidden(bool $hidden)

Параметры

bool

$hidden

Скрывать ли команду из списка команд

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

Command

Текущий экземпляр

bool isHidden()

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

bool	скрывать ли команду публично

$this setDescription(string $description)

Устанавливает описание команды.

Параметры

string

$description

Описание команды

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

$this

string getDescription()

Возвращает описание команды.

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

string

Описание команды

$this setHelp(string $help)

Устанавливает справку для команды.

Параметры

string

$help

Справка для команды

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

$this

string getHelp()

Возвращает справку для команды.

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

string

Справка для команды

string getProcessedHelp()

Возвращает обработанную справку для команды, заменяя шаблоны %command.name% и %command.full_name% реальными значениями динамически.

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

string

Обработанная справка для команды

$this setAliases(string[] $aliases)

Устанавливает псевдонимы для команды.

Параметры

string[]

$aliases

Массив псевдонимов для команды

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

$this

Исключения

InvalidArgumentException

При некорректном псевдониме

array getAliases()

Возвращает псевдонимы для команды.

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

array

Массив псевдонимов для команды

string getSynopsis(bool $short = false)

Возвращает синопсис для команды.

Параметры

bool

$short

Показывать короткую версию синопсиса (с опциями сложенными) или нет

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

string

Синопсис

$this addUsage(string $usage)

Добавляет пример использования команды.

Параметры

string

$usage

Использование, будет добавлено с именем команды в префиксе

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

$this

array getUsages()

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

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

array

mixed getHelper(string $name)

Получает экземпляр помощника по имени.

Параметры

string

$name

Имя помощника

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

mixed

Значение помощника

Исключения

LogicException	если нет заданного HelperSet
InvalidArgumentException	если помощник не определён