Elgg Session Management. More...

Public Member Functions
	__construct (SessionInterface $storage)
	Constructor. More...

	boot ()
	Initializes the session and checks for the remember me cookie. More...

	start ()
	Start the session. More...

	migrate (bool $destroy=true)
	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...

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

Detailed Description

Elgg Session Management.

Reserved keys: last_forward_from, msg, sticky_forms, user, guid, id, code, name, username

See also: elgg_get_session()

Definition at line 19 of file ElggSession.php.

Constructor & Destructor Documentation

ElggSession::__construct ( SessionInterface $storage )

Constructor.

Parameters

SessionInterface $storage The underlying Session implementation

Definition at line 33 of file ElggSession.php.

Member Function Documentation

ElggSession::boot ( )

Initializes the session and checks for the remember me cookie.

Returns: void

Definition at line 44 of file ElggSession.php.

static ElggSession::fromDatabase	(	Config	$config,
		Database	$db
	)

static

Create a session stored in the DB.

Parameters

Config	$config	Config
Database	$db	Database

Returns: ElggSession

Definition at line 273 of file ElggSession.php.

static ElggSession::fromFiles ( Config $config )

static

Create a session stored in files.

Parameters

Config $config Config

Returns: ElggSession

Definition at line 303 of file ElggSession.php.

ElggSession::generateSessionToken ( )

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.

Returns: void

Definition at line 243 of file ElggSession.php.

ElggSession::get	(	$name,
		$default = `null`
	)

Get an attribute of the session.

Parameters

string	$name	Name of the attribute to get
mixed	$default	Value to return if attribute is not set (default is null)

Returns: mixed

Definition at line 198 of file ElggSession.php.

ElggSession::getID ( )

Get the session ID.

Returns: string

Since: 1.9

Definition at line 155 of file ElggSession.php.

static ElggSession::getMock ( )

static

Get an isolated ElggSession that does not persist between requests.

Returns: self

Definition at line 257 of file ElggSession.php.

ElggSession::getName ( )

Get the session name.

Returns: string

Since: 1.9

Definition at line 176 of file ElggSession.php.

ElggSession::has ( $name )

Has the attribute been defined.

Parameters

string $name Name of the attribute

Returns: bool

Since: 1.9

Definition at line 231 of file ElggSession.php.

ElggSession::invalidate ( )

Invalidates the session.

Deletes session data and session persistence. Starts a new session.

Returns: boolean

Since: 1.9

Definition at line 121 of file ElggSession.php.

ElggSession::isStarted ( )

Has the session been started.

Returns: boolean

Since: 1.9

Definition at line 145 of file ElggSession.php.

ElggSession::migrate ( bool $destroy = true )

Migrates the session to a new session id while maintaining session attributes.

Parameters

boolean $destroy Whether to delete the session or let gc handle clean up

Returns: boolean

Since: 1.9

Definition at line 109 of file ElggSession.php.

ElggSession::remove ( $name )

Remove an attribute.

Parameters

string $name The name of the attribute to remove

Returns: mixed The removed attribute

Since: 1.9

Definition at line 220 of file ElggSession.php.

ElggSession::save ( )

Save the session data and closes the session.

Returns: void

Since: 3.0

Definition at line 135 of file ElggSession.php.

ElggSession::set	(	$name,
		$value
	)

Set an attribute.

Parameters

string	$name	Name of the attribute to set
mixed	$value	Value to be set

Returns: void

Definition at line 209 of file ElggSession.php.

ElggSession::setId ( $id )

Set the session ID.

Parameters

string $id Session ID

Returns: void

Since: 1.9

Definition at line 166 of file ElggSession.php.

ElggSession::setName ( $name )

Set the session name.

Parameters

string $name Session name

Returns: void

Since: 1.9

Definition at line 187 of file ElggSession.php.

ElggSession::start ( )

Start the session.

Returns: boolean

Exceptions

RuntimeException If session fails to start.

Since: 1.9

Definition at line 91 of file ElggSession.php.

Member Data Documentation

ElggSession::$storage

protected

Definition at line 26 of file ElggSession.php.

The documentation for this class was generated from the following file:

engine/classes/ElggSession.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation