Php/docs/function.apcu-dec
From Get docs
apcu_dec
(PECL apcu >= 4.0.0)
apcu_dec — Decrease a stored number
Description
apcu_dec
( string $key
[, int $step
= 1
[, bool &$success
[, int $ttl
= 0
]]] ) : int|false
Decreases a stored integer value.
Parameters
key
- The key of the value being decreased.
step
- The step, or value to decrease.
success
- Optionally pass the success or fail boolean value to this referenced variable.
ttl
- TTL to use if the operation inserts a new value (rather than decrementing an existing one).
Return Values
Returns the current value of key
's value on success,
or FALSE
on failure
Changelog
Version | Description |
---|---|
5.1.12 | The ttl parameter has been added.
|
Examples
Example #1 apcu_dec() example
<?phpecho "Let's do something with success", PHP_EOL;apcu_store('anumber', 42);echo apcu_fetch('anumber'), PHP_EOL;echo apcu_dec('anumber'), PHP_EOL;echo apcu_dec('anumber', 10), PHP_EOL;echo apcu_dec('anumber', 10, $success), PHP_EOL;var_dump($success);echo "Now, let's fail", PHP_EOL, PHP_EOL;apcu_store('astring', 'foo');$ret = apcu_dec('astring', 1, $fail);var_dump($ret);var_dump($fail);?>
The above example will output something similar to:
Let's do something with success 42 41 31 21 bool(true) Now, let's fail bool(false) bool(false)