PHP  
downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | my php.net 
search for in the  
<tidy_get_htmltidy_get_output>
Last updated: Mon, 16 Jul 2012

tidy_get_opt_doc

(no version information, might be only in CVS)

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_htmltidy_get_output>
 Last updated: Mon, 16 Jul 2012
 
Copyright © 2001-2005 The PHP Group
All rights reserved.
This unofficial mirror is operated at: http://manual.phpv.net/
Last updated: Thu Jul 7 19:13:47 2005 CST