Elgg\SessionManagerService Class Reference

Session manager. More...

Public Member Functions
	__construct (\ElggSession $session, EventsService $events, Translator $translator, PersistentLoginService $persistent_login, SessionCache $session_cache, EntityCache $entity_cache)
	Constructor. More...
	getIgnoreAccess ()
	Get current ignore access setting. More...
	setIgnoreAccess (bool $ignore=true)
	Set ignore access. More...
	getDisabledEntityVisibility ()
	Are disabled entities shown? More...
	setDisabledEntityVisibility (bool $show=true)
	Include disabled entities in queries. More...
	setUserToken (\ElggUser $user=null)
	Set a user specific token in the session for the currently logged in user. More...
	validateUserToken (\ElggUser $user)
	Validate the user token stored in the session. More...
	login (\ElggUser $user, bool $persistent=false)
	Log in a user. More...
	logout ()
	Log the current user out. 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...

Protected Member Functions
	generateUserToken (\ElggUser $user)
	Generate a token for a specific user. More...

Protected Attributes
	$entity_cache
	$events
	$ignore_access = false
	$logged_in_user
	$persistent_login
	$show_disabled_entities = false
	$session
	$session_cache
	$translator

Detailed Description

Session manager.

Since

5.0

Definition at line 16 of file SessionManagerService.php.

Constructor & Destructor Documentation

Elgg\SessionManagerService::__construct	(	\ElggSession	$session,
		EventsService	$events,
		Translator	$translator,
		PersistentLoginService	$persistent_login,
		SessionCache	$session_cache,
		EntityCache	$entity_cache
	)

Constructor.

Parameters

\ElggSession	$session	the current session
EventsService	$events	the events service
Translator	$translator	the translator service
PersistentLoginService	$persistent_login	the persistent login service
SessionCache	$session_cache	the session cache
EntityCache	$entity_cache	the entity cache

Definition at line 73 of file SessionManagerService.php.

Member Function Documentation

Elgg\SessionManagerService::generateUserToken ( \ElggUser  $user )

protected

Generate a token for a specific user.

Parameters

\ElggUser

$user

the user to generate the token for

Returns

string

Since

3.3.25

Definition at line 183 of file SessionManagerService.php.

Elgg\SessionManagerService::getDisabledEntityVisibility

(

)

Are disabled entities shown?

Returns

bool

Definition at line 117 of file SessionManagerService.php.

Elgg\SessionManagerService::getIgnoreAccess

(

)

Get current ignore access setting.

Returns

bool

Definition at line 94 of file SessionManagerService.php.

Elgg\SessionManagerService::getLoggedInUser

(

)

Gets the logged in user.

Returns

|null

Since

1.9

Definition at line 303 of file SessionManagerService.php.

Elgg\SessionManagerService::getLoggedInUserGuid

(

)

Return the current logged in user by guid.

Returns

int

Definition at line 312 of file SessionManagerService.php.

Elgg\SessionManagerService::isAdminLoggedIn

(

)

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

Returns

bool

Definition at line 322 of file SessionManagerService.php.

Elgg\SessionManagerService::isLoggedIn

(

)

Returns whether or not the user is currently logged in.

Returns

bool

Definition at line 333 of file SessionManagerService.php.

Elgg\SessionManagerService::login	(	\ElggUser	$user,
		bool	$persistent = false
	)

Log in a user.

Parameters

\ElggUser	$user	A valid Elgg user object
boolean	$persistent	Should this be a persistent login?

Returns

void

Exceptions

LoginException

Since

4.3

Definition at line 202 of file SessionManagerService.php.

Elgg\SessionManagerService::logout

(

)

Log the current user out.

Returns

bool

Since

4.3

Definition at line 253 of file SessionManagerService.php.

Elgg\SessionManagerService::removeLoggedInUser

(

)

Remove the logged in user.

Returns

void

Since

1.9

Definition at line 343 of file SessionManagerService.php.

Elgg\SessionManagerService::setDisabledEntityVisibility

(

bool

$show = true

)

Include disabled entities in queries.

Parameters

bool

$show

Visibility status

Returns

bool Previous setting

Definition at line 128 of file SessionManagerService.php.

Elgg\SessionManagerService::setIgnoreAccess

(

bool

$ignore = true

)

Set ignore access.

Parameters

bool

$ignore

Ignore access

Returns

bool Previous setting

Definition at line 105 of file SessionManagerService.php.

Elgg\SessionManagerService::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 285 of file SessionManagerService.php.

Elgg\SessionManagerService::setUserToken

(

\ElggUser

$user = null

)

Set a user specific token in the session for the currently logged in user.

This will invalidate the session on a password change of the logged in user

Parameters

\ElggUser

$user

the user to set the token for (default: logged in user)

Returns

void

Since

3.3.25

Definition at line 145 of file SessionManagerService.php.

Elgg\SessionManagerService::validateUserToken

(

\ElggUser

$user

)

Validate the user token stored in the session.

Parameters

\ElggUser

$user

the user to check for

Returns

void

Exceptions

Definition at line 166 of file SessionManagerService.php.

Member Data Documentation

Elgg\SessionManagerService::$entity_cache

protected

Definition at line 21 of file SessionManagerService.php.

Elgg\SessionManagerService::$events

protected

Definition at line 26 of file SessionManagerService.php.

Elgg\SessionManagerService::$ignore_access = false

protected

Definition at line 31 of file SessionManagerService.php.

Elgg\SessionManagerService::$logged_in_user

protected

Definition at line 36 of file SessionManagerService.php.

Elgg\SessionManagerService::$persistent_login

protected

Definition at line 41 of file SessionManagerService.php.

Elgg\SessionManagerService::$session

protected

Definition at line 51 of file SessionManagerService.php.

Elgg\SessionManagerService::$session_cache

protected

Definition at line 56 of file SessionManagerService.php.

Elgg\SessionManagerService::$show_disabled_entities = false

protected

Definition at line 46 of file SessionManagerService.php.

Elgg\SessionManagerService::$translator

protected

Definition at line 61 of file SessionManagerService.php.

---

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

• engine/classes/Elgg/SessionManagerService.php