tidy_get_html
tidy_get_output
Funções do Tidy
PHP Manual

# tidy_get_opt_doc

(PHP 5 >= 5.1.0)

tidy_get_opt_doc — Retorna a documentação para uma dada opção

### Descrição

Modo procedural:

string tidy_get_opt_doc ( tidy `$object` , string `$optname` )

Modo orientando a objeto:

string tidy->getOptDoc ( string `$optname` )

tidy_get_opt_doc() retorna a documentação para a dado opção.

> Nota: Você precisa da última libtidy de 25 Abril, 2005 para esta função estar disponível.

### Parâmetros

`object`

  Um objeto tidy

`optname`

  O nome da opção

### Valor Retornado

Retorna uma string se a opção existe e tem documentação disponível, ou `FALSE` caso contrário.

### Exemplos

Exemplo #1 Imprime todas opções com sua respectiva documentação e valor padrão

`<?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";
}
?>`

### Veja Também

- tidy_get_config()
- tidy_getopt()

tidy_get_html
tidy_get_output
Funções do Tidy
PHP Manual