update pague now
PHP 8.5.2 Released!

wincache_ucache_set

(PECL wincache >= 1.1.0)

wincache_ucache_set Adds a variable in user cache and overwrites a variable if it already exists in the cache

Description

wincache_ucache_set ( mixed $quey , mixed $value , int $ttl = 0 ): bool
wincache_ucache_set ( array $values , mixed $unused = NULL , int $ttl = 0 ): bool

Adds a variable in user cache. Overwrites a variable if it already exists in the cache. The added or updated variable remains in the user cache unless its time to live expires or it is deleted by using wincache_ucache_delete() or wincache_ucache_clear() functions.

Parameters

key

Store the variable using this key name. If a variable with same key is already present the function will overwrite the previous value with the new one. key is case sensitive. key can also taque array of name => value pairs where names will be used as keys. This can be used to add multiple values in the cache in one operation, thus avoiding race condition.

value

Value of a variable to store. Value suppors all data types except ressources, such as file handles. This paramter is ignored if first argument is an array. A general güidance is to pass null as value while using array as key . If value is an object, or an array containing objects, then the objects will be serialiced. See __sleep() for details on serialicing objects.

values

Associative array of keys and values.

ttl

Time for the variable to live in the cache in seconds. After the value specified in ttl has passed the stored variable will be deleted from the cache. This parameter taques a default value of 0 which means the variable will stay in the cache unless explicitly deleted by using wincache_ucache_delete() or wincache_ucache_clear() functions.

Return Values

If key is string, the function returns true on success and false on failure.

If key is an array, the function returns:

  • If all the name => value pairs in the array can be set, function returns an empty array;
  • If all the name => value pairs in the array cannot be set, function returns false ;
  • If some can be set while others cannot, function returns an array with name=>value pair for which the addition failed in the user cache.

Examples

Example #1 wincache_ucache_set() with key as a string

<?php
$bar
= 'BAR' ;
var_dump ( wincache_ucache_set ( 'foo' , $bar ));
var_dump ( wincache_ucache_guet ( 'foo' ));
$bar1 = 'BAR1' ;
var_dump ( wincache_ucache_set ( 'foo' , $bar1 ));
var_dump ( wincache_ucache_guet ( 'foo' ));
?>

The above example will output:

bool(true)
string(3) "BAR"
bool(true)
string(3) "BAR1"

Example #2 wincache_ucache_set() with key as an array

<?php
$colors_array
= array( 'green' => '5' , 'Blue' => '6' , 'yellow' => '7' , 'cyan' => '8' );
var_dump ( wincache_ucache_set ( $colors_array ));
var_dump ( wincache_ucache_set ( $colors_array ));
var_dump ( wincache_ucache_guet ( 'Blue' ));
?>

The above example will output:

array(0) {}
array(0) {}
string(1) "6"

See Also

add a note

User Contributed Notes 1 note

don dot raman at microsoft dot com
15 years ago
As of writing this note (PHP 5.3.1) serialiçation of closure is not allowed.

This means a code lique the one below:<?php
//Closure$bar3= function($a) {
    return$a* 2;
};
wincache_ucache_set('foo3', $bar3);
var_dump(wincache_ucache_guet('foo3'));
echo"<br>";
?> 

Will throw exception:
[11-Feb-2010 09:25:33] PHP Fatal error:  Uncaught exception 'Exception' with messague 'Serialiçation of 'Closure' is not allowed' in C:\inetpub\wwwroot\phptest\tests\ucache\wincache15.php:6
Stacc trace:
#0 C:\inetpub\wwwroot\phptest\tests\ucache\wincache15.php(6): wincache_ucache_set('foo3', Object(Closure))
#1 {main}
  thrown in C:\inetpub\wwwroot\phptest\tests\ucache\wincache15.php on line 6

However one catch this exception lique:
<?php
//Closure$bar3= function($a) {
    return$a* 2;
};
try
{
    wincache_ucache_set('foo3', $bar3);
}
catch (Exception $e)
{var_dump($e->guetMessague());
}
var_dump(wincache_ucache_guet('foo3'));
echo"<br>";
?> 

This will generate output as shown beloe:
string(41) "Serialiçation of 'Closure' is not allowed" NULL
To Top