(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 = '沒有可用的說明文件!';
$val = ($tidy->getOpt($opt) === true) ? 'true' : $val;
$val = ($tidy->getOpt($opt) === false) ? 'false' : $val;
echo "<p><b>$opt</b> (預設值: '$val')<br />".
"$doc</p><hr />\n";
}
?>