PHP 5.4.31 Released

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

Descrizione

Stile orientato agli oggetti

string tidy::getOptDoc ( string $optname )

Stile procedurale

string tidy_get_opt_doc ( tidy $object , string $optname )

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

Nota:

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

Elenco dei parametri

object

L'oggetto Tidy

optname

The option name

Valori restituiti

Returns a string if the option exists and has documentation available, or FALSE otherwise.

Esempi

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 />\n";
}

?>

Vedere anche:

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top