TranslationUpdateCommand

__construct(string|null $name = null)

Конструктор.

Параметры

string|null

$name

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

Исключения

LogicException

Когда имя команды пустое

ignoreValidationErrors()

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

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

setApplication(Application $application = null)

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

Параметры

Application

$application

Экземпляр Application

setHelperSet(HelperSet $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	Экземпляр InputInterface
OutputInterface	$output	Экземпляр OutputInterface

Значение возврата

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

Исключения

Exception

См. также

setCode()
execute()

Command setCode(callable $code)

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

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

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

Значение возврата

Command

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

Исключения

InvalidArgumentException

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

Этот метод не является частью публичного API и не должен использоваться напрямую.

Параметры

bool

$mergeArgs

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

Command setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

Значение возврата

Command

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

InputDefinition getDefinition()

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

Значение возврата

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

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

Этот метод не является частью публичного API и не должен использоваться напрямую.

Значение возврата

InputDefinition

Экземпляр InputDefinition

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

Значение возврата

Command

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

Command 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_REQUIRED или InputOption::VALUE_NONE)

Значение возврата

Command

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

Command setName(string $name)

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

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

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

Параметры

string

$name

Имя команды

Значение возврата

Command

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

Исключения

InvalidArgumentException

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

Command setProcessTitle(string $title)

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

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

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

Параметры

string

$title

Название процесса

Результат

Команда

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

string getName()

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

Результат

string

Имя команды

Команда setDescription(string $description)

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

Параметры

string

$description

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

Результат

Команда

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

string getDescription()

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

Результат

string

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

Команда setHelp(string $help)

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

Параметры

string

$help

Справка по команде

Результат

Команда

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

string getHelp()

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

Результат

string

Справка по команде

string getProcessedHelp()

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

Результат

string

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

Команда setAliases(string[] $aliases)

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

Параметры

string[]

$aliases

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

Результат

Команда

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

Исключения

Исключение некорректного аргумента

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

array getAliases()

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

Результат

array

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

string getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

Результат

string

Синопсис

addUsage(string $usage)

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

Параметры

string

$usage

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

array getUsages()

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

Результат

array

mixed getHelper(string $name)

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

Параметры

string

$name

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

Результат

mixed

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

Исключения

Исключение некорректного аргумента

если помощник не определен

string asText() ^{устарело}

^{устарело}

since версия 2.3, будет удалено в 3.0.

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

Результат

string

Строковое представление команды

string|DOMDocument asXml(bool $asDom = false) ^{устарело}

^{устарело}

since версия 2.3, будет удалено в 3.0.

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

Параметры

bool

$asDom

Возвращать DOM или строку XML

Результат

string|DOMDocument

XML-строка, представляющая команду

setContainer(ContainerInterface $container = null)

Устанавливает контейнер.

Параметры

ContainerInterface

$container

Экземпляр ContainerInterface или null