tidy::getoptdoc

tidy_get_opt_doc

(PHP 5 >= 5.1.0)

tidy::getoptdoc -- tidy_get_opt_doc — Возвращает описание для опции с указанным названием

Описание

Объектно-ориентированный стиль

string tidy::getOptDoc ( string $optname )

Процедурный стиль

string tidy_get_opt_doc ( tidy $object , string $optname )

Функция tidy_get_opt_doc() возвращает описание для опции с указанным названием.

Замечание:
Для использования этой функции вам потребуется библиотека libtidy минимум от 25 Апреля 2005 г.

Список параметров

object: Объект Tidy.
optname: Название опции

Возвращаемые значения

Возвращается строка существующей опции и имеющееся описание, в противном случае возвращается FALSE.

Примеры

Пример #1 Печать всех опций вместе с описанием и значением по умолчанию


<?php

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

ksort($config);

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

    if (!$doc = $tidy->getOptDoc($opt))
        $doc = 'документация не существует!';

    $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";
}

?>

Смотрите также

tidy::getconfig() - Получает текущую конфигурацию Tidy
tidy::getopt() - Возвращает значение указанного параметра конфигурации для документа tidy