wincache_ucache_get
Gets a variable stored in the user cache
Description
mixed wincache_ucache_get(mixed $key
, bool &$success
= ?)
Parameters
-
key
-
The key
that was used to store the variable in the cache.
key
is case sensitive. key
can be an
array of keys. In this case the return value will be an array of values of each element
in the key
array. If an object, or an array containing objects,
is returned, then the objects will be unserialized. See
__wakeup() for details on unserializing objects.
-
success
-
Will be set to true
on success and false
on failure.
Return Values
If key
is a string, the function returns the value of the variable stored with that key.
The success
is set to true
on success and
to false
on failure.
The key
is an array, the parameter success
is always set to true
. The returned array (name => value pairs) will
contain only those name => value pairs for which the get operation in user cache was
successful. If none of the keys in the key array finds a match in the user cache
an empty array will be returned.
Examples
Example #1 wincache_ucache_get with key
as a string
<?php
wincache_ucache_add('color', 'blue');
var_dump(wincache_ucache_get('color', $success));
var_dump($success);
?>
The above example will output:
string(4) "blue"
bool(true)
Example #2 wincache_ucache_get with key
as an array
<?php
$array1 = array('green' => '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8');
wincache_ucache_set($array1);
$array2 = array('green', 'Blue', 'yellow', 'cyan');
var_dump(wincache_ucache_get($array2, $success));
var_dump($success);
?>
The above example will output:
array(4) { ["green"]=> string(1) "5"
["Blue"]=> string(1) "6"
["yellow"]=> string(1) "7"
["cyan"]=> string(1) "8" }
bool(true)
See Also
- wincache_ucache_add
- wincache_ucache_set
- wincache_ucache_delete
- wincache_ucache_clear
- wincache_ucache_exists
- wincache_ucache_meminfo
- wincache_ucache_info
- __wakeup()