Класс HelpFormatter

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

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

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

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

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

$_maxArgs protected

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

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

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

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

Генерирует использование оболочки на основе ее аргументов и опций. Строки использования отдаёт предпочтение коротким опциям перед длинными. А необязательные аргументы будут обозначены [ ]
_getMaxLength() protected
Пройтись по коллекции и найти наибольшую названную вещь.
text() public
Получить справку в формате текста, пригодном для вывода в командной строке.
xml() public
Получить справку в виде XML строки.

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

__construct()source public

__construct( ConsoleOptionParser $parser )

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

Параметры

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

_generateUsage()source protected

_generateUsage( )

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

Возвращаемое значение

string

_getMaxLength()source protected

_getMaxLength( array $collection )

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

Параметры

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

Возвращаемое значение

целое число

text()source public

text( integer $width 72 )

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

Параметры

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

Возвращаемое значение

строка

xml()source public

xml( boolean $string true )

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

Параметры

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

Возвращаемое значение

string|SimpleXmlElement
См. $string

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

$_maxArgssource

protected целое число

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

$_maxOptionssource

protected целое число

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

© 2005–2017 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.
https://api.cakephp.org/2.10/class-HelpFormatter.html