MediaWiki master
|
Value object returned by SessionProvider. More...
Inherits Stringable.
Public Member Functions | |
__construct ( $priority, array $data) | |
__toString () | |
forceHTTPS () | |
Whether this session should only be used over HTTPS. | |
forceUse () | |
Force use of this SessionInfo if validation fails. | |
getId () | |
Return the session ID. | |
getPriority () | |
Return the priority. | |
getProvider () | |
Return the provider. | |
getProviderMetadata () | |
Return provider metadata. | |
getUserInfo () | |
Return the user. | |
isIdSafe () | |
Indicate whether the ID is "safe". | |
wasPersisted () | |
Return whether the session is persisted. | |
wasRemembered () | |
Return whether the user was remembered. | |
Static Public Member Functions | |
static | compare ( $a, $b) |
Compare two SessionInfo objects by priority. | |
Public Attributes | |
const | MAX_PRIORITY = 100 |
Maximum allowed priority. | |
const | MIN_PRIORITY = 1 |
Minimum allowed priority. | |
Value object returned by SessionProvider.
This holds the data necessary to construct a Session. May require services to be injected into the constructor.
Definition at line 40 of file SessionInfo.php.
MediaWiki\Session\SessionInfo::__construct | ( | $priority, | |
array | $data ) |
int | $priority | Session priority |
array | $data |
|
Definition at line 105 of file SessionInfo.php.
References MediaWiki\Session\SessionInfo\forceHTTPS(), MediaWiki\Session\SessionInfo\forceUse(), and MediaWiki\Session\SessionManager\validateSessionId().
MediaWiki\Session\SessionInfo::__toString | ( | ) |
Definition at line 292 of file SessionInfo.php.
References MediaWiki\Session\SessionInfo\getId(), MediaWiki\Session\SessionInfo\getPriority(), and MediaWiki\Session\SessionInfo\getProvider().
Referenced by MediaWiki\Session\BotPasswordSessionProvider\refreshSessionInfo().
|
static |
Compare two SessionInfo objects by priority.
SessionInfo | $a | |
SessionInfo | $b |
Definition at line 304 of file SessionInfo.php.
|
final |
Whether this session should only be used over HTTPS.
This should be ignored if $wgForceHTTPS is true.
Definition at line 288 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionInfo\__construct(), and MediaWiki\Session\SessionBackend\__construct().
|
final |
Force use of this SessionInfo if validation fails.
The normal behavior is to discard the SessionInfo if validation against the data stored in the session store fails. If this returns true, SessionManager will instead delete the session store data so this SessionInfo may still be used. This is important for providers which use deterministic IDs and so cannot just generate a random new one.
Definition at line 227 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionInfo\__construct().
|
final |
Return the session ID.
Definition at line 196 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionInfo\__toString(), and MediaWiki\Session\SessionManager\getSessionFromInfo().
|
final |
Return the priority.
Definition at line 235 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionInfo\__toString().
|
final |
Return the provider.
Definition at line 188 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionInfo\__toString().
|
final |
Return provider metadata.
Definition at line 259 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionBackend\__construct().
|
final |
Return the user.
Definition at line 243 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionBackend\__construct().
|
final |
Indicate whether the ID is "safe".
The ID is safe in the following cases:
Definition at line 212 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionManager\getSessionFromInfo().
|
final |
Return whether the session is persisted.
Definition at line 251 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionManager\getSessionFromInfo().
|
final |
Return whether the user was remembered.
For providers that can persist the user separately from the session, the human using it may not actually want that to be done. For example, a cookie-based provider can set cookies that are longer-lived than the backend session data, but on a public terminal the human likely doesn't want those cookies set.
This is false unless a non-anonymous verified user was passed to the SessionInfo constructor by the provider, and the provider didn't pass false for the 'remembered' data item.
Definition at line 278 of file SessionInfo.php.
Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionManager\getSessionFromInfo().
const MediaWiki\Session\SessionInfo::MAX_PRIORITY = 100 |
Maximum allowed priority.
Definition at line 45 of file SessionInfo.php.
Referenced by MediaWiki\Session\CookieSessionProvider\__construct(), MediaWiki\Session\BotPasswordSessionProvider\__construct(), and MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().
const MediaWiki\Session\SessionInfo::MIN_PRIORITY = 1 |
Minimum allowed priority.
Definition at line 42 of file SessionInfo.php.
Referenced by MediaWiki\Session\CookieSessionProvider\__construct(), MediaWiki\Session\SessionProvider\__construct(), MediaWiki\Session\BotPasswordSessionProvider\__construct(), and MediaWiki\Session\SessionManager\getSessionById().