📄 function.tidy-get-opt-doc.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Returns the documentation for the given option name</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.tidy-get-html.html">tidy_get_html</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.tidy-get-output.html">tidy_get_output</a></div> <div class="up"><a href="ref.tidy.html">Tidy Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.tidy-get-opt-doc" class="refentry"> <div class="refnamediv"> <h1 class="refname">tidy_get_opt_doc</h1> <p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">tidy_get_opt_doc</span> — <span class="dc-title"> Returns the documentation for the given option name </span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <p class="para">Procedural style:</p> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><b>tidy_get_opt_doc</b></b></span> ( <span class="methodparam"><span class="type"><span class="type tidy">tidy</span></span> <tt class="parameter">$object</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$optname</tt></span> )</div> <p class="para rdfs-comment">Object oriented style:</p> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><b>tidy->getOptDoc</b></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$optname</tt></span> )</div> <p class="para rdfs-comment"> <b>tidy_get_opt_doc()</b> returns the documentation for the given option name. </p> <blockquote><p><b class="note">Note</b>: You need at least libtidy from 25 April, 2005 for this function be available. <br /> </p></blockquote> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">object</tt></i></span> <dd> <p class="para"> A tidy object </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">optname</tt></i></span> <dd> <p class="para"> The option name </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a string if the option exists and has documentation available, or <b><tt>FALSE</tt></b> otherwise. </p> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 Print all options along with their documentation and default value</b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /><br />$tidy </span><span style="color: #007700">= new </span><span style="color: #0000BB">tidy</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$config </span><span style="color: #007700">= </span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">getConfig</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">ksort</span><span style="color: #007700">(</span><span style="color: #0000BB">$config</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$config </span><span style="color: #007700">as </span><span style="color: #0000BB">$opt </span><span style="color: #007700">=> </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /><br /> if (!</span><span style="color: #0000BB">$doc </span><span style="color: #007700">= </span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">getOptDoc</span><span style="color: #007700">(</span><span style="color: #0000BB">$opt</span><span style="color: #007700">))<br /> </span><span style="color: #0000BB">$doc </span><span style="color: #007700">= </span><span style="color: #DD0000">'no documentation available!'</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">= (</span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">getOpt</span><span style="color: #007700">(</span><span style="color: #0000BB">$opt</span><span style="color: #007700">) === </span><span style="color: #0000BB">true</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'true' </span><span style="color: #007700">: </span><span style="color: #0000BB">$val</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">= (</span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-></span><span style="color: #0000BB">getOpt</span><span style="color: #007700">(</span><span style="color: #0000BB">$opt</span><span style="color: #007700">) === </span><span style="color: #0000BB">false</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'false' </span><span style="color: #007700">: </span><span style="color: #0000BB">$val</span><span style="color: #007700">;<br /><br /> echo </span><span style="color: #DD0000">"<p><b>$opt</b> (default: '$val')<br />"</span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">"$doc</p><hr />\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </div> </p> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.tidy-get-config.html" class="function" rel="rdfs-seeAlso">tidy_get_config()</a></li> <li class="member"><a href="function.tidy-getopt.html" class="function" rel="rdfs-seeAlso">tidy_getopt()</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.tidy-get-html.html">tidy_get_html</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.tidy-get-output.html">tidy_get_output</a></div> <div class="up"><a href="ref.tidy.html">Tidy Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -