WINCACHE_UCACHE_DEC(3) 1 WINCACHE_UCACHE_DEC(3)
wincache_ucache_dec - Decrements the value associated with the key
SYNOPSIS
mixed wincache_ucache_dec (string $key, [int $dec_by = 1], [bool &$success])
DESCRIPTION
Decrements the value associated with the $key by 1 or as specified by $dec_by.
PARAMETERS
o $key
- The $key that was used to store the variable in the cache. $key is case sensitive.
o $dec_by
- The value by which the variable associated with the $key will get decremented. If the argument is a floating point number it
will be truncated to nearest integer. The variable associated with the $key should be of type long, otherwise the function fails
and returns FALSE.
o $success
- Will be set to TRUE on success and FALSE on failure.
RETURN VALUES
Returns the decremented value on success and FALSE on failure.
EXAMPLES
Example #1
Using wincache_ucache_dec(3)
<?php
wincache_ucache_set('counter', 1);
var_dump(wincache_ucache_dec('counter', 2923, $success));
var_dump($success);
?>
The above example will output:
int(2922)
bool(true)
SEE ALSO
wincache_ucache_inc(3), wincache_ucache_cas(3).
PHP Documentation Group WINCACHE_UCACHE_DEC(3)