Ubiquity
2.0.3
php rapid development framework
|
Http Session utilities. More...
Static Public Member Functions | |
static | getArray ($arrayKey) |
Returns an array stored in session variable as $arrayKey. More... | |
static | addOrRemoveValueFromArray ($arrayKey, $value, $add=true) |
Adds or removes a value from an array in session. More... | |
static | removeValueFromArray ($arrayKey, $value) |
Removes a value from an array in session. More... | |
static | addValueToArray ($arrayKey, $value) |
Adds a value from an array in session. More... | |
static | setBoolean ($key, $value) |
Sets a boolean value at key position in session. More... | |
static | getBoolean ($key) |
Returns a boolean stored at the key position in session. More... | |
static | session ($key, $default=NULL) |
Returns the value stored at the key position in session. More... | |
static | get ($key, $default=NULL) |
Returns the value stored at the key position in session. More... | |
static | set ($key, $value) |
Adds or sets a value to the Session at position $key. More... | |
static | setTmp ($key, $value, $duration) |
static | getTmp ($key, $default=null) |
static | getTimeout ($key) |
static | delete ($key) |
Deletes the key in Session. More... | |
static | inc ($key, $inc=1) |
Increment the value at the key index in session. More... | |
static | dec ($key, $dec=1) |
Decrement the value at the key index in session. More... | |
static | concat ($key, $str, $default=NULL) |
Adds a string at the end of the value at the key index in session. More... | |
static | apply ($key, $callback, $default=NULL) |
Applies a callback function to the value at the key index in session. More... | |
static | Walk ($callback, $userData=null) |
Apply a user supplied function to every member of Session array. More... | |
static | replace ($keyAndValues) |
Replaces elements from Session array with $keyAndValues. More... | |
static | getAll () |
Returns the associative array of session vars. More... | |
static | start ($name=null) |
Start new or resume existing session. More... | |
static | isStarted () |
Returns true if the session is started. More... | |
static | exists ($key) |
Returns true if the key exists in Session. More... | |
static | init ($key, $value) |
Initialize the key in Session if key does not exists. More... | |
static | terminate () |
Terminates the active session. More... | |
Static Private Attributes | |
static | $name |
|
static |
Adds or removes a value from an array in session.
string | $arrayKey | the key of the array to add or remove in |
mixed | $value | the value to add |
boolean | $add | If true, adds otherwise removes |
Definition at line 46 of file USession.php.
|
static |
Adds a value from an array in session.
string | $arrayKey | the key of the array to add in |
mixed | $value | the value to add |
Definition at line 82 of file USession.php.
|
static |
Applies a callback function to the value at the key index in session.
string | $key | |
string | callable | $callback |
Definition at line 248 of file USession.php.
|
static |
Adds a string at the end of the value at the key index in session.
string | $key | |
string | $str |
Definition at line 237 of file USession.php.
|
static |
Decrement the value at the key index in session.
string | $key | |
number | $dec |
Definition at line 226 of file USession.php.
|
static |
Deletes the key in Session.
string | $key | the key to delete |
Definition at line 203 of file USession.php.
|
static |
Returns true if the key exists in Session.
string | $key | the key to test |
Definition at line 329 of file USession.php.
|
static |
Returns the value stored at the key position in session.
string | $key | the key to retreive |
mixed | $default | the default value to return if the key does not exists in session |
Definition at line 139 of file USession.php.
|
static |
Returns the associative array of session vars.
Definition at line 290 of file USession.php.
|
static |
Returns an array stored in session variable as $arrayKey.
string | $arrayKey | the key of the array to return |
Definition at line 24 of file USession.php.
|
static |
Returns a boolean stored at the key position in session.
string | $key | the key to add or set |
Definition at line 107 of file USession.php.
|
static |
Definition at line 182 of file USession.php.
|
static |
Definition at line 167 of file USession.php.
|
static |
Increment the value at the key index in session.
string | $key | |
number | $inc |
Definition at line 215 of file USession.php.
|
static |
Initialize the key in Session if key does not exists.
string | $key | |
mixed | $value |
Definition at line 340 of file USession.php.
|
static |
|
static |
Removes a value from an array in session.
string | $arrayKey | the key of the array to remove in |
mixed | $value | the value to remove |
Definition at line 69 of file USession.php.
|
static |
Replaces elements from Session array with $keyAndValues.
array | $keyAndValues |
Definition at line 279 of file USession.php.
|
static |
Returns the value stored at the key position in session.
string | $key | the key to retreive |
mixed | $default | the default value to return if the key does not exists in session |
Definition at line 125 of file USession.php.
|
static |
Adds or sets a value to the Session at position $key.
string | $key | the key to add or set |
mixed | $value |
Definition at line 151 of file USession.php.
|
static |
Sets a boolean value at key position in session.
string | $key | the key to add or set in |
mixed | $value | the value to set |
Definition at line 95 of file USession.php.
|
static |
Definition at line 156 of file USession.php.
|
static |
Start new or resume existing session.
string | null | $name | the name of the session |
Definition at line 301 of file USession.php.
|
static |
Terminates the active session.
Definition at line 350 of file USession.php.
|
static |
Apply a user supplied function to every member of Session array.
callable | $callback | |
mixed | $userData |
Definition at line 267 of file USession.php.
|
staticprivate |
Definition at line 15 of file USession.php.