©
本文檔使用 php中文網手册 發布
(PHP 5 >= 5.1.0)
tidy::getOptDoc -- tidy_get_opt_doc — Returns the documentation for the given option name
面向对象风格
$optname
)过程化风格
$object
, string $optname
)tidy_get_opt_doc() returns the documentation for the given option name.
Note:
You need at least libtidy from 25 April, 2005 for this function be available.
object
The Tidy 对象。
optname
The option name
Returns a string if the option exists and has documentation available, or
FALSE
otherwise.
Example #1 Print all options along with their documentation and default value
<?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" ;
}
?>