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