This is one stop global knowledge base where you can learn about all the products, solutions and support features.
(PECL apcu >= 4.0.0)
apcu_add — Cache a new variable in the data store
apcu_add(string $key, mixed $var, int $ttl = 0): bool
apcu_add(array $values, mixed $unused = NULL, int $ttl = 0): array
Caches a variable in the data store, only if it's not already stored.
Note : Unlike many other mechanisms in PHP, variables stored using apcu_add() will persist between requests (until the value is removed from the cache).
key
Store the variable using this name.
key
s are cache-unique, so attempting to use
apcu_add()
to store data with a key that already exists will not overwrite the existing data, and will instead return
false
. (This is the only difference between
apcu_add()
and
apcu_store()
.)
var
The variable to store
ttl
Time To Live; store
var
in the cache for
ttl
seconds. After the
ttl
has passed, the stored variable will be expunged from the cache (on the next request). If no
ttl
is supplied (or if the
ttl
is
0
), the value will persist until it is removed from the cache manually, or otherwise fails to exist in the cache (clear, restart, etc.).
values
Names in key, variables in value.
Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second syntax returns array with error keys.
Example #1 A apcu_add() example
<?php
$bar = 'BAR';
apcu_add('foo', $bar);
var_dump(apcu_fetch('foo'));
echo "\n";
$bar = 'NEVER GETS SET';
apcu_add('foo', $bar);
var_dump(apcu_fetch('foo'));
echo "\n";
?>
The above example will output:
string(3) "BAR" string(3) "BAR"
(PECL apcu >= 4.0.0)
apcu_cache_info — Retrieves cached information from APCu's data store
apcu_cache_info(bool $limited = false): array|false
Retrieves cached information and meta-data from APC's data store.
limited
If
limited
is
true
, the return value will exclude the individual list of cache entries. This is useful when trying to optimize calls for statistics gathering.
Array of cached data (and meta-data) or
false
on failure
Note : apcu_cache_info() will raise a warning if it is unable to retrieve APC cache data. This typically occurs when APC is not enabled.
| Version | Description |
|---|---|
| PECL apcu 3.0.11 |
The
limited
parameter was introduced.
|
| PECL apcu 3.0.16 |
The "
filehits
" option for the
cache_type
parameter was introduced.
|
Example #1 A apcu_cache_info() example
<?php
print_r(apcu_cache_info());
?>
The above example will output something similar to:
Array
(
[num_slots] => 2000
[ttl] => 0
[num_hits] => 9
[num_misses] => 3
[start_time] => 1123958803
[cache_list] => Array
(
[0] => Array
(
[filename] => /path/to/apcu_test.php
[device] => 29954
[inode] => 1130511
[type] => file
[num_hits] => 1
[mtime] => 1123960686
[creation_time] => 1123960696
[deletion_time] => 0
[access_time] => 1123962864
[ref_count] => 1
[mem_size] => 677
)
[1] => Array (...iterates for each cached file)
)
(PECL apcu >= 4.0.0)
apcu_cas — Updates an old value with a new value
apcu_cas(string $key, int $old, int $new): bool
apcu_cas()
updates an already existing integer value if the
old
parameter matches the currently stored value with the value of the
new
parameter.
key
The key of the value being updated.
old
The old value (the value currently stored).
new
The new value to update to.
Returns
true
on success or
false
on failure.
Example #1 apcu_cas() example
<?php
apcu_store('foobar', 2);
echo '$foobar = 2', PHP_EOL;
echo '$foobar == 1 ? 2 : 1 = ', (apcu_cas('foobar', 1, 2) ? 'ok' : 'fail'), PHP_EOL;
echo '$foobar == 2 ? 1 : 2 = ', (apcu_cas('foobar', 2, 1) ? 'ok' : 'fail'), PHP_EOL;
echo '$foobar = ', apcu_fetch('foobar'), PHP_EOL;
echo '$f__bar == 1 ? 2 : 1 = ', (apcu_cas('f__bar', 1, 2) ? 'ok' : 'fail'), PHP_EOL;
apcu_store('perfection', 'xyz');
echo '$perfection == 2 ? 1 : 2 = ', (apcu_cas('perfection', 2, 1) ? 'ok' : 'epic fail'), PHP_EOL;
echo '$foobar = ', apcu_fetch('foobar'), PHP_EOL;
?>
The above example will output something similar to:
$foobar = 2 $foobar == 1 ? 2 : 1 = fail $foobar == 2 ? 1 : 2 = ok $foobar = 1 $f__bar == 1 ? 2 : 1 = fail $perfection == 2 ? 1 : 2 = epic fail $foobar = 1
(PECL apcu >= 4.0.0)
apcu_clear_cache — Clears the APCu cache
apcu_clear_cache(): bool
Clears the cache.
This function has no parameters.
Returns
true
always
(PECL apcu >= 4.0.0)
apcu_dec — Decrease a stored number
apcu_dec( string $key, int $step = 1, bool &$success = ?, int $ttl = 0 ): int|false
Decreases a stored integer value.
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).
Returns the current value of
key
's value on success, or
false
on failure
Example #1 apcu_dec() example
<?php
echo "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)
(PECL apcu >= 4.0.0)
apcu_delete — Removes a stored variable from the cache
apcu_delete(mixed $key): mixed
Removes a stored variable from the cache.
key
A
key
used to store the value as a
string
for a single key, or as an
array
of strings for several keys, or as an
APCUIterator
object
.
If
key
is an
array
, an indexed
array
of the keys is returned. Otherwise
true
is returned on success, or
false
on failure.
Example #1 A apcu_delete() example
<?php
$bar = 'BAR';
apcu_store('foo', $bar);
apcu_delete('foo');
// this is obviously useless in this form
// Alternatively delete multiple keys.
apcu_delete(['foo', 'bar', 'baz']);
// Or use an Iterator with a regular expression.
apcu_delete(new APCUIterator('#^myprefix_#'));
?>