cvs: peardoc /en/packages/networking Net_Dict.xml
| From: | Chandrashekhar Bhosle | Date: | Fri, 29 Nov 2002 07:11:37 +0000 |
| Subject: | cvs: peardoc /en/packages/networking Net_Dict.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-72@lists.php.net to get a copy of this message | ||
cnb Fri Nov 29 02:11:37 2002 EDT
Modified files:
/peardoc/en/packages/networking Net_Dict.xml
Log:
setCache() docmentation added
Index: peardoc/en/packages/networking/Net_Dict.xml
diff -u peardoc/en/packages/networking/Net_Dict.xml:1.3
peardoc/en/packages/networking/Net_Dict.xml:1.4
--- peardoc/en/packages/networking/Net_Dict.xml:1.3 Sat Oct 12 04:26:14 2002
+++ peardoc/en/packages/networking/Net_Dict.xml Fri Nov 29 02:11:37 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Id: Net_Dict.xml,v 1.3 2002/10/12 08:26:14 mj Exp $ -->
+<!-- $Id: Net_Dict.xml,v 1.4 2002/11/29 07:11:37 cnb Exp $ -->
<refentry id="packages.Networking.Net_Dict">
<refnamediv>
<refname><classname>Net_Dict</classname></refname>
@@ -188,6 +188,127 @@
</refsect2>
</refsect1>
+ <refsect1 id="packages.Networking.Net_Dict.setCache">
+ <title>Net_Dict::setCache</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>Net_Dict::setCache</function></funcdef>
+ <paramdef>
+ boolean <parameter>$flag = false,</parameter>
+ string <parameter>$container = '',</parameter>
+ array <parameter>$container_options = ''</parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+Sets up PEAR Caching
+ </para>
+ <refsect2 id="packages.Networking.Net_Dict.setCache.parameter">
+ <title>Parameter</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>$flag</parameter> - Set caching ON (true) or OFF (false)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>$container</parameter> - Which PEAR Cache container (file/DB/..) to
use
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>$container_options</parameter> - Pass the container options to the
PEAR Cache
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect2>
+ <refsect2 id="packages.Networking.Net_Dict.setCache.return">
+ <title>Returns</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>void</parameter> - does not return
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect2>
+ <refsect2 id="packages.Networking.Net_Dict.setCache.see">
+ <title>See</title>
+ <para>
+ <link linkend="packages.Networking.Net_Dict.define">
+ <function>Net_Dict::define</function>
+ </link>
+ </para>
+ </refsect2>
+ <refsect2 id="packages.Networking.Net_Dict.setCache.example">
+ <title>Example</title>
+ <para>
+ <programlisting role="php">
+ <![CDATA[
+$d = new Net_Dict;
+
+// make sure cache_dir is writable
+$d->setCache(true, 'file', array('cache_dir'=>'/tmp/cache/'));
+
+$defs = $d->define($keyword);
+ ]]>
+ </programlisting>
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1 id="packages.Networking.Net_Dict.setServer">
+ <title>Net_Dict::setServer</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>mixed <function>Net_Dict::setServer</function></funcdef>
+ <paramdef>
+ string <parameter>$server,</parameter>
+ integer <parameter>
+ <optional>$port = 0</optional>
+ </parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+Sets the DICT server and port to which the connection should be made.
+ </para>
+ <refsect2 id="packages.Networking.Net_Dict.setServer.parameter">
+ <title>Parameter</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>$server</parameter> - DICT server.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>$port</parameter> - DICT Port
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect2>
+ <refsect2 id="packages.Networking.Net_Dict.setServer.return">
+ <title>Returns</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <parameter>void</parameter> - does not return
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect2>
+ </refsect1>
+
<refsect1 id="packages.Networking.Net_Dict.match">
<title>Net_Dict::match</title>
<funcsynopsis>