ElggSession Class Reference

Inheritance diagram for ElggSession:

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...
	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...
	del ($key)
	Alias to offsetUnset() 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...
	get_ignore_access ()
	Alias of getIgnoreAccess() More...
	set_ignore_access ($ignore=true)
	Alias of setIgnoreAccess() More...
	__isset ($key)
	Test if property is set either as an attribute or metadata. More...
	offsetSet ($key, $value)
	Set a value, go straight to session. More...
	offsetGet ($key)
	Get a variable from either the session, or if its not in the session attempt to get it from an api call. More...
	offsetUnset ($key)
	Unset a value from the cache and the session. More...
	offsetExists ($offset)
	Return whether the value is set in either the session or the cache. More...

Static Public Member Functions
static	getMock ()
	Get an isolated ElggSession that does not persist between requests. More...

Protected Member Functions
	generateSessionToken ()
	Adds a token to the session. More...

Protected Attributes
	$storage
	$logged_in_user
	$ignore_access = false

Detailed Description

Definition at line 22 of file ElggSession.php.

Constructor & Destructor Documentation

ElggSession::__construct

(

SessionInterface

$storage

)

Constructor.

Parameters

SessionInterface

$storage

The underlying Session implementation private Use elgg_get_session()

Definition at line 45 of file ElggSession.php.

Member Function Documentation

ElggSession::__isset

(

$key

)

Test if property is set either as an attribute or metadata.

Parameters

string

$key

The name of the attribute or metadata.

Returns

bool

Definition at line 345 of file ElggSession.php.

ElggSession::del

(

$key

)

Alias to offsetUnset()

Parameters

string

$key

Name

Returns

void

Definition at line 181 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 330 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 148 of file ElggSession.php.

ElggSession::get_ignore_access

(

)

Alias of getIgnoreAccess()

Returns

bool

Definition at line 300 of file ElggSession.php.

ElggSession::getId

(

)

Get the session ID.

Returns

string

Since

1.9

Definition at line 105 of file ElggSession.php.

ElggSession::getIgnoreAccess

(

)

Get current ignore access setting.

Returns

bool

Definition at line 271 of file ElggSession.php.

ElggSession::getLoggedInUser

(

)

Gets the logged in user.

Returns

|null

Since

1.9

Definition at line 219 of file ElggSession.php.

ElggSession::getLoggedInUserGuid

(

)

Return the current logged in user by guid.

See also

elgg_get_logged_in_user_entity()

Returns

int

Definition at line 229 of file ElggSession.php.

static ElggSession::getMock ( )

static

Get an isolated ElggSession that does not persist between requests.

Returns

self

Definition at line 463 of file ElggSession.php.

ElggSession::getName

(

)

Get the session name.

Returns

string

Since

1.9

Definition at line 126 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 193 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 81 of file ElggSession.php.

ElggSession::isAdminLoggedIn

(

)

Returns whether or not the viewer is currently logged in and an admin user.

Returns

bool

Definition at line 239 of file ElggSession.php.

ElggSession::isLoggedIn

(

)

Returns whether or not the user is currently logged in.

Returns

bool

Definition at line 250 of file ElggSession.php.

ElggSession::isStarted

(

)

Has the session been started.

Returns

boolean

Since

1.9

Definition at line 95 of file ElggSession.php.

ElggSession::migrate

(

$destroy = false

)

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 69 of file ElggSession.php.

ElggSession::offsetExists

(

$offset

)

Return whether the value is set in either the session or the cache.

See also

::offsetExists()

Parameters

int

$offset

Offset

Returns

bool

Definition at line 438 of file ElggSession.php.

ElggSession::offsetGet

(

$key

)

Get a variable from either the session, or if its not in the session attempt to get it from an api call.

See also

::offsetGet()

Parameters

mixed

$key

Name

Returns

mixed

Definition at line 376 of file ElggSession.php.

ElggSession::offsetSet	(		$key,
			$value
	)

Set a value, go straight to session.

Parameters

string	$key	Name
mixed	$value	Value

Returns

void

Definition at line 360 of file ElggSession.php.

ElggSession::offsetUnset

(

$key

)

Unset a value from the cache and the session.

See also

::offsetUnset()

Parameters

mixed

$key

Name

Returns

void

Definition at line 423 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 170 of file ElggSession.php.

ElggSession::removeLoggedInUser

(

)

Remove the logged in user.

Returns

void

Since

1.9

Definition at line 260 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 159 of file ElggSession.php.

ElggSession::set_ignore_access

(

$ignore = true

)

Alias of setIgnoreAccess()

Parameters

bool

$ignore

Ignore access

Returns

bool Previous setting

Definition at line 317 of file ElggSession.php.

ElggSession::setId

(

$id

)

Set the session ID.

Parameters

string

$id

Session ID

Returns

void

Since

1.9

Definition at line 116 of file ElggSession.php.

ElggSession::setIgnoreAccess

(

$ignore = true

)

Set ignore access.

Parameters

bool

$ignore

Ignore access

Returns

bool Previous setting

Definition at line 282 of file ElggSession.php.

ElggSession::setLoggedInUser

(

\ElggUser

$user

)

Sets the logged in user.

Parameters

\ElggUser

$user

The user who is logged in

Returns

void

Since

1.9

Definition at line 204 of file ElggSession.php.

ElggSession::setName

(

$name

)

Set the session name.

Parameters

string

$name

Session name

Returns

void

Since

1.9

Definition at line 137 of file ElggSession.php.

ElggSession::start

(

)

Start the session.

Returns

boolean

Exceptions

RuntimeException

If session fails to start.

Since

1.9

Definition at line 56 of file ElggSession.php.

Member Data Documentation

ElggSession::$ignore_access = false

protected

Definition at line 37 of file ElggSession.php.

ElggSession::$logged_in_user

protected

Definition at line 32 of file ElggSession.php.

ElggSession::$storage

protected

Definition at line 27 of file ElggSession.php.

---

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

• engine/classes/ElggSession.php