PHP Documentation - Re: [PHP-DOC] cvs: phpdoc /en/reference/memcache/functions memcache-add.xml

Author

Re: [PHP-DOC] cvs: phpdoc /en/reference/memcache/functions memcache-add.xml

Jean-Sebastien Goupil

2006-01-09, 8:02 pm

I have just transformed the memcache documentation to the new style.
I would like you to double check if everything is correct. Some
parameters are note explained because I didn't check in the C files to
understand their meanings (add, decrement, delete, get, increment, replace).
For the memcache:get(), I was wondering if it I should put only one
method but with a mixed parameter. You should also check the returns
values for this method... Does it return an array if I pass an array as
argument ?

I wondering if the previous form (memcache_...) should be deleted or put
in an history table...

I let you make these modifications :)

Jean-Sébastien Goupil
jsgoupil@gmail.com

Jean-Sébastien Goupil a écrit :[color=darkred]
> jsgoupil Fri Dec 23 19:52:06 2005 EDT
>
> Modified files:
> /phpdoc/en/reference/memcache/functions memcache-add.xml
> memcache-addserver.xml
> memcache-close.xml
> memcache-connect.xml
> memcache-debug.xml
> memcache-decrement.xml
> memcache-delete.xml
> memcache-flush.xml
> memcache-get.xml
> memcache-getextendedstats.xml
> memcache-getstats.xml
> memcache-getversion.xml
> memcache-increment.xml
> memcache-pconnect.xml
> memcache-replace.xml
> memcache-set.xml
> memcache-setcompressthreshold.xml
> Log:
> New doc Style
>
>
> ------------------------------------------------------------------------
>
> http://cvs.php.net/viewcvs.cgi/phpd...2&diff_format=u
> Index: phpdoc/en/reference/memcache/functions/memcache-add.xml
> diff -u phpdoc/en/reference/memcache/functions/memcache-add.xml:1.1 phpdoc/en/reference/memcache/functions/memcache-add.xml:1.2
> --- phpdoc/en/reference/memcache/functions/memcache-add.xml:1.1 Tue Sep 28 12:23:52 2004
> +++ phpdoc/en/reference/memcache/functions/memcache-add.xml Fri Dec 23 19:52:06 2005
> @@ -1,12 +1,13 @@
> <?xml version="1.0" encoding="iso-8859-1"?>
> -
> +
> <refentry id="function.Memcache-add">
> <refnamediv>
> <refname>Memcache::add</refname>
> <refpurpose>Add an item to the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::add</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> @@ -14,21 +15,68 @@
> <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>expire</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::add</function> stores variable
> <parameter>var</parameter> with <parameter>key</parameter> only if such
> key doesn't exist at the server yet.
> - <function>Memcache::add</function> returns &false; if such key already
> - exist. For the rest <function>Memcache::add</function> behaves
> - similarly to <function>Memcache::set</function>.
> + Also you can use <function>memcache_add</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Also you can use <function>memcache_add</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>var</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>flag</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>expire</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <example>
> - <title><function>Memcache::add</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> + Returns &false; if such key already exist. For the rest
> + <function>Memcache::add</function> behaves similarly to
> + <function>Memcache::set</function>.
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::add</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -42,18 +90,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - <function>Memcache::add</function> returns &true; on success or &false;
> - on failure.
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::set</function>,
> - <function>Memcache::replace</function>.
> + <simplelist>
> + <member><function>Memcache::set</function></member>
> + <member><function>Memcache::replace</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-addServer">
> <refnamediv>
> <refname>Memcache::addServer</refname>
> <refpurpose>Add a memcached server to connection pool</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::addServer</methodname>
> <methodparam><type>string</type><parameter>host</parameter></methodparam>
> @@ -16,40 +17,96 @@
> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::addServer</function> adds a server to the connection
> - pool. The actual connection is established on first use.
> - Parameters <parameter>host</parameter> and <parameter>port</parameter> point
> - to the host and port, where memcached is listening for connections.
> - Parameter <parameter>port</parameter> is optional, it's default value is
> - 11211.
> - Parameter <parameter>persistent</parameter> controls the use of a persistent
> - connection, the default is &true;.
> - Parameter <parameter>weight</parameter> is the number of buckets to create for this
> - server which in turn control its probability of it being selected. The probability is
> - relative to the total weight of all servers.
> - You can define a <parameter>timeout</parameter> (in seconds), which will be
> - used when connecting to the daemon. Think twice before changing the default
> - value of 1 second - you can loose all the advantages of caching if your connection
> - is too slow.
> - Parameter <parameter>retry_interval</parameter> controls how often a failed server
> - will be retried, the default value is 15 seconds. Neither this nor the
> - <parameter>persistent</parameter> parameter has any effect when this extension
> - is loaded dynamically via <function>dl</function>.
> - </para>
> - <para>
> + pool. The actual connection is established on first use.
> The connection, which was opened using
> <function>Memcache::addServer</function> will be automatically closed at the
> end of script execution. Also you can close it with
> <function>Memcache::close</function>.
> + You can also use the <function>memcache_add_server</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - You can also use the <function>memcache_add_server</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>host</parameter></term>
> + <listitem>
> + <para>
> + Point to the host where memcached is listening for connections.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>port</parameter></term>
> + <listitem>
> + <para>
> + Point to the port where memcached is listening for connections.
> + This parameter is optional and its default value is 11211.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>persistent</parameter></term>
> + <listitem>
> + <para>
> + Controls the use of a persistent connection. Default to &true;.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>weight</parameter></term>
> + <listitem>
> + <para>
> + Number of buckets to create for this server which in turn control its
> + probability of it being selected. The probability is relative to the
> + total weight of all servers.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>timeout</parameter></term>
> + <listitem>
> + <para>
> + Value in seconds which will be used for connecting to the daemon. Think
> + twice before changing the default value of 1 second - you can loose all
> + the advantages of caching if you connection is too slow.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>retry_interval</parameter></term>
> + <listitem>
> + <para>
> + Controls how often a failed server will be retried, the default value
> + is 15 seconds. Neither this nor the <parameter>persistent</parameter>
> + parameter has any effect when this extension is loaded dynamically
> + via <function>dl</function>.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <example>
> - <title><function>Memcache::addServer</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::addServer</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -66,18 +123,22 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::connect</function>,
> - <function>Memcache::pconnect</function> and
> - <function>Memcache::close</function> and
> + <simplelist>
> + <member><function>Memcache::connect</function></member>
> + <member><function>Memcache::pconnect</function></member>
> + <member><function>Memcache::close</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-close">
> <refnamediv>
> <refname>Memcache::close</refname>
> <refpurpose>Close memcached server connection</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::close</methodname>
> <void/>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::close</function> closes connection to memcached
> server. This function doesn't close persistent connections, which are
> closed only during web-server shutdown/restart.
> + Also you can use <function>memcache_close</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> <para>
> - Also you can use <function>memcache_close</function> function.
> - See example below.
> + &return.success;
> </para>
> - <example>
> - <title><function>Memcache::close</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::close</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -43,17 +55,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - <function>Memcache::close</function> returns &false; if an error occured.
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::connect</function>,
> - <function>Memcache::pconnect</function>.
> + <simplelist>
> + <member><function>Memcache::connect</function></member>
> + <member><function>Memcache::pconnect</function></member>
> + </simplelist>
> </para>
> -</refsect1>
> + </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-connect">
> <refnamediv>
> <refname>Memcache::connect</refname>
> <refpurpose>Open memcached server connection</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::connect</methodname>
> <methodparam><type>string</type><parameter>host</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::connect</function> establishes a connection to the
> - memcached server. Parameters <parameter>host</parameter> and
> - <parameter>port</parameter> point to the host and port, where
> - memcached is listening for connections.
> - Parameter <parameter>port</parameter> is optional, it's default value is
> - 11211. Also you can define a <parameter>timeout</parameter> (in seconds), which will be
> - used when connecting to the daemon. Think twice before changing the default
> - value - you can loose all the advantages of caching if your connection is too
> - slow.
> - </para>
> - <para>
> + memcached server.
> The connection, which was opened using
> <function>Memcache::connect</function> will be automatically closed at the
> end of script execution. Also you can close it with
> <function>Memcache::close</function>.
> + Also you can use <function>memcache_connect</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Also you can use <function>memcache_connect</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>host</parameter></term>
> + <listitem>
> + <para>
> + Point to the host where memcached is listening for connections.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>port</parameter></term>
> + <listitem>
> + <para>
> + Point to the port where memcached is listening for connections.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>timeout</parameter></term>
> + <listitem>
> + <para>
> + Value in seconds which will be used for connecting to the daemon. Think
> + twice before changing the default value of 1 second - you can loose all
> + the advantages of caching if you connection is too slow.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <example>
> - <title><function>Memcache::connect</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::connect</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -51,17 +88,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::pconnect</function> and
> - <function>Memcache::close</function>.
> + <simplelist>
> + <member><function>Memcache::pconnect</function></member>
> + <member><function>Memcache::close</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.memcache-debug">
> <refnamediv>
> <refname>memcache_debug</refname>
> <refpurpose>Turn debug output on/off</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>memcache_debug</methodname>
> <methodparam><type>bool</type><parameter>on_off</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>memcache_debug</function> turns on debug output if parameter
> - <parameter>on_off</parameter> is equal to 1 and turns off if it's 0.
> + <parameter>on_off</parameter> is equal to &true; and turns off if it's
> + &false;.
> + <note>
> + <para>
> + <function>memcache_debug</function> is accessible only if PHP was built
> + with --enable-debug option and always returns &true; in this case.
> + Otherwise, this function has no effect and always returns &false;.
> + </para>
> + </note>
> + </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> + <para>
> + <variablelist>
> + <varlistentry>
> + <term><parameter>on_off</parameter></term>
> + <listitem>
> + <para>
> + Turns debug output on if equals to &true;.
> + Turns debug output off if equals to &false;.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + Returns &true; if PHP was built with --enable-debug option, otherwise
> + returns &false;.
> </para>
> - <note>
> - <para>
> - <function>memcache_debug</function> is accessible only if PHP was built
> - with --enable-debug option and always returns &true; in this case.
> - Otherwise, this function has no effect and always returns &false;.
> - </para>
> - </note>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-decrement">
> <refnamediv>
> <refname>Memcache::decrement</refname>
> <refpurpose>Decrement item's value</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>int</type><methodname>Memcache::decrement</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>value</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::decrement</function> decrements value of the
> item by <parameter>value</parameter>. Similarly to
> <function>Memcache::increment</function>, current value of the item is
> being converted to numerical and after that <parameter>value</parameter>
> is substracted.
> + <note>
> + <para>
> + New item's value will not be less than zero.
> + </para>
> + </note>
> + <note>
> + <para>
> + Do not use <function>Memcache::decrement</function> with item, which was
> + stored compressed, because consequent call to
> + <function>Memcache::get</function> will fail.
> + </para>
> + </note>
> + <function>Memcache::decrement</function> <emphasis>does not</emphasis>
> + create an item if it didn't exist.
> + Also you can use <function>memcache_decrement</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Parameter <parameter>value</parameter> is optional. It's default is 1.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>value</parameter></term>
> + <listitem>
> + <para>
> + Optionnal and default to 1.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <note>
> - <para>
> - New item's value will not be less than zero.
> - </para>
> - </note>
> - <note>
> - <para>
> - Do not use <function>Memcache::decrement</function> with item, which was
> - stored compressed, because consequent call to
> - <function>Memcache::get</function> will fail.
> - </para>
> - </note>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> <para>
> - Also you can use <function>memcache_decrement</function> function.
> - See example below.
> + Returns item's new value on success or &false; on failure.
> </para>
> - <example>
> - <title><function>Memcache::decrement</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::decrement</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -56,22 +90,21 @@
> $new_value = $memcache_obj->decrement('test_item', 3);
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - <function>Memcache::decrement</function> <emphasis>does not</emphasis>
> - create an item if it didn't exist.
> - </para>
> - <para>
> - <function>Memcache::decrement</function> returns item's new value on
> - success or &false; on failure.
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::increment</function>,
> - <function>Memcache::replace</function>.
> + <simplelist>
> + <member><function>Memcache::increment</function></member>
> + <member><function>Memcache::replace</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-delete">
> <refnamediv>
> <refname>Memcache::delete</refname>
> <refpurpose>Delete item from the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::delete</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::delete</function> deletes item with the
> <parameter>key</parameter>. If parameter <parameter>timeout</parameter>
> is specified, the item will expire after
> <parameter>timeout</parameter> seconds.
> + Also you can use <function>memcache_delete</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Also you can use <function>memcache_delete</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>timeout</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <example>
> - <title><function>Memcache::delete</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::delete</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -42,12 +76,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> + </programlisting>
> + </example>
> + </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - &return.success;
> + <simplelist>
> + <member><function>Memcache::set</function></member>
> + <member><function>Memcache::replace</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-flush">
> <refnamediv>
> <refname>Memcache::flush</refname>
> <refpurpose>Flush all existing items at the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::flush</methodname>
> <void/>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::flush</function> immediately invalidates all
> existing items. <function>Memcache::flush</function> doesn't
> actually free any resources, it only marks all the items as expired, so
> occupied memory will be overwritten by new items.
> + Also you can use <function>memcache_flush</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> <para>
> - Also you can use <function>memcache_flush</function> function.
> - See example below.
> + &return.success;
> </para>
> - <example>
> - <title><function>Memcache::flush</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::flush</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -41,12 +53,11 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-get">
> <refnamediv>
> <refname>Memcache::get</refname>
> <refpurpose>Retrieve item from the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>string</type><methodname>Memcache::get</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> @@ -15,14 +16,44 @@
> <type>string</type><methodname>Memcache::get</methodname>
> <methodparam><type>array</type><parameter>keys</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::get</function> returns previously stored data if
> an item with such <parameter>key</parameter> exists on the server at this
> moment.
> </para>
> - <example>
> - <title><function>Memcache::get</function> example</title>
> - <programlisting role="php">
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> + <para>
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + Returns the string associated with the <parameter>key</parameter> or
> + &false; on failure or if such <parameter>key</parameter> was not found.
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::get</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -52,13 +83,11 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - <function>Memcache::get</function> returns &false; on failure or
> - if such <parameter>key</parameter> was not found.
> + </programlisting>
> + </example>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-getExtendedStats">
> <refnamediv>
> <refname>Memcache::getExtendedStats</refname>
> <refpurpose>Get statistics from all servers in pool</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>array</type><methodname>Memcache::getExtendedStats</methodname>
> <void/>
> </methodsynopsis>
> +
> <para>
> - <function>Memcache::getExtendedStats</function> returns an two-dimensional
> + <function>Memcache::getExtendedStats</function> returns a two-dimensional
> associative array with server statistics. Array keys correspond to
> host:port of server and values contain the individual server statistics.
> A failed server will have its corresponding entry set to &false;.
> + You can also use the <function>memcache_get_extended_stats</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + Returns a two-dimensional associative array of server statistics or &false;
> + on failure.
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> <para>
> - <informalexample>
> + <example>
> + <title><function>Memcache::getExtendedStats</function> example</title>
> <programlisting role="php">
> <![CDATA[
> -<pre>
> <?php
> $memcache_obj = new Memcache;
> $memcache_obj->addServer('memcache_host', 11211);
> @@ -30,13 +46,11 @@
> $stats = $memcache_obj->getExtendedStats();
> print_r($stats);
> ?>
> -</pre>
> ]]>
> - </programlisting>
> - &example.outputs;
> - <screen>
> + </programlisting>
> + &example.outputs;
> + <screen>
> <![CDATA[
> -<pre>
> Array
> (
> [memcache_host:11211] => Array
> @@ -64,24 +78,22 @@
>
> [failed_host:11211] => false
> )
> -</pre>
> ]]>
> </screen>
> - </informalexample>
> - </para>
> - <para>
> - You can also use the <function>memcache_get_extended_stats</function> function.
> - </para>
> - <para>
> - <function>Memcache::getExtendedStats</function> returns &false; in case of an
> - error.
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::getVersion</function>.
> - <function>Memcache::getStats</function>.
> + <simplelist>
> + <member><function>Memcache::getVersion</function></member>
> + <member><function>Memcache::getStats</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-getStats">
> <refnamediv>
> <refname>Memcache::getStats</refname>
> <refpurpose>Get statistics of the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>array</type><methodname>Memcache::getStats</methodname>
> <void/>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::getStats</function> returns an associative array
> with server's statistics. Array keys correspond to stats parameters and
> values to parameter's values.
> - </para>
> - <para>
> Also you can use <function>memcache_get_stats</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> <para>
> - <function>Memcache::getStats</function> returns &false; in case of an
> - error.
> + Returns an associative array of server statistics or &false; on failure.
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::getVersion</function>.
> - <function>Memcache::getExtendedStats</function>.
> + <simplelist>
> + <member><function>Memcache::getVersion</function></member>
> + <member><function>Memcache::getExtendedStats</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-getVersion">
> <refnamediv>
> <refname>Memcache::getVersion</refname>
> <refpurpose>Return version of the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>string</type><methodname>Memcache::getVersion</methodname>
> <void/>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::getVersion</function> returns a string with server's
> version number.
> + Also you can use <function>memcache_get_version</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> <para>
> - Also you can use <function>memcache_get_version</function> function.
> - See example below.
> + Returns a string of server version number or &false; on failure.
> </para>
> - <example>
> - <title><function>Memcache::getVersion</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::getVersion</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -36,17 +48,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - <function>Memcache::getVersion</function> returns &false; if an error
> - occured.
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::getStats</function>.
> + <simplelist>
> + <member><function>Memcache::getExtendedStats</function></member>
> + <member><function>Memcache::getStats</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-increment">
> <refnamediv>
> <refname>Memcache::increment</refname>
> <refpurpose>Increment item's value</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>int</type><methodname>Memcache::increment</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>value</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::increment</function> increments value of the item on
> the specified <parameter>value</parameter>. If item with key
> <parameter>key</parameter> was not numeric and cannot be converted to
> number, it will change it's value to <parameter>value</parameter>.
> + <function>Memcache::increment</function> <emphasis>does not</emphasis>
> + create an item if it didn't exist.
> + <note>
> + <para>
> + Do not use <function>Memcache::increment</function> with item, which was
> + stored compressed, because consequent call to
> + <function>Memcache::get</function> will fail.
> + </para>
> + </note>
> + Also you can use <function>memcache_increment</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Parameter <parameter>value</parameter> is optional. It's default value is
> - 1.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>value</parameter></term>
> + <listitem>
> + <para>
> + Optional and default to 1.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <note>
> - <para>
> - Do not use <function>Memcache::increment</function> with item, which was
> - stored compressed, because consequent call to
> - <function>Memcache::get</function> will fail.
> - </para>
> - </note>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> <para>
> - Also you can use <function>memcache_increment</function> function.
> - See example below.
> + Returns new item's value on success or &false; on failure.
> </para>
> - <example>
> - <title><function>Memcache::increment</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::increment</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -52,22 +85,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - <function>Memcache::increment</function> returns new item's value on
> - success or &false; on failure.
> - </para>
> - <para>
> - <function>Memcache::increment</function> <emphasis>does not</emphasis>
> - create an item if it didn't exist.
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::decrement</function>,
> - <function>Memcache::replace</function>.
> + <simplelist>
> + <member><function>Memcache::decrement</function></member>
> + <member><function>Memcache::replace</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-pconnect">
> <refnamediv>
> <refname>Memcache::pconnect</refname>
> <refpurpose>Open memcached server persistent connection</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::pconnect</methodname>
> <methodparam><type>string</type><parameter>host</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::pconnect</function> is similar to
> <function>Memcache::connect</function> with the difference, that
> the connection it establishes is persistent.
> This connection is not closed after the end of script execution and
> by <function>Memcache::close</function> function.
> + Also you can use <function>memcache_pconnect</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Also you can use <function>memcache_pconnect</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>host</parameter></term>
> + <listitem>
> + <para>
> + Point to the host where memcached is listening for connections.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>port</parameter></term>
> + <listitem>
> + <para>
> + Point to the port where memcached is listening for connections.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>timeout</parameter></term>
> + <listitem>
> + <para>
> + Value in seconds which will be used for connecting to the daemon. Think
> + twice before changing the default value of 1 second - you can loose all
> + the advantages of caching if you connection is too slow.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> </para>
> - <example>
> - <title><function>Memcache::pconnect</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::pconnect</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -40,16 +86,20 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::connect</function>.
> + <simplelist>
> + <member><function>Memcache::connect</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-replace">
> <refnamediv>
> <refname>Memcache::replace</refname>
> <refpurpose>Replace value of the existing item</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::replace</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> @@ -14,20 +15,67 @@
> <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>expire</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::replace</function> should be used to replace value of
> existing item with <parameter>key</parameter>. In case if item with such
> key doesn't exists, <function>Memcache::replace</function> returns
> &false;. For the rest <function>Memcache::replace</function> behaves
> similarly to <function>Memcache::set</function>.
> + Also you can use <function>memcache_replace</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Also you can use <function>memcache_replace</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>var</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>flag</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>expire</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> </para>
> - <example>
> - <title><function>Memcache::replace</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::replace</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -41,17 +89,21 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::set</function>,
> - <function>Memcache::add</function>.
> + <simplelist>
> + <member><function>Memcache::set</function></member>
> + <member><function>Memcache::add</function></member>
> + </simplelist>
> </para>
> </refsect1>
> +
> </refentry>
>
> 
> +
> <refentry id="function.Memcache-set">
> <refnamediv>
> <refname>Memcache::set</refname>
> <refpurpose>Store data at the server</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::set</methodname>
> <methodparam><type>string</type><parameter>key</parameter></methodparam>
> @@ -14,6 +15,7 @@
> <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
> <methodparam choice="opt"><type>int</type><parameter>expire</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::set</function> stores an item
> <parameter>var</parameter> with <parameter>key</parameter> on the
> @@ -21,26 +23,70 @@
> time in seconds. If it's 0, the item never expires (but memcached server
> doesn't guarantee this item to be stored all the time, it could be deleted
> from the cache to make place for other items).
> - </para>
> - <para>
> You can use <constant>MEMCACHE_COMPRESSED</constant> constant as
> <parameter>flag</parameter> value if you want to use on-the-fly
> compression (uses zlib).
> + <note>
> + <para>
> + Remember that resource variables (i.e. file and connection descriptors)
> + cannot be stored in the cache, because they cannot be adequately
> + represented in serialized state.
> + </para>
> + </note>
> + Also you can use <function>memcache_set</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - Also you can use <function>memcache_set</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>key</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>var</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>flag</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>expire</parameter></term>
> + <listitem>
> + <para>
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> </para>
> - <note>
> - <para>
> - Remember that resource variables (i.e. file and connection descriptors)
> - cannot be stored in the cache, because they cannot be adequately
> - represented in serialized state.
> - </para>
> - </note>
> - <example>
> - <title><function>Memcache::set</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> + </para>
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::set</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
> /* procedural API */
> @@ -59,11 +105,11 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <example>
> - <title><function>Memcache::set</function> example</title>
> - <programlisting role="php">
> + </programlisting>
> + </example>
> + <example>
> + <title><function>Memcache::set</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
> /* OO API */
> @@ -83,15 +129,18 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> + </refsect1>
> +
> + <refsect1 role="seealso">
> + &reftitle.seealso;
> <para>
> - See also
> - <function>Memcache::add</function>,
> - <function>Memcache::replace</function>.
> + <simplelist>
> + <member><function>Memcache::add</function></member>
> + <member><function>Memcache::replace</function></member>
> + </simplelist>
> </para>
> </refsect1>
> </refentry>
> http://cvs.php.net/viewcvs.cgi/phpd...2&diff_format=u
> Index: phpdoc/en/reference/memcache/functions/memcache-setcompressthreshold.xml
> diff -u phpdoc/en/reference/memcache/functions/memcache-setcompressthreshold.xml:1.1 phpdoc/en/reference/memcache/functions/memcache-setcompressthreshold.xml:1.2
> --- phpdoc/en/reference/memcache/functions/memcache-setcompressthreshold.xml:1.1 Fri Dec 23 16:17:38 2005
> +++ phpdoc/en/reference/memcache/functions/memcache-setcompressthreshold.xml Fri Dec 23 19:52:06 2005
> @@ -1,33 +1,66 @@
> <?xml version="1.0" encoding="iso-8859-1"?>
> -
> +
> <refentry id="function.Memcache-setCompressThreshold">
> <refnamediv>
> <refname>Memcache::setCompressThreshold</refname>
> <refpurpose>Enable automatic compression of large values</refpurpose>
> </refnamediv>
> - <refsect1>
> - <title>Description</title>
> +
> + <refsect1 role="description">
> + &reftitle.description;
> <methodsynopsis>
> <type>bool</type><methodname>Memcache::setCompressThreshold</methodname>
> <methodparam><type>int</type><parameter>threshold</parameter></methodparam>
> <methodparam choice="opt"><type>float</type><parameter>min_savings</parameter></methodparam>
> </methodsynopsis>
> +
> <para>
> <function>Memcache::setCompressThreshold</function> enables automatic
> - compression of large values. Parameter <parameter>threshold</parameter>
> - controls the minimum value length before attempting to compress automatically.
> - Parameter <parameter>min_savings</parameter> specifies the minimum amount
> - of savings to actually store the value compressed. The supplied value
> - must be between 0 and 1. Default value is 0.2 giving a minimum 20%
> - compression savings.
> + compression of large values.
> + You can also use the <function>memcache_set_compress_threshold</function> function.
> </para>
> +
> + </refsect1>
> +
> + <refsect1 role="parameters">
> + &reftitle.parameters;
> <para>
> - You can also use the <function>memcache_set_compress_threshold</function> function.
> - See example below.
> + <variablelist>
> + <varlistentry>
> + <term><parameter>threshold</parameter></term>
> + <listitem>
> + <para>
> + Controls the minimum value length before attempting to compress automatically.
> + </para>
> + </listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><parameter>min_saving</parameter></term>
> + <listitem>
> + <para>
> + Specifies the minimum amount of savings to actually store the value
> + compressed. The supplied value must be between 0 and 1. Default value
> + is 0.2 giving a minimum 20% compression savings.
> + </para>
> + </listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> + </refsect1>
> +
> + <refsect1 role="returnvalues">
> + &reftitle.returnvalues;
> + <para>
> + &return.success;
> </para>
> - <example>
> - <title><function>Memcache::setCompressThreshold</function> example</title>
> - <programlisting role="php">
> + </refsect1>
> +
> + <refsect1 role="examples">
> + &reftitle.examples;
> + <para>
> + <example>
> + <title><function>Memcache::setCompressThreshold</function> example</title>
> + <programlisting role="php">
> <![CDATA[
> <?php
>
> @@ -44,12 +77,11 @@
>
> ?>
> ]]>
> - </programlisting>
> - </example>
> - <para>
> - &return.success;
> + </programlisting>
> + </example>
> </para>
> </refsect1>
> +
> </refentry>
>
> <!-- Keep this comment at the end of the file
>[/color]

Antony Dovgal

2006-01-09, 8:02 pm

On 23.12.2005 22:53, Jean-Sebastien Goupil wrote:
> I have just transformed the memcache documentation to the new style.
> I would like you to double check if everything is correct. Some
> parameters are note explained because I didn't check in the C files to
> understand their meanings (add, decrement, delete, get, increment, replace).

Actually they are explained on each page..

> For the memcache:get(), I was wondering if it I should put only one
> method but with a mixed parameter.

No, I'd prefer to have two method prototypes in this case.

> You should also check the returns
> values for this method... Does it return an array if I pass an array as
> argument ?

Yup. I'll fix it.

> I wondering if the previous form (memcache_...) should be deleted or put
> in an history table...

Definitely no, both forms - procedural and OO coexist in the same time.

> I let you make these modifications :)

Ok, I'll add some more descriptions later.

--
Wbr,
Antony Dovgal

Sponsored Links