tidy::getOptDoc
tidy::getOptDoc
tidy_get_opt_doc
(PHP 5 >= 5.1.0, PHP 7)
tidy :: getOptDoc - tidy_get_opt_doc - 返回给定选项名称的文档
描述
面向对象的风格
string tidy::getOptDoc ( string $optname )
程序风格
string tidy_get_opt_doc ( tidy $object , string $optname )
tidy_get_opt_doc（）返回给定选项名称的文档。
注意：从2005年4月25日起至少需要libtidy才能使用此功能。
参数
object
整洁的对象。
optname
选项名称
返回值
如果该选项存在并且有可用的文档，则返回一个字符串，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";
}
?>
