MediaWiki REL1_33
Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
MediaWiki\Session\SessionInfo Class Reference

Value object returned by SessionProvider. More...

Collaboration diagram for MediaWiki\Session\SessionInfo:
Collaboration graph
[legend]

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.
 

Private Attributes

bool $forceHTTPS = false
 
bool $forceUse = false
 
string $id
 
bool $idIsSafe = false
 
bool $persisted = false
 
int $priority
 
SessionProvider null $provider
 
array null $providerMetadata = null
 
bool $remembered = false
 
UserInfo null $userInfo = null
 

Detailed Description

Value object returned by SessionProvider.

This holds the data necessary to construct a Session.

Since
1.27

Definition at line 34 of file SessionInfo.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\SessionInfo::__construct ( $priority,
array $data )
Parameters
int$prioritySession priority
array$data
  • provider: (SessionProvider|null) If not given, the provider will be determined from the saved session data.
  • id: (string|null) Session ID
  • userInfo: (UserInfo|null) User known from the request. If $provider->canChangeUser() is false, a verified user must be provided.
  • persisted: (bool) Whether this session was persisted
  • remembered: (bool) Whether the verified user was remembered. Defaults to true.
  • forceHTTPS: (bool) Whether to force HTTPS for this session
  • metadata: (array) Provider metadata, to be returned by Session::getProviderMetadata(). See SessionProvider::mergeMetadata() and SessionProvider::refreshSessionInfo().
  • idIsSafe: (bool) Set true if the 'id' did not come from the user. Generally you'll use this from SessionProvider::newEmptySession(), and not from any other method.
  • forceUse: (bool) Set true if the 'id' is from SessionProvider::hashToSessionId() to delete conflicting session store data instead of discarding this SessionInfo. Ignored unless both 'provider' and 'id' are given.
  • copyFrom: (SessionInfo) SessionInfo to copy other data items from.

Definition at line 96 of file SessionInfo.php.

References $data, MediaWiki\Session\SessionInfo\$priority, MediaWiki\Session\SessionInfo\$provider, and(), MediaWiki\Session\SessionInfo\forceHTTPS(), MediaWiki\Session\SessionInfo\forceUse(), MediaWiki\Session\SessionProvider\getManager(), and MediaWiki\Session\SessionManager\validateSessionId().

Member Function Documentation

◆ __toString()

MediaWiki\Session\SessionInfo::__toString ( )

Definition at line 281 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\getId(), MediaWiki\Session\SessionInfo\getPriority(), and MediaWiki\Session\SessionInfo\getProvider().

◆ compare()

static MediaWiki\Session\SessionInfo::compare ( $a,
$b )
static

Compare two SessionInfo objects by priority.

Parameters
SessionInfo$a
SessionInfo$b
Returns
int Negative if $a < $b, positive if $a > $b, zero if equal

Definition at line 293 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionManager\getEmptySessionInternal(), MediaWiki\Session\SessionManager\getSessionInfoForRequest(), and MediaWiki\Session\SessionInfoTest\testCompare().

◆ forceHTTPS()

MediaWiki\Session\SessionInfo::forceHTTPS ( )
final

Whether this session should only be used over HTTPS.

Returns
bool

Definition at line 277 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$forceHTTPS.

Referenced by MediaWiki\Session\SessionInfo\__construct(), MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ forceUse()

MediaWiki\Session\SessionInfo::forceUse ( )
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.

Returns
bool

Definition at line 218 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$forceUse.

Referenced by MediaWiki\Session\SessionInfo\__construct(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ getId()

MediaWiki\Session\SessionInfo::getId ( )
final

Return the session ID.

Returns
string

Definition at line 187 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$id.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionInfo\__toString(), MediaWiki\Session\SessionManager\getSessionFromInfo(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ getPriority()

MediaWiki\Session\SessionInfo::getPriority ( )
final

Return the priority.

Returns
int

Definition at line 226 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$priority.

Referenced by MediaWiki\Session\SessionInfo\__toString(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ getProvider()

MediaWiki\Session\SessionInfo::getProvider ( )
final

Return the provider.

Returns
SessionProvider|null

Definition at line 179 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$provider.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionInfo\__toString(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ getProviderMetadata()

MediaWiki\Session\SessionInfo::getProviderMetadata ( )
final

Return provider metadata.

Returns
array|null

Definition at line 250 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$providerMetadata.

Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ getUserInfo()

MediaWiki\Session\SessionInfo::getUserInfo ( )
final

Return the user.

Returns
UserInfo|null

Definition at line 234 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$userInfo.

Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ isIdSafe()

MediaWiki\Session\SessionInfo::isIdSafe ( )
final

Indicate whether the ID is "safe".

The ID is safe in the following cases:

  • The ID was randomly generated by the constructor.
  • The ID was found in the backend data store.
  • $this->getProvider()->persistsSessionId() is false.
  • The constructor was explicitly told it's safe using the 'idIsSafe' parameter.
Returns
bool

Definition at line 203 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$idIsSafe.

Referenced by MediaWiki\Session\SessionManager\getSessionFromInfo(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ wasPersisted()

MediaWiki\Session\SessionInfo::wasPersisted ( )
final

Return whether the session is persisted.

Returns
bool

Definition at line 242 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$persisted.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionManager\getSessionFromInfo(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ wasRemembered()

MediaWiki\Session\SessionInfo::wasRemembered ( )
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.

Returns
bool

Definition at line 269 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\$remembered.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionManager\getSessionFromInfo(), and MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

Member Data Documentation

◆ $forceHTTPS

bool MediaWiki\Session\SessionInfo::$forceHTTPS = false
private

Definition at line 60 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\forceHTTPS().

◆ $forceUse

bool MediaWiki\Session\SessionInfo::$forceUse = false
private

Definition at line 66 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\forceUse().

◆ $id

string MediaWiki\Session\SessionInfo::$id
private

Definition at line 45 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\getId().

◆ $idIsSafe

bool MediaWiki\Session\SessionInfo::$idIsSafe = false
private

Definition at line 63 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\isIdSafe().

◆ $persisted

bool MediaWiki\Session\SessionInfo::$persisted = false
private

Definition at line 54 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\wasPersisted().

◆ $priority

int MediaWiki\Session\SessionInfo::$priority
private

Definition at line 48 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\__construct(), and MediaWiki\Session\SessionInfo\getPriority().

◆ $provider

SessionProvider null MediaWiki\Session\SessionInfo::$provider
private

Definition at line 42 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\__construct(), and MediaWiki\Session\SessionInfo\getProvider().

◆ $providerMetadata

array null MediaWiki\Session\SessionInfo::$providerMetadata = null
private

Definition at line 69 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\getProviderMetadata().

◆ $remembered

bool MediaWiki\Session\SessionInfo::$remembered = false
private

Definition at line 57 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\wasRemembered().

◆ $userInfo

UserInfo null MediaWiki\Session\SessionInfo::$userInfo = null
private

Definition at line 51 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionInfo\getUserInfo().

◆ MAX_PRIORITY

const MediaWiki\Session\SessionInfo::MAX_PRIORITY = 100

Maximum allowed priority.

Definition at line 39 of file SessionInfo.php.

Referenced by MediaWiki\Session\CookieSessionProvider\__construct(), MediaWiki\Session\BotPasswordSessionProvider\__construct(), MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest(), MediaWiki\Session\SessionInfoTest\testBasics(), MediaWiki\Session\BotPasswordSessionProviderTest\testConstructor(), MediaWiki\Session\CookieSessionProviderTest\testConstructor(), and MediaWiki\Session\SessionManagerTest\testGetSessionForRequest().

◆ MIN_PRIORITY

const MediaWiki\Session\SessionInfo::MIN_PRIORITY = 1

Minimum allowed priority.

Definition at line 36 of file SessionInfo.php.

Referenced by MediaWiki\Session\CookieSessionProvider\__construct(), MediaWiki\Session\SessionProvider\__construct(), MediaWiki\Session\BotPasswordSessionProvider\__construct(), MediaWiki\Session\SessionBackendTest\getBackend(), MediaWiki\Session\SessionManager\getSessionById(), MediaWiki\Session\SessionInfoTest\testBasics(), MediaWiki\Session\SessionProviderTest\testBasics(), MediaWiki\Session\BotPasswordSessionProviderTest\testCheckSessionInfo(), MediaWiki\Session\SessionInfoTest\testCompare(), MediaWiki\Session\BotPasswordSessionProviderTest\testConstructor(), MediaWiki\Session\CookieSessionProviderTest\testConstructor(), MediaWiki\Session\SessionBackendTest\testConstructor(), MediaWiki\Session\CookieSessionProviderTest\testCookieData(), MediaWiki\Session\SessionManagerTest\testGetEmptySession(), MediaWiki\Session\SessionManagerTest\testGetSessionForRequest(), MediaWiki\Session\SessionManagerTest\testGetSessionFromInfo(), MediaWiki\Session\SessionManagerTest\testLoadSessionInfoFromStore(), MediaWiki\Session\ImmutableSessionProviderWithCookieTest\testPersistSession(), MediaWiki\Session\CookieSessionProviderTest\testPersistSession(), and MediaWiki\Session\CookieSessionProviderTest\testPersistSessionWithHook().

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