Класс HelpFormatter

HelpFormatter форматирует справку для консольных оболочек. Может форматировать в текстовые или XML форматы. Использует методы ConsoleOptionParser для генерации справки.

Обычно не используется напрямую. Обычно доступ к справке осуществляется с помощью $parser->help($command, 'xml');. Или через опцию --help=xml в командной строке.

XML-вывод полезен для интеграции с другими инструментами, такими как IDE или другие инструменты сборки.

Краткое описание свойств

• $_maxArgs protected
  integer
  Максимальное количество аргументов, отображаемых при генерации использования.
• $_maxOptions protected
  integer
  Максимальное количество опций, отображаемых при генерации использования.

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

• __construct() public
  Создает форматировщик справки для OptionParser
• _generateUsage() protected

  Генерирует использование оболочки на основе ее аргументов и опций. Строки использования отдаёт предпочтение коротким опциям длинным, а необязательные аргументы будут обозначены [ ]

• _getMaxLength() protected
  Итерирует по коллекции и находит самое длинное имя.
• text() public
  Получает справку в формате текста, подходящем для вывода в командной строке.
• xml() public
  Получает справку в виде строки XML.

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

__construct( ConsoleOptionParser $parser )

_generateUsage( )

_getMaxLength( array $collection )

text( integer $width 72 )

xml( boolean $string true )

Подробное описание свойств

6

6