tidy::getOptDoc

    tidy_get_opt_doc

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

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

    说明

    面向对象风格

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

    过程化风格

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

    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.

    参数

    tidy

    The Tidy 对象。

    option

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

?>

    参见

    发现了问题？

    了解如何改进此页面 • 提交拉取请求 • 报告一个错误
    ＋添加备注

    用户贡献的备注

    此页面尚无用户贡献的备注。
    To Top