Edit Report a Bug

    tidy::getOptDoc

    tidy_get_opt_doc

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

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

    Описание

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

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

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

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

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

    Замечание:

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

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

    tidy

    Объект 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

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top