tidy::getOptDoc
PHP function
Edit on GitHub ✎
Returns the documentation for the given option name
Description
Oop
tidy::getOptDoc(string $option): string|false
Procedural
tidy_get_opt_doc(tidy $tidy, string $option): string|false
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.
Parameters
tidyObject
optionThe option name
Return Values
Returns a string if the option exists and has documentation available, or false otherwise.
Examples
Print all options along with their documentation and default value
php
<?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";
}
?>