From 802da4533fd05b43d8bde1a73ac01f2421c993c6 Mon Sep 17 00:00:00 2001 From: Andrei Zmievski 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 @@ - + @@ -54,6 +54,7 @@ Creating a Memcached object - + @@ -60,7 +60,8 @@ &reftitle.returnvalues; &return.success; - Use Memcached::getResultCode if necessary. + The Memcached::getResultCode will return + Memcached::RES_NOTFOUND if the key does not exist. 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 @@ - + @@ -60,7 +60,8 @@ &reftitle.returnvalues; &return.success; - Use Memcached::getResultCode if necessary. + The Memcached::getResultCode will return + Memcached::RES_NOTFOUND if the key does not exist. 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 @@ - + Memcached::flush - The flush purpose + Invalidate all items in the cache &reftitle.description; - public voidMemcached::flush - stringexpiration + public boolMemcached::flush + intdelay - The method description goes here. + Memcached::flush invalidates all existing cache items + immediately (by default) or after the delay + 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 Memcached::flush 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. @@ -23,10 +29,10 @@ - expiration + delay - Description... + Numer of seconds to wait before invalidating the items. @@ -37,7 +43,8 @@ &reftitle.returnvalues; - Description... + &return.success; + Use Memcached::getResultCode if necessary. @@ -49,29 +56,18 @@ addServer('localhost', 11211); + +/* flush all items in 10 seconds */ +$m->flush(10); ?> ]]> - &example.outputs.similar; - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -