mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
045d98a77e
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185562 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3 KiB
XML
Executable file
130 lines
3 KiB
XML
Executable file
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.1 $ -->
|
|
<refentry id="function.tidy-get-opt-doc">
|
|
<refnamediv>
|
|
<refname>tidy_get_opt_doc</refname>
|
|
<refpurpose>
|
|
Returns the documentation for the given option name
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>Procedural style:</para>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>tidy_get_opt_doc</methodname>
|
|
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>optname</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>Object oriented style:</para>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>tidy->getOptDoc</methodname>
|
|
<methodparam><type>string</type><parameter>optname</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>tidy_get_opt_doc</function> returns the documentation for the
|
|
given option name.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
You need at least libtidy from 25 April, 2005 for this function be
|
|
available.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>object</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A tidy object
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>optname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The option name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a string if the option exists and has documentation available, or
|
|
&false; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Print all options along with their documentation and default value</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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";
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>tidy_get_config</function></member>
|
|
<member><function>tidy_getopt</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|