类 HelpFormatter
HelpFormatter 格式化控制台 shell 的帮助信息。可以格式化成文本或 XML 格式。使用 ConsoleOptionParser 方法生成帮助信息。
一般不会直接使用。使用 $parser->help($command, 'xml'); 通常是访问帮助信息的方式。或者通过命令行中的 --help=xml 选项。
Xml 输出对于与其他工具（如 IDE 或其他构建工具）集成非常有用。
命名空间: Cake\Console
属性摘要
-
$_alias protected
string在输出中显示的别名。
-
$_maxArgs protected
int生成用法时显示的最大参数数量。
-
$_maxOptions protected
int生成用法时显示的最大选项数量。
-
$_parser protected
Cake\Console\ConsoleOptionParser选项解析器。
方法摘要
-
__construct() public
为 OptionParser 构建帮助格式化器
-
_generateUsage() protected
根据 shell 的参数和选项生成用法。用法字符串优先使用短选项而不是长选项，可选参数用 [] 表示
-
_getMaxLength() protected
迭代一个集合并找到最长的命名项。
-
setAlias() public
设置别名
-
text() public
获取格式化后的帮助文本，适合在命令行上输出。
-
xml() public
获取帮助信息作为 XML 字符串。
方法详细说明
__construct() ¶ public
__construct(Cake\Console\ConsoleOptionParser $parser)为 OptionParser 构建帮助格式化器
参数
-
Cake\Console\ConsoleOptionParser$parser 正在为其生成帮助信息的选项解析器。
_generateUsage() ¶ protected
_generateUsage(): string根据 shell 的参数和选项生成用法。用法字符串优先使用短选项而不是长选项，可选参数用 [] 表示
返回
string_getMaxLength() ¶ protected
_getMaxLength(arrayCake\Console\ConsoleInputOptionCake\Console\ConsoleInputArgument> $collection): int迭代一个集合并找到最长的命名项。
参数
-
arrayCake\Console\ConsoleInputOptionCake\Console\ConsoleInputArgument>$collection 要查找最大长度的集合。
返回
inttext() ¶ public
text(int $width = 72): string获取格式化后的帮助文本，适合在命令行上输出。
参数
-
int$width optional 帮助输出的宽度。
返回
stringxml() ¶ public
xml(bool $string = true): SimpleXMLElement|string获取帮助信息作为 XML 字符串。
参数
-
bool$string optional 返回 SimpleXml 对象或字符串。默认为 true。
返回
SimpleXMLElement|string