ZF-10560: added documentation for cache backend Libmemcached

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@23148 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Cache-Backends.xml

@@ -274,6 +274,82 @@
         </table>
     </sect2>
 
+    <sect2 id="zend.cache.backends.libmemcached">
+        <title>Zend_Cache_Backend_Libmemcached</title>
+
+        <para>
+            This (extended) backend stores cache records into a memcached server. <ulink
+                url="http://www.danga.com/memcached/">memcached</ulink> is a high-performance,
+            distributed memory object caching system. To use this backend, you need a memcached
+            daemon and <ulink url="http://pecl.php.net/package/memcached">the memcached
+                <acronym>PECL</acronym> extension</ulink>.
+        </para>
+
+        <para>
+            Be careful : with this backend, "tags" are not supported for the moment as
+            the "doNotTestCacheValidity=true" argument.
+        </para>
+
+        <para>
+            Available options are :
+        </para>
+
+        <table id="zend.cache.backends.libmemcached.table">
+            <title>Libmemcached Backend Options</title>
+
+            <tgroup cols="4">
+                <thead>
+                    <row>
+                        <entry>Option</entry>
+                        <entry>Data Type</entry>
+                        <entry>Default Value</entry>
+                        <entry>Description</entry>
+                    </row>
+                </thead>
+
+                <tbody>
+                    <row>
+                        <entry><emphasis>servers</emphasis></entry>
+                        <entry><type>Array</type></entry>
+
+                        <entry>
+                            <command>array(array('host' => 'localhost', 'port' => 11211,
+                            'weight' => 1))</command>
+                        </entry>
+
+                        <entry>
+                            An array of memcached servers ; each memcached server is described by
+                            an associative array:
+                            'host' => (string) : the name of the memcached server,
+                            'port' => (int) : the port of the memcached server,
+                            'weight' => (int) :the weight of the memcached server
+                        </entry>
+                    </row>
+                    <row>
+                        <entry><emphasis>client</emphasis></entry>
+                        <entry><type>Array</type></entry>
+
+                        <entry>
+                            <command>array(
+                                Memcached::OPT_DISTRIBUTION => Memcached::DISTRIBUTION_CONSISTENT,
+                                Memcached::OPT_HASH => Memcached::HASH_MD5,
+                                Memcached::OPT_LIBKETAMA_COMPATIBLE => true
+                            )</command>
+                        </entry>
+
+                        <entry>
+                            An associative array of memcached client options ;
+                            The array key can be the name of the memcached option constant
+                            (without 'OPT_') or the integer value of it.
+                            See <ulink url="http://php.net/manual/memcached.constants.php">
+                                Memcached constants on <acronym>PHP</acronym> manual</ulink>
+                        </entry>
+                    </row>
+                </tbody>
+            </tgroup>
+        </table>
+    </sect2>
+
     <sect2 id="zend.cache.backends.apc">
         <title>Zend_Cache_Backend_Apc</title>
 

documentation/manual/en/ref/requirements-php-extensions-table.xml

@@ -692,6 +692,21 @@
                 <entry>
                     <emphasis>
                         <ulink
+                            url="&php.manual.link;/ref.memcached.php">memcached</ulink>
+                    </emphasis>
+                </entry>
+                <entry>&requirements.hard;</entry>
+                <entry>
+                    <ulink
+                        url="&zf.manual.link;/zend.cache.backends.html">
+                        <classname>Zend_Cache_Backend_Libmemcached</classname>
+                    </ulink>
+                </entry>
+            </row>
+            <row>
+                <entry>
+                    <emphasis>
+                        <ulink
                             url="&php.manual.link;/ref.mhash.php">mhash</ulink>
                     </emphasis>
                 </entry>

documentation/manual/en/ref/requirements-zendcomponents-table.xml

@@ -97,7 +97,7 @@
                 </entry>
             </row>
             <row>
-                <entry morerows="3" valign="middle">
+                <entry morerows="4" valign="middle">
                     <emphasis>
                         <ulink
                             url="&zf.manual.link;/zend.cache.html">
@@ -105,7 +105,7 @@
                         </ulink>
                     </emphasis>
                 </entry>
-                <entry morerows="3" valign="middle">&requirements.hard;</entry>
+                <entry morerows="4" valign="middle">&requirements.hard;</entry>
                 <entry>
                     <ulink
                         url="&php.manual.link;/ref.apc.php">apc</ulink>
@@ -120,6 +120,12 @@
             <row>
                 <entry>
                     <ulink
+                        url="&php.manual.link;/ref.memcached.php">memcached</ulink>
+                </entry>
+            </row>
+            <row>
+                <entry>
+                    <ulink
                         url="&php.manual.link;/ref.sqlite.php">sqlite</ulink>
                 </entry>
             </row>