TranslationDebugCommand
class TranslationDebugCommand extends Command
Помогает найти неиспользуемые или отсутствующие сообщения перевода в заданном языке и сравнить их с резервными.
Константы
| MESSAGE_MISSING | |
| MESSAGE_UNUSED | |
| MESSAGE_EQUALS_FALLBACK |
Свойства
| статический защищенный | $defaultName |
Методы
| статический string|null | getDefaultName() | из Command |
| __construct(TranslatorInterface $translator, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultTransPath = null, string $defaultViewsPath = null) | ||
| ignoreValidationErrors() Игнорирует ошибки валидации. | из Command | |
| setApplication(Application $application = null) | из Command | |
| setHelperSet(HelperSet $helperSet) | из Command | |
| HelperSet | getHelperSet() Получает набор помощников. | из Command |
| Application | getApplication() Получает экземпляр приложения для данной команды. | из Command |
| bool | isEnabled() Проверяет, включена ли команда в текущей среде. | из Command |
| configure() Настраивает текущую команду. | ||
| int|null | execute(InputInterface $input, OutputInterface $output) Выполняет текущую команду. | |
| interact(InputInterface $input, OutputInterface $output) Взаимодействует с пользователем. | из Command | |
| initialize(InputInterface $input, OutputInterface $output) Инициализирует команду после привязки входных данных и перед валидацией. | из Command | |
| int | run(InputInterface $input, OutputInterface $output) Выполняет команду. | из Command |
| $this | setCode(callable $code) Устанавливает код для выполнения при запуске команды. | из Command |
| mergeApplicationDefinition(bool $mergeArgs = true) Объединяет определение приложения с определением команды. | из Command | |
| $this | setDefinition(array|InputDefinition $definition) Устанавливает массив экземпляров аргументов и опций. | из Command |
| InputDefinition | getDefinition() Получает InputDefinition, прикреплённый к этой команде. | из Command |
| InputDefinition | getNativeDefinition() Получает InputDefinition, используемый для создания представлений этой команды. | из Command |
| $this | addArgument(string $name, int|null $mode = null, string $description = '', string|string[]|null $default = null) Добавляет аргумент. | из Command |
| $this | addOption(string $name, string|array $shortcut = null, int|null $mode = null, string $description = '', string|string[]|bool|null $default = null) Добавляет опцию. | из Command |
| $this | setName(string $name) Устанавливает имя команды. | из Command |
| $this | setProcessTitle(string $title) Устанавливает заголовок процесса команды. | из Command |
| string | getName() Возвращает имя команды. | из Command |
| Command | setHidden(bool $hidden) | из Command |
| bool | isHidden() | из Command |
| $this | setDescription(string $description) Устанавливает описание команды. | из Command |
| string | getDescription() Возвращает описание команды. | из Command |
| $this | setHelp(string $help) Устанавливает справку по команде. | из Command |
| string | getHelp() Возвращает справку по команде. | из Command |
| string | getProcessedHelp() Возвращает обработанную справку по команде, динамически заменяя шаблоны %command.name% и %command.full_name% на реальные значения. | из Command |
| $this | setAliases(string[] $aliases) Устанавливает псевдонимы для команды. | из Command |
| array | getAliases() Возвращает псевдонимы для команды. | из Command |
| строка | getSynopsis(bool $short = false) Возвращает описание команды. | из Command |
| $this | addUsage(string $usage) Добавляет пример использования команды. | из Command |
| массив | getUsages() Возвращает альтернативные способы использования команды. | из Command |
| смешанный тип | getHelper(string $name) Возвращает помощника по имени. | из Command |
Подробности
статический string|null getDefaultName()
Значение возврата
| string|null | Имя команды по умолчанию или null, если имя по умолчанию не задано |
__construct(TranslatorInterface $translator, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultTransPath = null, string $defaultViewsPath = null)
Параметры
| TranslatorInterface | $translator | |
| TranslationReaderInterface | $reader | |
| ExtractorInterface | $extractor | |
| string | $defaultTransPath | |
| string | $defaultViewsPath |
Исключения
| 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 |
protected configure()
Настраивает текущую команду.
protected int|null execute(InputInterface $input, OutputInterface $output)
Выполняет текущую команду.
Этот метод не является абстрактным, потому что вы можете использовать этот класс как конкретный класс. В этом случае вместо определения метода execute() вы устанавливаете код для выполнения, передав лямбда-выражение методу setCode().
Параметры
| InputInterface | $input | |
| OutputInterface | $output |
Значение возврата
| int|null | null или 0, если всё прошло хорошо, или код ошибки |
Исключения
| LogicException | Если этот абстрактный метод не реализован |
protected interact(InputInterface $input, OutputInterface $output)
Взаимодействует с пользователем.
Этот метод выполняется перед проверкой InputDefinition. Это означает, что это единственное место, где команда может интерактивно запросить значения отсутствующих обязательных аргументов.
Параметры
| InputInterface | $input | |
| OutputInterface | $output |
protected initialize(InputInterface $input, OutputInterface $output)
Инициализирует команду после привязки входных данных и перед проверкой входных данных.
Это полезно в основном, когда много команд расширяет одну главную команду, где некоторые вещи должны быть инициализированы на основе аргументов и опций входных данных.
Параметры
| InputInterface | $input | |
| OutputInterface | $output |
См. также
int run(InputInterface $input, OutputInterface $output)
Выполняет команду.
Код для выполнения либо определён непосредственно методом setCode(), либо путём переопределения метода execute() в дочернем классе.
Параметры
| InputInterface | $input | |
| OutputInterface | $output |
Значение возврата
| int | Код выхода команды |
Исключения
| Exception | При ошибке привязки входных данных. Пропустите это, вызвав {@link ignoreValidationErrors()}. |
См. также
$this setCode(callable $code)
Устанавливает код для выполнения при запуске этой команды.
Если этот метод используется, он переопределяет код, определённый в методе execute().
Параметры
| callable | $code | callable(InputInterface $input, OutputInterface $output) |
Значение возврата
| $this |
Исключения
| InvalidArgumentException |
См. также
mergeApplicationDefinition(bool $mergeArgs = true)
Объединяет определение приложения с определением команды.
Этот метод не входит в общедоступный API и не должен использоваться напрямую.
Параметры
| bool | $mergeArgs | Объединять ли аргументы определения приложения с аргументами определения команды |
$this setDefinition(array|InputDefinition $definition)
Устанавливает массив экземпляров аргументов и опций.
Параметры
| array|InputDefinition | $definition | Массив экземпляров аргументов и опций или экземпляр определения |
Значение возврата
| $this |
InputDefinition getDefinition()
Получает InputDefinition, прикреплённый к этой команде.
Значение возврата
| InputDefinition | Экземпляр InputDefinition |
InputDefinition getNativeDefinition()
Получает InputDefinition, используемую для создания представлений этого Command.
Можно переопределить, чтобы предоставить оригинальное представление команды, когда оно иначе изменяется при слиянии с InputDefinition приложения.
Этот метод не является частью публичного API и не должен использоваться напрямую.
Возвращаемое значение
| InputDefinition | Экземпляр InputDefinition |
$this addArgument(string $name, int|null $mode = null, string $description = '', string|string[]|null $default = null)
Добавляет аргумент.
Параметры
| string | $name | Имя аргумента |
| int|null | $mode | Режим аргумента: self::REQUIRED или self::OPTIONAL |
| string | $description | Текст описания |
| string|string[]|null | $default | Значение по умолчанию (только для режима self::OPTIONAL) |
Возвращаемое значение
| $this |
Исключения
| InvalidArgumentException | При неверном режиме аргумента |
$this addOption(string $name, string|array $shortcut = null, int|null $mode = null, string $description = '', string|string[]|bool|null $default = null)
Добавляет опцию.
Параметры
| string | $name | Имя опции |
| string|array | $shortcut | Сокращения, может быть null, строка сокращений, разделенных |, или массив сокращений |
| int|null | $mode | Режим опции: Один из констант VALUE_* |
| string | $description | Текст описания |
| string|string[]|bool|null | $default | Значение по умолчанию (должно быть null для self::VALUE_NONE) |
Возвращаемое значение
| $this |
Исключения
| InvalidArgumentException | Если режим опции неверен или несовместим |
$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 | если помощник не определен |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.html
