Zwraca dokumentację dla danej nazwy opcji

tidy_get_opt_doc

(PHP 5 >= 5.1.0)

tidy_get_opt_doc — Zwraca dokumentację dla danej nazwy opcji

Opis

Styl proceduralny:

string tidy_get_opt_doc ( tidy $obiekt , string $nazwa_opcji )

Styl zorientowany obiektowo:

string tidy->getOptDoc ( string $nazwa_opcji )

tidy_get_opt_doc() zwraca dokumentację dla danej nazwy opcji.

Informacja: Aby ta funkcja była dostępna, wymagana jest biblioteka libtidy w wersji od 25 April 2005. (kolejne wersje biblioteki libtidy numerowane są za pomocą daty ich wydania - przyp. tłum.)

Parametry

obiekt: Obiekt tidy
nazwa_opcji: Nazwa opcji

Zwracane wartości

Zwraca łańcuch jeśli opcja istnieje i jej dokumentacja jest dostępna, w przeciwnym wypadku zwraca FALSE.

Przykłady

Example #1 Wyświetla wszystkie opcje wraz z ich dokumentacją i wartościami domyślnymi


<?php

$tidy = new tidy;
$config = $tidy->getConfig();

ksort($config);

foreach ($config as $opt => $val) {

    if (!$doc = $tidy->getOptDoc($opt))
        $doc = 'dokumentacja nie jest dostępna!';

    $val = ($tidy->getOpt($opt) === true)  ? 'true'  : $val;
    $val = ($tidy->getOpt($opt) === false) ? 'false' : $val;

    echo "<p><b>$opt</b> (domyślnie: '$val')<br />".
         "$doc</p><hr />\n";
}

?>

Zobacz też: