(PHP 5 >= 5.1.0, PHP 7, PHP 8)
tidy::getOptDoc -- tidy_get_opt_doc — 返回给定选项名称的文档
面向对象风格
过程式风格
tidy_get_opt_doc() 返回给定选项名称的文档。
注意:
您至少需要 2005 年 4 月 25 日的 libtidy 版本才能使用此函数。
如果选项存在且有文档可用，则返回一个字符串，否则返回 false。
示例 #1 打印所有选项及其文档和默认值
<?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";
}
?>