scache_set
Description
bool scache_set(resource session, string path, mixed value)
bool $SCacheConnection->set(string path, mixed value)
scache_set sets value to given path on session-private storage. Previous value will be replaced. If previous value was subtree, subtree is destroyed.
Functions scache_set, scache_add and scache_replace are all for setting session values. Differencies are :
- scache_set always sets value regardless whether it already exists or not
- scache_add sets value only if it doesn't already exist. In other words scache_add doesn't ever overwrite existing value.
- scache_replace replaces already existing values but newer create new one.
Parameters
session
path
Slash (/) separated path on backend's session tree. Path parameter is not binary safe.
value
Value to be stored. Must be serialize()able.
Return values
TRUE on success, FALSE on failure.
In case of failure, error codes resolvable by scache_lasterr is one of below :
- SCERR_NO_SESSION Connected session does not exist or has been expired. Connection is not valid any more.
- SCERR_LIMITS_REACHED Partition has exceeded its memory or node limits and new session cannot be created until memory is freed.
- SCERR_NOT_CONNECTED Connection to backend is broken and cannot be reconnected.
- SCERR_PROTOCOL Internal protocol error has occurred when communicating to backend. This indicates something is severely broken.
Examples
<?php
/* get connection */
$session = scache_reset('MyEasilyGuessableSecret');
/* store and get */
if (scache_set($session, 'my/values/path', 42) &&
scache_get($session, 'my/values/path') != 42) {
/* unlikely to happen */
die('scached is broken or someone got in middle');
}
scache_set($session, 'this/path/was', 'subtree');
scache_set($session, 'this/path/had', 'multiple values');
scache_set($session, 'this/path/contained/also', 'subvalues');
scache_set($session, 'this/path', 'got overwritten and subvalues deleted);
?>