Класс HelpFormatter

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

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

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

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

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

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

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

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

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

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

__construct( Cake\Console\ConsoleOptionParser $parser )

_generateUsage( )

_getMaxLength( array $collection )

setAlias( string $alias )

text( integer $width = 72 )

xml( boolean $string = true )

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

'cake'

6

6