AbstractConfigCommand
class AbstractConfigCommand extends ContainerDebugCommand
Командный интерпретатор для вывода доступных конфигурационных ссылок.
Методы
| __construct(string|null $name = null) Конструктор. | from Command | |
| ignoreValidationErrors() Игнорирует ошибки валидации. | from Command | |
| setApplication(Application $application = null) Устанавливает экземпляр приложения для этой команды. | from Command | |
| setHelperSet(HelperSet $helperSet) Устанавливает набор вспомогательных средств. | from Command | |
| HelperSet | getHelperSet() Получает набор вспомогательных средств. | from Command |
| Application | getApplication() Получает экземпляр приложения для этой команды. | from Command |
| bool | isEnabled() Проверяет, включена ли команда в текущей среде. | from Command |
| int | run(InputInterface $input, OutputInterface $output) Выполняет команду. | from Command |
| Command | setCode(callable $code) Устанавливает код для выполнения при запуске этой команды. | from Command |
| mergeApplicationDefinition(bool $mergeArgs = true) Объединяет определение приложения с определением команды. | from Command | |
| Command | setDefinition(array|InputDefinition $definition) Устанавливает массив экземпляров аргументов и опций. | from Command |
| InputDefinition | getDefinition() Получает InputDefinition, прикрепленный к этой команде. | from Command |
| InputDefinition | getNativeDefinition() Получает InputDefinition, используемый для создания XML и текстовых представлений этой команды. | from Command |
| Command | addArgument(string $name, int $mode = null, string $description = '', mixed $default = null) Добавляет аргумент. | from Command |
| Command | addOption(string $name, string $shortcut = null, int $mode = null, string $description = '', mixed $default = null) Добавляет опцию. | from Command |
| Command | setName(string $name) Устанавливает имя команды. | from Command |
| Command | setProcessTitle(string $title) Устанавливает заголовок процесса для команды. | from Command |
| string | getName() Возвращает имя команды. | from Command |
| Command | setDescription(string $description) Устанавливает описание команды. | from Command |
| string | getDescription() Возвращает описание команды. | from Command |
| Command | setHelp(string $help) Устанавливает справку для команды. | from Command |
| string | getHelp() Возвращает справку для команды. | from Command |
| string | getProcessedHelp() Возвращает обработанную справку для команды, динамически заменяя шаблоны %command.name% и %command.full_name% на реальные значения. | from Command |
| Command | setAliases(string[] $aliases) Устанавливает псевдонимы для команды. | from Command |
| array | getAliases() Возвращает псевдонимы для команды. | from Command |
| string | getSynopsis(bool $short = false) Возвращает краткое описание команды. | from Command |
| addUsage(string $usage) Добавляет пример использования команды. | from Command | |
| array | getUsages() Возвращает альтернативные способы использования команды. | from Command |
| mixed | getHelper(string $name) Получает экземпляр вспомогательного средства по имени. | from Command |
| string | asText() deprecated Возвращает текстовое представление команды. | from Command |
| string|DOMDocument | asXml(bool $asDom = false) deprecated Возвращает XML-представление команды. | from Command |
| setContainer(ContainerInterface $container = null) Устанавливает контейнер. | from ContainerAwareCommand | |
| validateConfiguration(ExtensionInterface $extension, $configuration) |
Подробности
__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 | Объединять или нет аргументы определения приложения с аргументами определения команды |
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.
Параметры
| строка | $title | Заголовок процесса |
Значение возврата
| Команда | Текущий экземпляр |
строка getName()
Возвращает имя команды.
Значение возврата
| строка | Имя команды |
Команда setDescription(строка $description)
Устанавливает описание для команды.
Параметры
| строка | $description | Описание команды |
Значение возврата
| Команда | Текущий экземпляр |
строка getDescription()
Возвращает описание команды.
Значение возврата
| строка | Описание команды |
Команда setHelp(строка $help)
Устанавливает справку для команды.
Параметры
| строка | $help | Справка для команды |
Значение возврата
| Команда | Текущий экземпляр |
строка getHelp()
Возвращает справку для команды.
Значение возврата
| строка | Справка для команды |
строка getProcessedHelp()
Возвращает обработанную справку для команды, динамически подставляя реальные значения в шаблоны %command.name% и %command.full_name%.
Значение возврата
| строка | Обработанная справка для команды |
Команда setAliases(строка[] $aliases)
Устанавливает псевдонимы для команды.
Параметры
| строка[] | $aliases | Массив псевдонимов для команды |
Значение возврата
| Команда | Текущий экземпляр |
Исключения
| InvalidArgumentException | Если псевдоним некорректен |
массив getAliases()
Возвращает псевдонимы для команды.
Значение возврата
| массив | Массив псевдонимов для команды |
строка getSynopsis(bool $short = false)
Возвращает краткое описание команды.
Параметры
| bool | $short | Показывать ли короткую версию описания (с параметрами сложенными) |
Значение возврата
| строка | Описание |
addUsage(строка $usage)
Добавляет пример использования команды.
Параметры
| строка | $usage | Пример использования, он будет добавлен перед именем команды |
массив getUsages()
Возвращает альтернативные способы использования команды.
Значение возврата
| массив |
смешанный тип getHelper(строка $name)
Возвращает экземпляр помощника по имени.
Параметры
| строка | $name | Имя помощника |
Значение возврата
| смешанный тип | Значение помощника |
Исключения
| InvalidArgumentException | Если помощник не определён |
строка asText() устарело
устарело
Возвращает текстовое представление команды.
Значение возврата
| строка | Строковое представление команды |
строка|DOMDocument asXml(bool $asDom = false) устарело
устарело
Возвращает XML-представление команды.
Параметры
| bool | $asDom | Вернуть DOM или строку XML |
Значение возврата
| строка|DOMDocument | Строка XML, представляющая команду |
setContainer(ContainerInterface $container = null)
Устанавливает контейнер.
Параметры
| ContainerInterface | $container | Экземпляр ContainerInterface или null |
validateConfiguration(ExtensionInterface $extension, $configuration)
Параметры
| ExtensionInterface | $extension | |
| $configuration |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Bundle/FrameworkBundle/Command/AbstractConfigCommand.html
