PHP: tidy_get_opt_doc - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

tidy_get_output tidy_get_html

Last updated: Sat, 27 Jan 2007

view this page in

# tidy_get_opt_doc

(PHP 5 >= 5.1.0RC1)

tidy_get_opt_doc -- Returns the documentation for the given option name

## Описание

Procedural style:

string tidy_get_opt_doc ( tidy object, string optname )

Object oriented style:

string tidy->getOptDoc ( string optname )

tidy_get_opt_doc() returns the documentation for the given option name.

> Замечание: You need at least libtidy from 25 April, 2005 for this function be available.

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

`object`

  A tidy object

`optname`

  The option name

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

Returns a string if the option exists and has documentation available, or `FALSE` otherwise.

## Примеры

Пример 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";
}
?>`

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

tidy_get_config()
tidy_getopt()

add a note User Contributed Notes
tidy_get_opt_doc
There are no user contributed notes for this page.
tidy_get_output tidy_get_html

Last updated: Sat, 27 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 10:36:09 2007 PST