tidy::getOptDoc

tidy_get_opt_doc

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

tidy::getOptDoc -- tidy_get_opt_doc — Retorna a documentação para o nome da opção fornecida

Descrição

Estilo orientado a objetos

public tidy::getOptDoc(string $option): string|false

Estilo procedural

tidy_get_opt_doc(tidy $tidy, string $option): string|false

tidy_get_opt_doc() retorna a documentação para o nome da opção fornecida.

Nota:
É necessário ter a libtidy a partir de 25 de abril de 2005 para que esta função esteja disponível.

Parâmetros

tidy: Um objeto Tidy.
option: O nome da opção

Valor Retornado

Retorna uma string se a opção existir e tiver documentação disponível, ou false caso contrário.

Exemplos

Exemplo #1 Imprimindo todas as opções junto com sua 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::getConfig() - Obtém a configuração atual do Tidy
tidy::getOpt() - Retorna o valor da opção de configuração especificada para o documento tidy

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicione uma nota

Notas Enviadas por Usuários (em inglês)

Não há notas de usuários para esta página.