略微加速

PHP官方手册 - 互联网笔记

PHP - Manual: tidy::getOptDoc

2024-12-20

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 tidy::getOptDoc(string $option): string|false

过程化风格

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

?>

参见

add a noteadd a note

User Contributed Notes

There are no user contributed notes for this page.

官方地址:https://www.php.net/manual/en/tidy.getoptdoc.php

北京半月雨文化科技有限公司.版权所有 京ICP备12026184号-3