Memcached::decrement
(PECL memcached >= 0.1.0)
Memcached::decrement — Decrement numeric item's value
Description
public int Memcached::decrement
( string
$key
[, int $offset = 1
] )
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.
Parameters
-
key -
The key of the item to decrement.
-
offset -
The amount by which to decrement the item's value.
Return Values
Returns item's new value on success or FALSE on failure.
The Memcached::getResultCode() will return
Memcached::RES_NOTFOUND if the key does not exist.
Examples
Example #1 Memcached::decrement() example
<?php
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->set('counter', 5);
$m->decrement('counter');
var_dump($m->get('counter'));
$m->decrement('counter', 10);
var_dump($m->get('counter'));
?>
The above example will output:
int(4) int(0)
There are no user contributed notes for this page.
