PHP Manual
tidy
Returns the documentation for the given option name

tidy::getOptDoc

tidy_get_opt_doc

(PHP 5 >= 5.1.0, PHP 7)

tidy::getOptDoc -- tidy_get_opt_doc — Returns the documentation for the given option name

说明

面向对象风格

public tidy::getOptDoc ( string $optname ) : string

过程化风格

tidy_get_opt_doc ( tidy $object , string $optname ) : string

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.

参数

object: The Tidy 对象。
optname: The option name

返回值

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

范例

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

?>

参见

tidy::getconfig() - Get current Tidy configuration
tidy::getopt() - Returns the value of the specified configuration option for the tidy document

php vector returns the value at a given index php eventbufferevent returns the current cipher name of the ssl connection php eventbufferevent returns the name of the protocol used for current ssl connection php ibm db2 函数 returns an array indexed by column name representing a row in a result set php ibm db2 函数 returns an array indexed by both column name and position representing a row in a result set php imap 函数 returns a properly formatted email address given the mailbox host and personal info php ldap 函数 set the value of the given option php maxdb 函数 returns whether thread safety is given or not php ncurses 函数 returns terminals short name php sqlite 函数 execute a query against a given database and returns an array php sqlite 函数 executes a query against a given database and returns a result handle php locale returns an appropriately localized display name for region of the input locale php locale returns an appropriately localized display name for script of the input locale php locale returns an appropriately localized display name for variants of the input locale php mongodb driver readpreference returns the readpreference s maxstalenessseconds option php mongodb driver readpreference returns the readpreference s mode option php sdo das relational 函数 executes a given sql query against a relational database and returns the results as a normalised data graph php sdo das xml 函数 creates sdo dataobject for a given namespace uri and type name php tidy returns the value of the specified configuration option for the tidy document php tidy returns the documentation for the given option name