Класс HelpFormatter

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

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

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

Пакет: Cake\Console
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
С момента: CakePHP(tm) v 2.0
Расположение Cake/Console/HelpFormatter.php

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

__constructsource public

__construct( ConsoleOptionParser $parser )

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

Параметры

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

_generateUsagesource protected

_generateUsage( )

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

Возвращает

string
строка

_getMaxLengthsource protected

_getMaxLength( array $collection )

Итерируется по коллекции и находит самое длинное именованное значение.

Параметры

массив $collection: Коллекция для поиска максимальной длины.

Возвращает

integer
целое число

textsource public

text( integer $width 72 )

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

Параметры

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

Возвращает

string
строка

xmlsource public

xml( boolean $string true )

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

Параметры

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

Возвращает

string|SimpleXmlElement
См. $string

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

$_maxArgssource

protected целое число

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

$_maxOptionssource

protected целое число

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

© 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/2.7/class-HelpFormatter.html