Manuel PHP
Précédent |  | Suivant

# tidy_get_opt_doc

(PHP 5 >= 5.1.0RC1)

tidy_get_opt_doc -- Retourne la documentation pour le nom de l'option donnée

## Description

Style procédural

string tidy_get_opt_doc ( tidy object, string optname )

Style orienté objet (méthode)

string tidy->getOptDoc ( string optname )

tidy_get_opt_doc() retourne la documentation pour le nom de l'option donnée.

> Note : Vous devez posséder au moins libtidy datant du 25 avril 2005 pour que cette fonction soit disponible.

## Liste de paramètres

object

  Un objet tidy

optname

  Le nom de l'option

## Valeurs de retour

Retourne une chaîne de caractères si l'option existe et qu'elle possède de la documentation ou `FALSE` autrement.

## Exemples

Exemple 1. Affichage de toutes les options avec leur documentation et leur valeur par défaut
`<?php $tidy = new tidy; $config = $tidy->getConfig(); ksort($config); foreach ($config as $opt => $val) { if (!$doc = $tidy->getOptDoc($opt)) $doc = 'aucune documentation disponible!'; $val = ($tidy->getOpt($opt) === true) ? 'true' : $val; $val = ($tidy->getOpt($opt) === false) ? 'false' : $val; echo "<p><b>$opt</b> (défaut : '$val')<br />". "$doc</p><hr />\n"; } ?>`

## Voir aussi

tidy_get_config()
tidy_getopt()

Précédent | Sommaire | Suivant
tidy_get_html | Niveau supérieur | tidy_get_output