tidy::getOptDoc
tidy_get_opt_doc
(PHP 5 >= 5.1.0)
tidy::getOptDoc -- tidy_get_opt_doc — Returns the documentation for the given option name
Description
Object oriented style
string tidy::getOptDoc
( string
$optname
)Procedural style
tidy_get_opt_doc() returns the documentation for the given option name.
Note:
You need at least libtidy from 25 April, 2005 for this function be available.
Return Values
Returns a string if the option exists and has documentation available, or
FALSE otherwise.
Examples
Example #1 Print all options along with their documentation and default value
<?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";
}
?>
See Also
- tidy::getconfig() - Get current Tidy configuration
- tidy::getopt() - Returns the value of the specified configuration option for the tidy document
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Другие базовые расширения
- Tidy
- Функция tidy::body() - Возвращает объект tidyNode, начиная с тега <body> разобранного tidy-дерева
- Функция tidy::cleanRepair() - Выполнить настроенную очистку и восстановление разобранной разметки
- Функция tidy::__construct() - Создает новый tidy-объект
- Функция tidy::diagnose() - Запуск настроенной диагностики для разобранной и восстановленной разметки
- Функция tidy::$errorBuffer() - Возвращает предупреждения и ошибки, возникшие при разборе указанного документа
- Функция tidy::getConfig() - Получает текущую конфигурацию Tidy
- Функция tidy::getHtmlVer() - Получает обнаруженную HTML версию для указанного документа
- Функция tidy::getOpt() - Возвращает значение указанного параметра конфигурации для документа tidy
- Функция tidy::getoptdoc() - Возвращает описание для опции с указанным названием
- Функция tidy::getRelease() - Получить дату релиза (версию) для библиотеки Tidy
- Функция tidy::getStatus() - Получает статус указанного документа
- Функция tidy::head() - Возвращает объект tidyNode, начиная с тега <head> разобранного tidy-дерева
- Функция tidy::html() - Возвращает объект tidyNode, начиная с тега <html> разобранного tidy-дерева
- Функция tidy::isXhtml() - Определяет, является ли документ XHTML-документом
- Функция tidy::isXml() - Определяет, является ли документ общим XML-документом (не HTML/XHTML)
- Функция tidy::parseFile() - Разбор разметки в файле или URI
- Функция tidy::parseString() - Разбор документа, хранимого в строке
- Функция tidy::repairFile() - Воcстанавливает разметку файла и возвращает его в виде строки
- Функция tidy::repairString() - Восстанавливает строку, используя по возможности конфигурационный файл
- Функция tidy::root() - Возвращает объект tidyNode, представляющий вершину разобранного tidy-дерева
Коментарии
404 Not Found