From 9918e9e6cece3764fae4ef8d1d1c5de04d31fe97 Mon Sep 17 00:00:00 2001 From: Andrei Zmievski Date: Tue, 3 Feb 2009 22:43:50 +0000 Subject: [PATCH] - Document increment/decrement - Fix up stuff. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275152 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/memcached/memcached/add.xml | 4 +- reference/memcached/memcached/addbykey.xml | 4 +- reference/memcached/memcached/construct.xml | 5 +-- reference/memcached/memcached/decrement.xml | 40 +++++++++++++------ reference/memcached/memcached/increment.xml | 40 +++++++++++++------ reference/memcached/memcached/replace.xml | 4 +- .../memcached/memcached/replacebykey.xml | 4 +- reference/memcached/memcached/set.xml | 4 +- reference/memcached/memcached/setbykey.xml | 4 +- reference/memcached/memcached/setmulti.xml | 18 ++++----- .../memcached/memcached/setmultibykey.xml | 10 ++--- 11 files changed, 84 insertions(+), 53 deletions(-) diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml index a23a2e372e..5fe84ad064 100644 --- a/reference/memcached/memcached/add.xml +++ b/reference/memcached/memcached/add.xml @@ -1,10 +1,10 @@ - + Memcached::add - Add data under a new key + Add an item under a new key diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml index e0c6c65e91..f8ed1defd3 100644 --- a/reference/memcached/memcached/addbykey.xml +++ b/reference/memcached/memcached/addbykey.xml @@ -1,10 +1,10 @@ - + Memcached::addByKey - Add data under a new key on a specific server + Add an item under a new key on a specific server diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml index 52fb22dc99..be0081b6be 100644 --- a/reference/memcached/memcached/construct.xml +++ b/reference/memcached/memcached/construct.xml @@ -1,11 +1,10 @@ - + Memcached::__construct - Creates a Memcached instance representing the connection to the - memcache servers + Create a Memcached instance diff --git a/reference/memcached/memcached/decrement.xml b/reference/memcached/memcached/decrement.xml index b97ab1dc4a..97762af22a 100644 --- a/reference/memcached/memcached/decrement.xml +++ b/reference/memcached/memcached/decrement.xml @@ -1,21 +1,26 @@ - + Memcached::decrement - The decrement purpose + Decrement numeric item's value &reftitle.description; - public voidMemcached::decrement + public boolMemcached::decrement stringkey - stringoffset + intoffset - The method description goes here. + Memcached::decrement decrements a numeric item's value + by the specified offset. If the item's value is not + numeric, it is treated as if the value were 0. If the operation would + decrease the value below 0, the new value will be 0. + Memcached::decrement will fail if the item does not + exist. @@ -27,7 +32,7 @@ key - Description... + The key of the item to decrement. @@ -35,7 +40,7 @@ offset - Description... + The amount by which to decrement the item's value; defaults to 1. @@ -46,7 +51,9 @@ &reftitle.returnvalues; - Description... + &return.success; + The Memcached::getResultCode will return + Memcached::RES_NOTFOUND if the key does not exist. @@ -58,14 +65,23 @@ addServer('localhost', 11211); + +$m->set('counter', 5); +$m->decrement('counter'); +var_dump($m->get('counter')); + +$m->decrement('counter', 10); +var_dump($m->get('counter')); ?> ]]> - &example.outputs.similar; + &example.outputs; @@ -76,7 +92,7 @@ &reftitle.seealso; - Classname::Method + Memcached::increment diff --git a/reference/memcached/memcached/increment.xml b/reference/memcached/memcached/increment.xml index 3691549b6b..f5ad90f84d 100644 --- a/reference/memcached/memcached/increment.xml +++ b/reference/memcached/memcached/increment.xml @@ -1,21 +1,25 @@ - + Memcached::increment - The increment purpose + Increment numeric item's value &reftitle.description; - public voidMemcached::increment + public boolMemcached::increment stringkey - stringoffset + intoffset - The method description goes here. + Memcached::increment increments a numeric item's value + by the specified offset. If the item's value is not + numeric, it is treated as if the value were 0. + Memcached::increment will fail if the item does not + exist. @@ -27,7 +31,7 @@ key - Description... + The key of the item to increment. @@ -35,7 +39,7 @@ offset - Description... + The amount by which to increment the item's value; defaults to 1. @@ -46,7 +50,9 @@ &reftitle.returnvalues; - Description... + &return.success; + The Memcached::getResultCode will return + Memcached::RES_NOTFOUND if the key does not exist. @@ -58,14 +64,24 @@ addServer('localhost', 11211); + +$m->set('counter', 0); +$m->increment('counter'); +$m->increment('counter', 10); +var_dump($m->get('counter')); + +$m->set('key', 'abc'); +$m->increment('counter'); ?> ]]> - &example.outputs.similar; + &example.outputs; @@ -76,7 +92,7 @@ &reftitle.seealso; - Classname::Method + Memcached::decrement diff --git a/reference/memcached/memcached/replace.xml b/reference/memcached/memcached/replace.xml index d0f6e772bf..a77281bc14 100644 --- a/reference/memcached/memcached/replace.xml +++ b/reference/memcached/memcached/replace.xml @@ -1,10 +1,10 @@ - + Memcached::replace - Replace data under an existing key + Replace the item under an existing key diff --git a/reference/memcached/memcached/replacebykey.xml b/reference/memcached/memcached/replacebykey.xml index 550a325290..f63a30c165 100644 --- a/reference/memcached/memcached/replacebykey.xml +++ b/reference/memcached/memcached/replacebykey.xml @@ -1,10 +1,10 @@ - + Memcached::replaceByKey - Replace data under an existing key on a specific server + Replace the item under an existing key on a specific server diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml index ddcc9daa5d..3b18bebf23 100644 --- a/reference/memcached/memcached/set.xml +++ b/reference/memcached/memcached/set.xml @@ -1,10 +1,10 @@ - + Memcached::set - Store data under a key + Store an item diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml index 9f2122c6d7..6bc698cc9a 100644 --- a/reference/memcached/memcached/setbykey.xml +++ b/reference/memcached/memcached/setbykey.xml @@ -1,10 +1,10 @@ - + Memcached::setByKey - Store data under a key on a specific server + Store an item on a specific server diff --git a/reference/memcached/memcached/setmulti.xml b/reference/memcached/memcached/setmulti.xml index 3a5e54d174..8716f1b3dd 100644 --- a/reference/memcached/memcached/setmulti.xml +++ b/reference/memcached/memcached/setmulti.xml @@ -1,25 +1,25 @@ - + Memcached::setMulti - Store multiple sets of data + Store multiple items &reftitle.description; public boolMemcached::setMulti - arrayentries + arrayitems intexpiration Memcached::setMulti is similar to Memcached::set, but instead of a single key/value - pair, it works on multiple sets specified in - entries. The expiration - time applies to all the entries at once. + item, it works on multiple items specified in + items. The expiration time + applies to all the items at once. @@ -28,7 +28,7 @@ - entries + items An array of key/value pairs to store on the server. @@ -67,12 +67,12 @@ $m = new Memcached(); $m->addServer('localhost', 11211); -$entries = array( +$items = array( 'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3' ); -$m->set($entries, time() + 300); +$m->set($items, time() + 300); ?> ]]> diff --git a/reference/memcached/memcached/setmultibykey.xml b/reference/memcached/memcached/setmultibykey.xml index d85e80c53f..bb806c6dda 100644 --- a/reference/memcached/memcached/setmultibykey.xml +++ b/reference/memcached/memcached/setmultibykey.xml @@ -1,10 +1,10 @@ - + Memcached::setMultiByKey - Store multiple sets of data on a specific server + Store multiple items on a specific server @@ -12,14 +12,14 @@ public boolMemcached::setMultiByKey stringserver_key - arrayentries + arrayitems intexpiration Memcached::setMultiByKey is functionally equivalent to Memcached::setMulti, except that the free-form server_key can be used to map the keys from - entries to a specific server. This is useful if you + items to a specific server. This is useful if you need to keep a bunch of related keys on a certain server. @@ -37,7 +37,7 @@ - entries + items An array of key/value pairs to store on the server.