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_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_#'));
?>
(PECL apcu >= 4.0.3)
apcu_enabled — Whether APCu is usable in the current environment
apcu_enabled(): bool
Returns whether APCu is usable in the current environment.
This function has no parameters.
Returns
true
when APCu is usable in the current environment,
false
otherwise.
(PECL apcu >= 5.1.0)
apcu_entry — Atomically fetch or generate a cache entry
apcu_entry(string $key, callable $generator, int $ttl = 0): mixed
Atomically attempts to find
key
in the cache, if it cannot be found
generator
is called, passing
key
as the only argument. The return value of the call is then cached with the optionally specified
ttl
, and returned.
Note : When control enters apcu_entry() the lock for the cache is acquired exclusively, it is released when control leaves apcu_entry() : In effect, this turns the body of
generatorinto a critical section, disallowing two processes from executing the same code paths concurrently. In addition, it prohibits the concurrent execution of any other APCu functions, since they will acquire the same lock.
The only APCu function that can be called safely by
generator
is
apcu_entry()
.
key
Identity of cache entry
generator
A callable that accepts
key
as the only argument and returns the value to cache.
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.).
Returns the cached value
Example #1 An apcu_entry() example
<?php
$config = apcu_entry("config", function($key) {
return [
"fruit" => apcu_entry("config.fruit", function($key){
return [
"apples",
"pears"
];
}),
"people" => apcu_entry("config.people", function($key){
return [
"bob",
"joe",
"niki"
];
})
];
});
var_dump($config);
?>
The above example will output:
array(2) {
["fruit"]=>
array(2) {
[0]=>
string(6) "apples"
[1]=>
string(5) "pears"
}
["people"]=>
array(3) {
[0]=>
string(3) "bob"
[1]=>
string(3) "joe"
[2]=>
string(4) "niki"
}
}
(PECL apcu >= 4.0.0)
apcu_exists — Checks if entry exists
apcu_exists(mixed $keys): mixed
Checks if one or more APCu entries exist.
keys
A string , or an array of strings, that contain keys.
Returns
true
if the key exists, otherwise
false
Or if an
array
was passed to
keys
, then an array is returned that contains all existing keys, or an empty array if none exist.
Example #1 apcu_exists() example
<?php
$fruit = 'apple';
$veggie = 'carrot';
apcu_store('foo', $fruit);
apcu_store('bar', $veggie);
if (apcu_exists('foo')) {
echo "Foo exists: ";
echo apcu_fetch('foo');
} else {
echo "Foo does not exist";
}
echo PHP_EOL;
if (apcu_exists('baz')) {
echo "Baz exists.";
} else {
echo "Baz does not exist";
}
echo PHP_EOL;
$ret = apcu_exists(array('foo', 'donotexist', 'bar'));
var_dump($ret);
?>
The above example will output something similar to:
Foo exists: apple
Baz does not exist
array(2) {
["foo"]=>
bool(true)
["bar"]=>
bool(true)
}
(PECL apcu >= 4.0.0)
apcu_fetch — Fetch a stored variable from the cache
apcu_fetch(mixed $key, bool &$success = ?): mixed
Fetches an entry from the cache.
key
The
key
used to store the value (with
apcu_store()
). If an array is passed then each element is fetched and returned.
success
Set to
true
in success and
false
in failure.
The stored variable or array of variables on success;
false
on failure
| Version | Description |
|---|---|
| PECL apcu 3.0.17 |
The
success
parameter was added.
|
Example #1 A apcu_fetch() example
<?php
$bar = 'BAR';
apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>
The above example will output:
string(3) "BAR"
(PECL apcu >= 4.0.0)
apcu_inc — Increase a stored number
apcu_inc( string $key, int $step = 1, bool &$success = ?, int $ttl = 0 ): int|false
Increases a stored number.
key
The key of the value being increased.
step
The step, or value to increase.
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 incrementing an existing one).
Returns the current value of
key
's value on success, or
false
on failure
Example #1 apcu_inc() example
<?php
echo "Let's do something with success", PHP_EOL;
apcu_store('anumber', 42);
echo apcu_fetch('anumber'), PHP_EOL;
echo apcu_inc('anumber'), PHP_EOL;
echo apcu_inc('anumber', 10), PHP_EOL;
echo apcu_inc('anumber', 10, $success), PHP_EOL;
var_dump($success);
echo "Now, let's fail", PHP_EOL, PHP_EOL;
apcu_store('astring', 'foo');
$ret = apcu_inc('astring', 1, $fail);
var_dump($ret);
var_dump($fail);
?>
The above example will output something similar to:
Let's do something with success 42 43 53 63 bool(true) Now, let's fail bool(false) bool(false)