Memcached::decrementByKey
PHP function
Edit on GitHub ✎
(PECL memcached >= 2.0.0)
Decrement numeric item's value, stored on a specific server
Description
Memcached::decrementByKey(string $server_key, string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0): int|false
Memcached::decrementByKey() 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::decrementByKey() will set the item to the initial_value parameter if the key doesn't exist.
Parameters
server_keyServer_key
keyThe key of the item to decrement.
offsetThe amount by which to decrement the item's value.
initial_valueThe value to set the item to if it doesn't currently exist.
expiryThe expiry time to set on the item.
Return Values
Returns item's new value on successFalseforfailure.
See Also
Memcached::decrementMemcached::incrementMemcached::incrementByKey