PHP Dokumentation: Tidy getoptdoc
12. Januar 2010 von werner
tidy::getoptdoc
tidy_get_opt_doc
(PHP 5 >= 5.1.0)
tidy::getoptdoc — tidy_get_opt_doc — Returns the documentation for the given option name
Beschreibung
Object oriented style
string tidy::getOptDoc ( string $optname )
Procedural style
tidy_get_opt_doc() returns the documentation for the given option name.
Hinweis: You need at least libtidy from 25 April, 2005 for this function be available.
Parameter-Liste
- object
The Tidy object.
- optname
The option name
Rückgabewerte
Returns a string if the option exists and has documentation available, or FALSE otherwise.
Beispiele
Beispiel #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";
}?>Siehe auch
- tidy::getconfig() – Get current Tidy configuration
- tidy::getopt() – Returns the value of the specified configuration option for the tidy document
Loading ...