APC_ADD(3) 1 APC_ADD(3)
apc_add - Cache a new variable in the data store
SYNOPSIS
bool apc_add (string $key, mixed $var, [int $ttl])
DESCRIPTION
array apc_add (array $values, [mixed $unused = NULL], [int $ttl])
Caches a variable in the data store, only if it's not already stored.
Note
Unlike many other mechanisms in PHP, variables stored using apc_add(3) will persist between requests (until the value is removed
from the cache).
PARAMETERS
o $key
- Store the variable using this name. $keys are cache-unique, so attempting to use apc_add(3) 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
apc_add(3) and apc_store(3).)
o $var
- The variable to store
o $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.).
o $values
- Names in key, variables in value.
RETURN VALUES
Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second syntax returns array with error keys.
EXAMPLES
Example #1
A apc_add(3) example
<?php
$bar = 'BAR';
apc_add('foo', $bar);
var_dump(apc_fetch('foo'));
echo "
";
$bar = 'NEVER GETS SET';
apc_add('foo', $bar);
var_dump(apc_fetch('foo'));
echo "
";
?>
The above example will output:
string(3) "BAR"
string(3) "BAR"
SEE ALSO
apc_store(3), apc_fetch(3), apc_delete(3).
PHP Documentation Group APC_ADD(3)