Класс 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