Session manager.
More...
Session manager.
- Since
- 5.0
Definition at line 16 of file SessionManagerService.php.
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.
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 |
( |
| ) |
|
Elgg\SessionManagerService::getIgnoreAccess |
( |
| ) |
|
Elgg\SessionManagerService::getLoggedInUser |
( |
| ) |
|
Elgg\SessionManagerService::getLoggedInUserGuid |
( |
| ) |
|
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 |
( |
| ) |
|
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
-
- Since
- 4.3
Definition at line 202 of file SessionManagerService.php.
Elgg\SessionManagerService::logout |
( |
| ) |
|
Elgg\SessionManagerService::removeLoggedInUser |
( |
| ) |
|
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 | ) |
|
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.
Elgg\SessionManagerService::$entity_cache |
|
protected |
Elgg\SessionManagerService::$events |
|
protected |
Elgg\SessionManagerService::$ignore_access = false |
|
protected |
Elgg\SessionManagerService::$logged_in_user |
|
protected |
Elgg\SessionManagerService::$persistent_login |
|
protected |
Elgg\SessionManagerService::$session |
|
protected |
Elgg\SessionManagerService::$session_cache |
|
protected |
Elgg\SessionManagerService::$show_disabled_entities = false |
|
protected |
Elgg\SessionManagerService::$translator |
|
protected |
The documentation for this class was generated from the following file: