From 269007e0f5cbe398e94856509963a0b3c6144b58 Mon Sep 17 00:00:00 2001
From: Andrei Zmievski <andrei@php.net>
Date: Tue, 3 Feb 2009 00:59:04 +0000
Subject: [PATCH] memcached docs progress

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275074 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/memcached/memcached/add.xml      | 50 +++++++-------------
 reference/memcached/memcached/addbykey.xml | 54 ++++++++--------------
 reference/memcached/memcached/set.xml      |  8 ++--
 reference/memcached/memcached/setbykey.xml |  4 +-
 4 files changed, 44 insertions(+), 72 deletions(-)

diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml
index 1c73ca5c8f..d365ccfb29 100644
--- a/reference/memcached/memcached/add.xml
+++ b/reference/memcached/memcached/add.xml
@@ -1,22 +1,24 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="memcached.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Memcached::add</refname>
-  <refpurpose>The add purpose</refpurpose>
+  <refpurpose>Add data under a new key</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Memcached::add</methodname>
+   <modifier>public</modifier> <type>bool</type><methodname>Memcached::add</methodname>
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
-   <methodparam><type>string</type><parameter>value</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
+   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>expiration</parameter></methodparam>
   </methodsynopsis>
   <para>
-   The method description goes here.
+   <function>Memcached::add</function> is similar to
+   <methodname>Memcached::set</methodname>, but the operation fails if the
+   <parameter>key</parameter> already exists on the server.
   </para>
  </refsect1>
 
@@ -28,7 +30,7 @@
      <term><parameter>key</parameter></term>
      <listitem>
       <para>
-       Description...
+       The key under which to store the value.
       </para>
      </listitem>
     </varlistentry>
@@ -36,7 +38,7 @@
      <term><parameter>value</parameter></term>
      <listitem>
       <para>
-       Description...
+       The value to store.
       </para>
      </listitem>
     </varlistentry>
@@ -44,7 +46,7 @@
      <term><parameter>expiration</parameter></term>
      <listitem>
       <para>
-       Description...
+       The expiration time of the value, as a Unix timestamp.
       </para>
      </listitem>
     </varlistentry>
@@ -55,29 +57,9 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
-  </para>
- </refsect1>
-
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>Memcached::add</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
+   &return.success;
+   The <methodname>Memcached::getResultCode</methodname> will return
+   <constant>Memcached::RES_NOTSTORED</constant> if the key already exists.
   </para>
  </refsect1>
 
@@ -85,7 +67,9 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>Memcached::addByKey</methodname></member>
+    <member><methodname>Memcached::set</methodname></member>
+    <member><methodname>Memcached::replace</methodname></member>
    </simplelist>
   </para>
  </refsect1>
diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml
index daab44877a..ed53b766f5 100644
--- a/reference/memcached/memcached/addbykey.xml
+++ b/reference/memcached/memcached/addbykey.xml
@@ -1,23 +1,27 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="memcached.addbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Memcached::addByKey</refname>
-  <refpurpose>The addByKey purpose</refpurpose>
+  <refpurpose>Add data under a new key on a specific server</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Memcached::addByKey</methodname>
+   <modifier>public</modifier> <type>bool</type><methodname>Memcached::addByKey</methodname>
    <methodparam><type>string</type><parameter>server_key</parameter></methodparam>
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
-   <methodparam><type>string</type><parameter>value</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
+   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>expiration</parameter></methodparam>
   </methodsynopsis>
   <para>
-   The method description goes here.
+   <function>Memcached::addByKey</function> is functionally equivalent to
+   <methodname>Memcached::add</methodname>, except that the free-form
+   <parameter>server_key</parameter> can be used to map the
+   <parameter>key</parameter> to a specific server. This is useful if you need
+   to keep a bunch of related keys on a certain server.
   </para>
  </refsect1>
 
@@ -29,7 +33,7 @@
      <term><parameter>server_key</parameter></term>
      <listitem>
       <para>
-       Description...
+       The key identifying the server to store the value on.
       </para>
      </listitem>
     </varlistentry>
@@ -37,7 +41,7 @@
      <term><parameter>key</parameter></term>
      <listitem>
       <para>
-       Description...
+       The key under which to store the value.
       </para>
      </listitem>
     </varlistentry>
@@ -45,7 +49,7 @@
      <term><parameter>value</parameter></term>
      <listitem>
       <para>
-       Description...
+       The value to store.
       </para>
      </listitem>
     </varlistentry>
@@ -53,7 +57,7 @@
      <term><parameter>expiration</parameter></term>
      <listitem>
       <para>
-       Description...
+       The expiration time of the value, as a Unix timestamp.
       </para>
      </listitem>
     </varlistentry>
@@ -64,29 +68,9 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
-  </para>
- </refsect1>
-
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>Memcached::addByKey</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
+   &return.success;
+   The <methodname>Memcached::getResultCode</methodname> will return
+   <constant>Memcached::RES_NOTSTORED</constant> if the key already exists.
   </para>
  </refsect1>
 
@@ -94,7 +78,9 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>Memcached::add</methodname></member>
+    <member><methodname>Memcached::set</methodname></member>
+    <member><methodname>Memcached::replace</methodname></member>
    </simplelist>
   </para>
  </refsect1>
diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml
index d3dd487acb..c409ada460 100644
--- a/reference/memcached/memcached/set.xml
+++ b/reference/memcached/memcached/set.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 
 <refentry xml:id="memcached.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Memcached::set</refname>
-  <refpurpose>Store data for a key</refpurpose>
+  <refpurpose>Store data under a key</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -24,7 +24,7 @@
    server deletes it to make space for new items.
    <para>The value can be any valid PHP type except for resources, because
    those cannot be represented in a serialized form. If the
-   <constant>OPT_COMPRESSION</constant> option is turned on, the serialized
+   <constant>Memcached::OPT_COMPRESSION</constant> option is turned on, the serialized
    value will also be compressed before storage.</para>
   </para>
  </refsect1>
@@ -118,6 +118,8 @@ object(stdClass)#1 (0) {
   <para>
    <simplelist>
     <member><methodname>Memcached::setByKey</methodname></member>
+    <member><methodname>Memcached::add</methodname></member>
+    <member><methodname>Memcached::replace</methodname></member>
    </simplelist>
   </para>
  </refsect1>
diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml
index 2daf8d7547..f44b5ee5a6 100644
--- a/reference/memcached/memcached/setbykey.xml
+++ b/reference/memcached/memcached/setbykey.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 
 <refentry xml:id="memcached.setbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Memcached::setByKey</refname>
-  <refpurpose>Store data for a key on a specific server</refpurpose>
+  <refpurpose>Store data under a key on a specific server</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">