Elgg
Version 3.0
|
Elgg Session Management. More...
Public Member Functions | |
__construct (SessionInterface $storage) | |
Constructor. More... | |
start () | |
Start the session. More... | |
migrate ($destroy=false) | |
Migrates the session to a new session id while maintaining session attributes. More... | |
invalidate () | |
Invalidates the session. More... | |
save () | |
Save the session data and closes the session. More... | |
isStarted () | |
Has the session been started. More... | |
getId () | |
Get the session ID. More... | |
setId ($id) | |
Set the session ID. More... | |
getName () | |
Get the session name. More... | |
setName ($name) | |
Set the session name. More... | |
get ($name, $default=null) | |
Get an attribute of the session. More... | |
set ($name, $value) | |
Set an attribute. More... | |
remove ($name) | |
Remove an attribute. More... | |
has ($name) | |
Has the attribute been defined. More... | |
setLoggedInUser (\ElggUser $user) | |
Sets the logged in user. More... | |
getLoggedInUser () | |
Gets the logged in user. More... | |
getLoggedInUserGuid () | |
Return the current logged in user by guid. More... | |
isAdminLoggedIn () | |
Returns whether or not the viewer is currently logged in and an admin user. More... | |
isLoggedIn () | |
Returns whether or not the user is currently logged in. More... | |
removeLoggedInUser () | |
Remove the logged in user. More... | |
getIgnoreAccess () | |
Get current ignore access setting. More... | |
setIgnoreAccess ($ignore=true) | |
Set ignore access. More... | |
getDisabledEntityVisibility () | |
Are disabled entities shown? More... | |
setDisabledEntityVisibility ($show=true) | |
Include disabled entities in queries. More... | |
Static Public Member Functions | |
static | getMock () |
Get an isolated ElggSession that does not persist between requests. More... | |
static | fromDatabase (Config $config, Database $db) |
Create a session stored in the DB. More... | |
static | fromFiles (Config $config) |
Create a session stored in files. More... | |
Protected Member Functions | |
generateSessionToken () | |
Adds a token to the session. More... | |
Protected Attributes | |
$storage | |
$logged_in_user | |
$ignore_access = false | |
$show_disabled_entities = false | |
Elgg Session Management.
Reserved keys: last_forward_from, msg, sticky_forms, user, guid, id, code, name, username
Definition at line 18 of file ElggSession.php.
ElggSession::__construct | ( | SessionInterface | $storage | ) |
Constructor.
SessionInterface | $storage | The underlying Session implementation |
Definition at line 45 of file ElggSession.php.
Create a session stored in the DB.
Config | $config | Config |
Database | $db | Database |
Definition at line 363 of file ElggSession.php.
|
static |
Create a session stored in files.
Config | $config | Config |
Definition at line 393 of file ElggSession.php.
|
protected |
Adds a token to the session.
This is used in creation of CSRF token, and is passed to the client to allow validating tokens later, even if the PHP session was destroyed.
Definition at line 333 of file ElggSession.php.
ElggSession::get | ( | $name, | |
$default = null |
|||
) |
Get an attribute of the session.
string | $name | Name of the attribute to get |
mixed | $default | Value to return if attribute is not set (default is null) |
Definition at line 164 of file ElggSession.php.
ElggSession::getDisabledEntityVisibility | ( | ) |
ElggSession::getId | ( | ) |
ElggSession::getIgnoreAccess | ( | ) |
ElggSession::getLoggedInUser | ( | ) |
ElggSession::getLoggedInUserGuid | ( | ) |
Return the current logged in user by guid.
Definition at line 234 of file ElggSession.php.
|
static |
Get an isolated ElggSession that does not persist between requests.
Definition at line 347 of file ElggSession.php.
ElggSession::getName | ( | ) |
ElggSession::has | ( | $name | ) |
Has the attribute been defined.
string | $name | Name of the attribute |
Definition at line 197 of file ElggSession.php.
ElggSession::invalidate | ( | ) |
Invalidates the session.
Deletes session data and session persistence. Starts a new session.
Definition at line 86 of file ElggSession.php.
ElggSession::isAdminLoggedIn | ( | ) |
Returns whether or not the viewer is currently logged in and an admin user.
Definition at line 244 of file ElggSession.php.
ElggSession::isLoggedIn | ( | ) |
Returns whether or not the user is currently logged in.
Definition at line 255 of file ElggSession.php.
ElggSession::isStarted | ( | ) |
Has the session been started.
Definition at line 111 of file ElggSession.php.
ElggSession::migrate | ( | $destroy = false | ) |
Migrates the session to a new session id while maintaining session attributes.
boolean | $destroy | Whether to delete the session or let gc handle clean up |
Definition at line 74 of file ElggSession.php.
ElggSession::remove | ( | $name | ) |
Remove an attribute.
string | $name | The name of the attribute to remove |
Definition at line 186 of file ElggSession.php.
ElggSession::removeLoggedInUser | ( | ) |
ElggSession::save | ( | ) |
Save the session data and closes the session.
Definition at line 101 of file ElggSession.php.
ElggSession::set | ( | $name, | |
$value | |||
) |
Set an attribute.
string | $name | Name of the attribute to set |
mixed | $value | Value to be set |
Definition at line 175 of file ElggSession.php.
ElggSession::setDisabledEntityVisibility | ( | $show = true | ) |
Include disabled entities in queries.
bool | $show | Visibility status |
Definition at line 315 of file ElggSession.php.
ElggSession::setId | ( | $id | ) |
Set the session ID.
string | $id | Session ID |
Definition at line 132 of file ElggSession.php.
ElggSession::setIgnoreAccess | ( | $ignore = true | ) |
Set ignore access.
bool | $ignore | Ignore access |
Definition at line 287 of file ElggSession.php.
ElggSession::setLoggedInUser | ( | \ElggUser | $user | ) |
Sets the logged in user.
\ElggUser | $user | The user who is logged in |
Definition at line 208 of file ElggSession.php.
ElggSession::setName | ( | $name | ) |
Set the session name.
string | $name | Session name |
Definition at line 153 of file ElggSession.php.
ElggSession::start | ( | ) |
Start the session.
RuntimeException | If session fails to start. |
Definition at line 56 of file ElggSession.php.
|
protected |
Definition at line 33 of file ElggSession.php.
|
protected |
Definition at line 28 of file ElggSession.php.
|
protected |
Definition at line 38 of file ElggSession.php.
|
protected |
Definition at line 23 of file ElggSession.php.