Memcached::decrement
(PECL memcached >= 0.1.0)
Memcached::decrement — Decrement numeric item's value
Description
$key
[, int $offset
= 1
[, int $initial_value
= 0
[, int $expiry
= 0
]]] ) : int
Memcached::decrement() decrements a numeric item's value
by the specified offset
. If the item's value is not
numeric, an error will result. If the operation would
decrease the value below 0, the new value will be 0.
Memcached::decrement() will set the item to the
initial_value
parameter if the key doesn't exist.
Parameters
-
key
-
The key of the item to decrement.
-
offset
-
The amount by which to decrement the item's value.
-
initial_value
-
The value to set the item to if it doesn't currently exist.
-
expiry
-
The expiry time to set on the item.
Examples
Example #1 Memcached::decrement() example
<?php
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->set('counter', 5);
$n = $m->decrement('counter');
var_dump($n);
$n = $m->decrement('counter', 10);
var_dump($n);
var_dump($m->get('counter'));
$m->set('counter', 'abc');
$n = $m->increment('counter');
// ^ will fail due to item value not being numeric
var_dump($n);
?>
The above example will output:
int(4) int(0) int(0) bool(false)
See Also
- Memcached::increment() - Increment numeric item's value
- Memcached::incrementByKey() - Increment numeric item's value, stored on a specific server
- Memcached::decrementByKey() - Decrement numeric item's value, stored on a specific server
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-memcached.decrement.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.