Класс HelpFormatter
HelpFormatter форматирует справку для консольных оболочек. Может форматировать в текстовом или XML формате. Использует методы ConsoleOptionParser для генерации справки.
Обычно не используется напрямую. Обычно справка доступна через $parser->help($command, 'xml'); или через параметр --help=xml в командной строке.
Вывод в формате XML полезен для интеграции с другими инструментами, такими как IDE или другие инструменты сборки.
Краткое описание свойств
- $_alias protected
stringПсевдоним для отображения в выводе.
- $_maxArgs protected
intМаксимальное количество аргументов, отображаемых при генерации справки по использованию.
- $_maxOptions protected
intМаксимальное количество опций, отображаемых при генерации справки по использованию.
- $_parser protected
Cake\Console\ConsoleOptionParserПарсер опций.
Краткое описание методов
-
__construct() public
Создаёт форматировщик справки для OptionParser
-
_generateUsage() protected
Генерирует справку по использованию оболочки на основе её аргументов и опций. Строки справки по использованию предпочитают короткие опции длинным и необязательные аргументы будут обозначены []
-
_getMaxLength() protected
Итерирует по коллекции и находит самое длинное имя.
-
setAlias() public
Устанавливает псевдоним
-
text() public
Получает справку в формате текста, подходящем для вывода в командной строке.
-
xml() public
Получает справку в виде XML-строки.
Подробное описание методов
__construct() public
__construct(Cake\Console\ConsoleOptionParser $parser)
Создаёт форматировщик справки для OptionParser
Параметры
-
Cake\Console\ConsoleOptionParser$parser Парсер опций, для которого генерируется справка.
_generateUsage() protected
_generateUsage(): string
Генерирует справку по использованию оболочки на основе её аргументов и опций. Строки справки по использованию предпочитают короткие опции длинным и необязательные аргументы будут обозначены []
Возвращаемое значение
string_getMaxLength() protected
_getMaxLength(arrayCake\Console\ConsoleInputOptionCake\Console\ConsoleInputArgumentCake\Console\ConsoleInputSubcommand> $collection): int
Итерирует по коллекции и находит самое длинное имя.
Параметры
-
arrayCake\Console\ConsoleInputOptionCake\Console\ConsoleInputArgumentCake\Console\ConsoleInputSubcommand>$collection Коллекция для поиска максимальной длины.
Возвращаемое значение
intsetAlias() public
setAlias(string $alias): void
Устанавливает псевдоним
Параметры
-
string$alias Псевдоним
Возвращаемое значение
voidtext() public
text(int $width = 72): string
Получает справку в формате текста, подходящем для вывода в командной строке.
Параметры
-
int$width необязательный Ширина вывода справки.
Возвращаемое значение
stringxml() public
xml(bool $string = true): SimpleXMLElement|string
Получает справку в виде XML-строки.
Параметры
-
bool$string необязательный Возвращает объект SimpleXml или строку. По умолчанию - true.
Возвращаемое значение
SimpleXMLElement|stringПодробное описание свойств
$_alias protected
Псевдоним для отображения в выводе.
Тип
string$_maxArgs protected
Максимальное количество аргументов, отображаемых при генерации справки по использованию.
Тип
int$_maxOptions protected
Максимальное количество опций, отображаемых при генерации справки по использованию.
Тип
int$_parser protected
Парсер опций.
Тип
Cake\Console\ConsoleOptionParser
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.Console.HelpFormatter.html
