PHP Handbuch
ZurückWeiter

tidy_get_opt_doc

(no version information, might be only in CVS)

tidy_get_opt_doc --  Returns the documentation for the given option name

Beschreibung

Procedural style:

string tidy_get_opt_doc ( tidy object, string optname )

Object oriented style:

string tidy->getOptDoc ( string optname )

tidy_get_opt_doc() returns the documentation for the given option name.

Anmerkung: You need at least libtidy from 25 April, 2005 for this function be available.

Parameter Liste

object

A 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_get_config()
tidy_getopt()

ZurückZum AnfangWeiter
tidy_get_htmlNach obentidy_get_output

Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 17:57:09