Класс 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(array $collection): int
Пройтись по коллекции и найти самое длинное имя.
Параметры
-
array$collection Коллекция для поиска максимальной длины.
Возвращает
intsetAlias() public
setAlias(string $alias): void
Установить псевдоним
Параметры
-
string$alias Псевдоним
Возвращает
voidtext() public
text(int $width = 72): string
Получить справку в формате текста, подходящем для вывода в командной строке.
Параметры
-
int$width optional Ширина вывода справки.
Возвращает
stringxml() public
xml(bool $string = true): stringSimpleXMLElement
Получить справку в виде XML-строки.
Параметры
-
bool$string optional Вернуть объект SimpleXml или строку. По умолчанию — true.
Возвращает
stringSimpleXMLElementПодробное описание свойств
$_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.2/class-Cake.Console.HelpFormatter.html
