Memcached::incrementByKey
PHP function
Edit on GitHub ✎
(PECL memcached >= 2.0.0)
Increment numeric item's value, stored on a specific server
Description
Memcached::incrementByKey(string $server_key, string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0): int|false
Memcached::incrementByKey() increments a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. Memcached::incrementByKey() 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 increment.
offsetThe amount by which to increment 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 new item's value on successFalseforfailure.
See Also
Memcached::decrementMemcached::decrementByKeyMemcached::increment