Elgg\SessionManagerService Class Reference

Session manager. More...

Public Member Functions
	__construct (protected \ElggSession $session, protected EventsService $events, protected Translator $translator, protected PersistentLoginService $persistent_login, protected AccessCache $access_cache, protected 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...
	getDeletedEntityVisibility ()
	Are deleted entities shown? More...
	setDeletedEntityVisibility (bool $show=true)
	Include deleted 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, ?bool $migrate=null)
	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 the viewer is currently logged-in and an admin user. More...
	isLoggedIn ()
	Returns whether 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
bool	$ignore_access = false
ElggUser	$logged_in_user = null
bool	$show_disabled_entities = false
bool	$show_deleted_entities = false

Detailed Description

Session manager.

Since

5.0

Definition at line 16 of file SessionManagerService.php.

Constructor & Destructor Documentation

__construct()

Elgg\SessionManagerService::__construct	(	protected \ElggSession	$session,
		protected EventsService	$events,
		protected Translator	$translator,
		protected PersistentLoginService	$persistent_login,
		protected AccessCache	$access_cache,
		protected 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
AccessCache	$access_cache	the access cache
EntityCache	$entity_cache	the entity cache

Definition at line 36 of file SessionManagerService.php.

Member Function Documentation

generateUserToken()

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 165 of file SessionManagerService.php.

getDeletedEntityVisibility()

Elgg\SessionManagerService::getDeletedEntityVisibility

(

)

Are deleted entities shown?

Returns

bool

Since

6.0

Definition at line 98 of file SessionManagerService.php.

getDisabledEntityVisibility()

Elgg\SessionManagerService::getDisabledEntityVisibility

(

)

Are disabled entities shown?

Returns

bool

Definition at line 74 of file SessionManagerService.php.

getIgnoreAccess()

Elgg\SessionManagerService::getIgnoreAccess

(

)

Get current ignore access setting.

Returns

bool

Definition at line 51 of file SessionManagerService.php.

getLoggedInUser()

Elgg\SessionManagerService::getLoggedInUser

(

)

Gets the logged-in user.

Returns

\ElggUser|null

Since

1.9

Definition at line 301 of file SessionManagerService.php.

getLoggedInUserGuid()

Elgg\SessionManagerService::getLoggedInUserGuid

(

)

Return the current logged-in user by guid.

Returns

int

Definition at line 310 of file SessionManagerService.php.

isAdminLoggedIn()

Elgg\SessionManagerService::isAdminLoggedIn

(

)

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

Returns

bool

Definition at line 320 of file SessionManagerService.php.

isLoggedIn()

Elgg\SessionManagerService::isLoggedIn

(

)

Returns whether the user is currently logged-in.

Returns

bool

Definition at line 331 of file SessionManagerService.php.

login()

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 184 of file SessionManagerService.php.

logout()

Elgg\SessionManagerService::logout

(

)

Log the current user out.

Returns

bool

Since

4.3

Definition at line 241 of file SessionManagerService.php.

removeLoggedInUser()

Elgg\SessionManagerService::removeLoggedInUser

(

)

Remove the logged-in user.

Returns

void

Since

1.9

Definition at line 341 of file SessionManagerService.php.

setDeletedEntityVisibility()

Elgg\SessionManagerService::setDeletedEntityVisibility

(

bool

$show = true

)

Include deleted entities in queries.

Parameters

bool

$show

Visibility status

Returns

bool Previous setting

Since

6.0

Definition at line 110 of file SessionManagerService.php.

setDisabledEntityVisibility()

Elgg\SessionManagerService::setDisabledEntityVisibility

(

bool

$show = true

)

Include disabled entities in queries.

Parameters

bool

$show

Visibility status

Returns

bool Previous setting

Definition at line 85 of file SessionManagerService.php.

setIgnoreAccess()

Elgg\SessionManagerService::setIgnoreAccess

(

bool

$ignore = true

)

Set ignore access.

Parameters

bool

$ignore

Ignore access

Returns

bool Previous setting

Definition at line 62 of file SessionManagerService.php.

setLoggedInUser()

Elgg\SessionManagerService::setLoggedInUser	(	\ElggUser	$user,
		?bool	$migrate = null
	)

Sets the logged-in user.

Parameters

\ElggUser	$user	The user who is logged-in
bool | null	$migrate	Migrate the session (default: !\Elgg\Application::isCli())

Returns

void

Since

1.9

Definition at line 275 of file SessionManagerService.php.

setUserToken()

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

null | \ElggUser

$user

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

Returns

void

Since

3.3.25

Definition at line 127 of file SessionManagerService.php.

validateUserToken()

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 148 of file SessionManagerService.php.

Member Data Documentation

$ignore_access

bool Elgg\SessionManagerService::$ignore_access = false

protected

Definition at line 18 of file SessionManagerService.php.

$logged_in_user

ElggUser Elgg\SessionManagerService::$logged_in_user = null

protected

Definition at line 20 of file SessionManagerService.php.

$show_deleted_entities

bool Elgg\SessionManagerService::$show_deleted_entities = false

protected

Definition at line 24 of file SessionManagerService.php.

$show_disabled_entities

bool Elgg\SessionManagerService::$show_disabled_entities = false

protected

Definition at line 22 of file SessionManagerService.php.

---

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

• engine/classes/Elgg/SessionManagerService.php