Value object returned by SessionProvider. More...

Inherits Stringable.

Collaboration diagram for MediaWiki\Session\SessionInfo:

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".

	needsRefresh ()
	Indicate that the session metadata needs to be re-persisted.

	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.

Detailed Description

Value object returned by SessionProvider.

This holds the data necessary to construct a Session. May require services to be injected into the constructor.

Stability: newable

Since: 1.27

Definition at line 22 of file SessionInfo.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\SessionInfo::__construct	(		$priority,
		array	$data )

Stability: stable: to call

Parameters

int	$priority	Session 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. This is ignored if $wgForceHTTPS is true. 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. needsRefresh: (bool, since 1.45) Set to true if the session metadata needs to be re-persisted for some reason. This will result in Session::save() being called. 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 92 of file SessionInfo.php.

References MediaWiki\Session\SessionInfo\forceHTTPS(), MediaWiki\Session\SessionInfo\forceUse(), MediaWiki\Session\SessionInfo\needsRefresh(), and MediaWiki\Session\SessionManager\validateSessionId().

Member Function Documentation

◆ __toString()

MediaWiki\Session\SessionInfo::__toString ( )

Definition at line 287 of file SessionInfo.php.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\refreshSessionInfo().

◆ 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 299 of file SessionInfo.php.

◆ forceHTTPS()

MediaWiki\Session\SessionInfo::forceHTTPS ( )

final

Whether this session should only be used over HTTPS.

This should be ignored if $wgForceHTTPS is true.

Returns: bool

Definition at line 283 of file SessionInfo.php.

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

◆ 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 222 of file SessionInfo.php.

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

◆ getId()

MediaWiki\Session\SessionInfo::getId ( )

final

Return the session ID.

Returns: string

Definition at line 182 of file SessionInfo.php.

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

◆ getPriority()

MediaWiki\Session\SessionInfo::getPriority ( )

final

Return the priority.

Returns: int

Definition at line 230 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\CookieSessionProvider\verifyJwtCookie().

◆ getProvider()

MediaWiki\Session\SessionInfo::getProvider ( )

final

Return the provider.

Returns: SessionProvider|null

Definition at line 174 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ getProviderMetadata()

MediaWiki\Session\SessionInfo::getProviderMetadata ( )

final

Return provider metadata.

Returns: array|null

Definition at line 254 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionBackend\__construct().

◆ getUserInfo()

MediaWiki\Session\SessionInfo::getUserInfo ( )

final

Return the user.

Returns: UserInfo|null

Definition at line 238 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\CookieSessionProvider\verifyJwtCookie().

◆ 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 198 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionManager\getSessionFromInfo().

◆ needsRefresh()

MediaWiki\Session\SessionInfo::needsRefresh ( )

final

Indicate that the session metadata needs to be re-persisted.

This will result in Session::save() being called.

Since: 1.45

Definition at line 207 of file SessionInfo.php.

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

◆ wasPersisted()

MediaWiki\Session\SessionInfo::wasPersisted ( )

final

Return whether the session is persisted.

Returns: bool

Definition at line 246 of file SessionInfo.php.

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

◆ 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 273 of file SessionInfo.php.

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

Member Data Documentation

◆ MAX_PRIORITY

const MediaWiki\Session\SessionInfo::MAX_PRIORITY = 100

Maximum allowed priority.

Definition at line 27 of file SessionInfo.php.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\__construct(), MediaWiki\Session\CookieSessionProvider\__construct(), and MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().

◆ MIN_PRIORITY

const MediaWiki\Session\SessionInfo::MIN_PRIORITY = 1

Minimum allowed priority.

Definition at line 24 of file SessionInfo.php.

Referenced by MediaWiki\Session\SessionProvider\__construct(), MediaWiki\Session\BotPasswordSessionProvider\__construct(), and MediaWiki\Session\CookieSessionProvider\__construct().

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

includes/Session/SessionInfo.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ compare()

◆ forceHTTPS()

◆ forceUse()

◆ getId()

◆ getPriority()

◆ getProvider()

◆ getProviderMetadata()

◆ getUserInfo()

◆ isIdSafe()

◆ needsRefresh()

◆ wasPersisted()

◆ wasRemembered()

Member Data Documentation

◆ MAX_PRIORITY

◆ MIN_PRIORITY