tidy::getOptDoc()

(PHP 5 >= 5.1.0, PHP 7)

返回给定选项名称的文档

说明

面向对象风格
publictidy::getOptDoc(string $optname): string

过程化风格
tidy_get_opt_doc(tidy$object,string $optname): string

tidy_get_opt_doc()返回给定选项名称的文档。

Note:

从2005年4月25日起，您至少需要libtidy才能使用此功能。

参数

• $object：Tidy对象。
• $optname：选项名

返回值

如果选项存在并返回文档，则返回字符串, 或者FALSE

范例

<?php
$tidy = new tidy;
$config = $tidy->getConfig();
ksort($config);
foreach ($config as $opt => $val) 
{
    if (!$doc = $tidy->getOptDoc($opt))$doc = 'no documentation available!';
    $val = ($tidy->getOpt($opt) === true)  ? 'true'  : $val;
    $val = ($tidy->getOpt($opt) === false) ? 'false' : $val;
    echo "<p><b>$opt</b> (default: '$val')<br />"."$doc</p><hr />\n";
}
?>

参见

• tidy::getconfig() 获得当前Tidy配置信息列表的数组
• tidy::getopt() 返回tidy文档的指定配置选项的值