TIDY.GETOPTDOC(3) 1 TIDY.GETOPTDOC(3)
tidy::getOptDoc - Returns the documentation for the given option name
Object oriented style
SYNOPSIS
string tidy::getOptDoc (string $optname)
DESCRIPTION
Procedural style
string tidy_get_opt_doc (tidy $object, string $optname)
tidy_get_opt_doc(3) returns the documentation for the given option name.
Note
You need at least libtidy from 25 April, 2005 for this function be available.
PARAMETERS
o $object
- The Tidy object.
o $optname
- The option name
RETURN VALUES
Returns a string if the option exists and has documentation available, or FALSE otherwise.
EXAMPLES
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 />
";
}
?>
SEE ALSO
tidy.getconfig(3), tidy.getopt(3).
PHP Documentation Group TIDY.GETOPTDOC(3)
