Класс HelpFormatter

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

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

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

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

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

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

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

  Сгенерировать справку для оболочки на основе её аргументов и опций. Строки справки используют короткие опции вместо длинных. Необязательные аргументы будут указаны в квадратных скобках.

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

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

__construct( Cake\Console\ConsoleOptionParser $parser )

_generateUsage( )

_getMaxLength( array $collection )

text( integer $width 72 )

xml( boolean $string true )

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

6

6