Класс HelpFormatter

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

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

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

Пространство имен: Cake\Console
Расположено в Console/HelpFormatter.php

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

__constructsource public

__construct( Cake\Console\ConsoleOptionParser $parser )

Создать форматировщик справки для OptionParser

Параметры

Cake\Console\ConsoleOptionParser $parser: Парсер опций, для которого генерируется справка.

_generateUsagesource protected

_generateUsage( )

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

Возвращает

string
string

_getMaxLengthsource protected

_getMaxLength( array $collection )

Перебирает коллекцию и находит наибольшую по длине вещь.

Параметры

массив $collection: Коллекция, для которой нужно найти максимальную длину.

Возвращает

integer
int

textsource public

text( integer $width 72 )

Получить справку в формате текста, подходящем для вывода в командной строке.

Параметры

целое число $width необязательно 72: Ширина вывода справки.

Возвращает

string
string

xmlsource public

xml( boolean $string true )

Получить справку в формате XML.

Параметры

логическое значение $string необязательно true: Вернуть объект SimpleXml или строку. По умолчанию true.

Возвращает

string|SimpleXmlElement
См. $string

Резюме свойств

$_maxArgssource

protected целое число

Максимальное количество аргументов, отображаемых при генерации использования.

$_maxOptionssource

protected целое число

Максимальное количество опций, отображаемых при генерации использования.

$_parsersource

protected Cake\Console\ConsoleOptionParser

Парсер опций.

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Console.HelpFormatter.html