Auth_Yadis_PHPSession
in package
The base session class used by the Auth_Yadis_Manager. This class wraps the default PHP session machinery and should be subclassed if your application doesn't use PHP sessioning.
Table of Contents
- contents() : mixed
- Return the contents of the session in array form.
- del() : mixed
- Remove a key/value pair from the session.
- get() : mixed
- Get a key's value from the session.
- set() : mixed
- Set a session key/value pair.
Methods
contents()
Return the contents of the session in array form.
public
contents() : mixed
Return values
mixed —del()
Remove a key/value pair from the session.
public
del(string $name) : mixed
Parameters
- $name : string
-
The name of the key to remove.
Return values
mixed —get()
Get a key's value from the session.
public
get(string $name[, string $default = null ]) : mixed
Parameters
- $name : string
-
The name of the key to retrieve.
- $default : string = null
-
The optional value to return if the key is not found in the session.
Return values
mixed —$result The key's value in the session or $default if it isn't found.
set()
Set a session key/value pair.
public
set(string $name, mixed $value) : mixed
Parameters
- $name : string
-
The name of the session key to add.
- $value : mixed
-
The value to add to the session.