PHP-Handbuch: Returns the documentation for the given option name

Beschreibung

Objektorientierter Stil

string tidy::getOptDoc ( string $optname )

Prozeduraler Stil

string tidy_get_opt_doc ( tidy $object , string $optname )

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: Das Tidy Objekt.
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
tidy::getopt