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

[Antony Dovgal]

tony2001                Wed Jan 12 14:03:52 2005 EDT

  Modified files:              
    /phpdoc/en/reference/memcache/functions     memcache-get.xml 
  Log:
  describe multi-get and clarify the result value if the item wasn't found
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/memcache/functions/memcache-get.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/memcache/functions/memcache-get.xml
diff -u phpdoc/en/reference/memcache/functions/memcache-get.xml:1.1 
phpdoc/en/reference/memcache/functions/memcache-get.xml:1.2
--- phpdoc/en/reference/memcache/functions/memcache-get.xml:1.1 Tue Sep 28 
08:23:52 2004
+++ phpdoc/en/reference/memcache/functions/memcache-get.xml     Wed Jan 12 
14:03:52 2005
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.Memcache-get">
  <refnamediv>
   <refname>Memcache::get</refname>
@@ -11,6 +11,10 @@
    <type>mixed</type><methodname>Memcache::get</methodname>
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
   </methodsynopsis>
+  <methodsynopsis>
+   <type>mixed</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
@@ -31,12 +35,28 @@
 $memcache_obj->connect('memcache_host', 11211);
 $var = $memcache_obj->get('some_key');
 
+/* 
+You also can use array of keys as a parameter.
+If such item wasn't found at the server, the result
+array simply will not include such key.
+*/
+
+/* procedural API */
+$memcache_obj = memcache_connect('memcache_host', 11211);
+$var = memcache_get($memcache_obj, Array('some_key', 'another_key'));
+
+/* OO API */
+$memcache_obj = new Memcache;
+$memcache_obj->connect('memcache_host', 11211);
+$var = $memcache_obj->get((Array('some_key', 'second_key'));
+
 ?>
 ]]>
    </programlisting>
   </example>
   <para>
-   <function>Memcache::get</function> returns &false; on failure.
+   <function>Memcache::get</function> returns &false; on failure or
+   if such <parameter>key</parameter> was not found.
   </para>
  </refsect1>
 </refentry>