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

При ошибке привязки входных данных. Пропустите это, вызвав {@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

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

$this setDefinition(array|InputDefinition $definition)

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

Параметры

array|InputDefinition

$definition

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

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

$this

InputDefinition getDefinition()

Возвращает InputDefinition, присоединённый к этой команде.

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

InputDefinition

Экземпляр InputDefinition

InputDefinition getNativeDefinition()

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

Можно переопределить, чтобы предоставить исходное представление команды, когда в противном случае оно будет изменено путём объединения с 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

Имя команды

$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	если помощник не определен

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