From 802da4533fd05b43d8bde1a73ac01f2421c993c6 Mon Sep 17 00:00:00 2001
From: Andrei Zmievski <andrei@php.net>
Date: Tue, 3 Feb 2009 21:53:07 +0000
Subject: [PATCH] Document delete* and flush

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275126 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/memcached/memcached/construct.xml   |  3 +-
 reference/memcached/memcached/delete.xml      |  5 +-
 reference/memcached/memcached/deletebykey.xml |  5 +-
 reference/memcached/memcached/flush.xml       | 44 +++++-----
 reference/memcached/versions.xml              | 80 -------------------
 5 files changed, 28 insertions(+), 109 deletions(-)
 delete mode 100644 reference/memcached/versions.xml

diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml
index 81967f4848..52fb22dc99 100644
--- a/reference/memcached/memcached/construct.xml
+++ b/reference/memcached/memcached/construct.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 
 <refentry xml:id="memcached.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -54,6 +54,7 @@
     <title>Creating a Memcached object</title>
     <programlisting role="php">
 <![CDATA[
+<?php
 /* Create a regular instance */
 $m1 = new Memcached();
 echo get_class($m);
diff --git a/reference/memcached/memcached/delete.xml b/reference/memcached/memcached/delete.xml
index 2201566bfb..3fd91ae2d3 100644
--- a/reference/memcached/memcached/delete.xml
+++ b/reference/memcached/memcached/delete.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 
 <refentry xml:id="memcached.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -60,7 +60,8 @@
   &reftitle.returnvalues;
   <para>
    &return.success;
-   Use <methodname>Memcached::getResultCode</methodname> if necessary.
+   The <methodname>Memcached::getResultCode</methodname> will return
+   <constant>Memcached::RES_NOTFOUND</constant> if the key does not exist.
   </para>
  </refsect1>
 
diff --git a/reference/memcached/memcached/deletebykey.xml b/reference/memcached/memcached/deletebykey.xml
index a96c9b01e4..2b6ee0380d 100644
--- a/reference/memcached/memcached/deletebykey.xml
+++ b/reference/memcached/memcached/deletebykey.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 
 <refentry xml:id="memcached.deletebykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -60,7 +60,8 @@
   &reftitle.returnvalues;
   <para>
    &return.success;
-   Use <methodname>Memcached::getResultCode</methodname> if necessary.
+   The <methodname>Memcached::getResultCode</methodname> will return
+   <constant>Memcached::RES_NOTFOUND</constant> if the key does not exist.
   </para>
  </refsect1>
 
diff --git a/reference/memcached/memcached/flush.xml b/reference/memcached/memcached/flush.xml
index b8aa30cd33..197da1640d 100644
--- a/reference/memcached/memcached/flush.xml
+++ b/reference/memcached/memcached/flush.xml
@@ -1,20 +1,26 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="memcached.flush" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Memcached::flush</refname>
-  <refpurpose>The flush purpose</refpurpose>
+  <refpurpose>Invalidate all items in the cache</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Memcached::flush</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>expiration</parameter></methodparam>
+   <modifier>public</modifier> <type>bool</type><methodname>Memcached::flush</methodname>
+   <methodparam choice="opt"><type>int</type><parameter>delay</parameter></methodparam>
   </methodsynopsis>
   <para>
-   The method description goes here.
+   <function>Memcached::flush</function> invalidates all existing cache items
+   immediately (by default) or after the <parameter>delay</parameter>
+   specified. After invalidation none of the items will be returned in
+   response to a retrieval command (unless it's stored again under the same
+   key after <function>Memcached::flush</function> has invalidated the items).
+   The flush does not actually free all the memory taken up by the existing
+   items; that will happen gradually as new items are stored.
   </para>
  </refsect1>
 
@@ -23,10 +29,10 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>expiration</parameter></term>
+     <term><parameter>delay</parameter></term>
      <listitem>
       <para>
-       Description...
+       Numer of seconds to wait before invalidating the items.
       </para>
      </listitem>
     </varlistentry>
@@ -37,7 +43,8 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   &return.success;
+   Use <methodname>Memcached::getResultCode</methodname> if necessary.
   </para>
  </refsect1>
 
@@ -49,29 +56,18 @@
     <programlisting role="php">
 <![CDATA[
 <?php
-/* ... */
+$m = new Memcached();
+$m->addServer('localhost', 11211);
+
+/* flush all items in 10 seconds */
+$m->flush(10);
 ?>
 ]]>
     </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
    </example>
   </para>
  </refsect1>
 
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
-   </simplelist>
-  </para>
- </refsect1>
-
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/memcached/versions.xml b/reference/memcached/versions.xml
deleted file mode 100644
index 7f0e49bb6c..0000000000
--- a/reference/memcached/versions.xml
+++ /dev/null
@@ -1,80 +0,0 @@
-<?xml version='1.0' encoding='utf-8'?>
-<!-- $Revision: 1.1 $ -->
-<!--
-  Do NOT translate this file
--->
-<!--
-Example entries:
- <function name='classname::methodname' from='PECL extname &gt;= 1.1'/>
- <function name='functionname' from='PHP &gt;= 5.3.0'/>
- <function name='functionname' from='PHP 5'/>
--->
-<versions>
- <!-- Functions -->
- <!-- Methods -->
- <function name='memcached::__construct' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getresultcode' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::get' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getmulti' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getmultibykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getdelayed' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getdelayedbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::fetch' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::fetchall' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::set' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::setbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::setmulti' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::setmultibykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::cas' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::casbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::add' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::addbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::append' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::appendbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::prepend' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::prependbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::replace' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::replacebykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::delete' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::deletebykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::increment' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::decrement' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::addserver' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getserverlist' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getserverbykey' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getstats' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::flush' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::getoption' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcached::setoption' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::__clone' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::__construct' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::getmessage' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::getcode' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::getfile' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::getline' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::gettrace' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::gettraceasstring' from='PHP 5 &gt;= 5.2.0'/>
- <function name='memcachedexception::__tostring' from='PHP 5 &gt;= 5.2.0'/>
-</versions>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-indent-tabs-mode:nil
-sgml-parent-document:nil
-sgml-default-dtd-file:"../../../manual.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
-vim600: syn=xml fen fdm=syntax fdl=2 si
-vim: et tw=78 syn=sgml
-vi: ts=1 sw=1
--->