TranslationUpdateCommand

static строка|null getDefaultName()

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

строка|null

Имя команды по умолчанию или null, если имя по умолчанию не задано

__construct(TranslationWriterInterface $writer = null, TranslationReaderInterface $reader = null, ExtractorInterface $extractor = null, string $defaultLocale = null, string $defaultTransPath = null, string $defaultViewsPath = null)

Параметры

TranslationWriterInterface	$writer
TranslationReaderInterface	$reader
ExtractorInterface	$extractor
строка	$defaultLocale
строка	$defaultTransPath
строка	$defaultViewsPath

ignoreValidationErrors()

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

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

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	Код выхода команды

Исключения

Исключение

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

См. также

setCode()
execute()

$this setCode(callable $code)

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

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

Параметры

callable

$code

callable(InputInterface $input, OutputInterface $output)

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

$this

Исключения

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

См. также

execute()

mergeApplicationDefinition(bool $mergeArgs = true)

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

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

Параметры

bool

$mergeArgs

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

$this setDefinition(array|InputDefinition $definition)

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

Параметры

массив|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)

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

$this setName(string $name)

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

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

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

Параметры

строка

$name

Имя команды

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

$this

Исключения

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

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

$this setProcessTitle(string $title)

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

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

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

Параметры

строка

$title

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

Значение возвращаемого значения

$this

строка getName()

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

Значение возвращаемого значения

строка

Имя команды

Команда setHidden(bool $hidden)

Параметры

bool

$hidden

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

Значение возвращаемого значения

Команда

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

bool isHidden()

Значение возвращаемого значения

bool	Указывается, должна ли команда отображаться публично

$this setDescription(string $description)

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

Параметры

строка

$description

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

Значение возвращаемого значения

$this

строка getDescription()

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

Значение возвращаемого значения

строка

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

$this setHelp(string $help)

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

Параметры

строка

$help

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

Значение возвращаемого значения

$this

строка getHelp()

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

Значение возвращаемого значения

строка

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

строка getProcessedHelp()

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

Значение возвращаемого значения

строка

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

$this setAliases(string[] $aliases)

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

Параметры

строка[]

$aliases

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

Значение возвращаемого значения

$this

Исключения

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

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

массив getAliases()

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

Значение возвращаемого значения

массив

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

строка getSynopsis(bool $short = false)

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

Параметры

bool

$short

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

Значение возвращаемого значения

строка

Сводка

$this addUsage(string $usage)

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

Параметры

строка

$usage

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

Значение возвращаемого значения

$this

массив getUsages()

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

Значение возвращаемого значения

массив

смешанный getHelper(string $name)

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

Параметры

строка

$name

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

Значение возвращаемого значения

смешанный

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

Исключения

ЛогическаяОшибка	если HelperSet не определен
ИсключениеНеверногоАргумента	если помощник не определен

setContainer(ИнтерфейсКонтейнера $container = null)

Параметры

ИнтерфейсКонтейнера

$container