This is the actual workhorse for Session. More...

Collaboration diagram for MediaWiki\Session\SessionBackend:

[legend]

Public Member Functions
	__construct (SessionId $id, SessionInfo $info, CachedBagOStuff $store, LoggerInterface $logger, $lifetime)

	addData (array $newData)
	Add data to the session.

	canSetUser ()
	Indicate whether the session user info can be changed.

	delaySave ()
	Delay automatic saving while multiple updates are being made.

	deregisterSession ( $index)
	Deregister a Session.

	dirty ()
	Mark data as dirty.

	getAllowedUserRights ()
	Fetch the rights allowed the user when this session is active.

&	getData ()
	Fetch the session data array.

	getId ()
	Returns the session ID.

	getLoggedOutTimestamp ()
	Fetch the "logged out" timestamp.

	getProvider ()
	Fetch the SessionProvider for this session.

	getProviderMetadata ()
	Fetch provider metadata.

	getRequest ( $index)
	Returns the request associated with a Session.

	getSession (WebRequest $request)
	Return a new Session for this backend.

	getSessionId ()
	Fetch the SessionId object.

	getUser ()
	Returns the authenticated user for this session.

	isPersistent ()
	Indicate whether this session is persisted across requests.

	persist ()
	Make this session persisted across requests.

	renew ()
	Renew the session by resaving everything.

	resetId ()
	Changes the session ID.

	save ( $closing=false)
	Save the session.

	setForceHTTPS ( $force)
	Set whether HTTPS should be forced.

	setLoggedOutTimestamp ( $ts=null)
	Set the "logged out" timestamp.

	setProviderMetadata ( $metadata)
	Set provider metadata.

	setRememberUser ( $remember)
	Set whether the user should be remembered independently of the session ID.

	setUser ( $user)
	Set a new user for this session.

	shouldForceHTTPS ()
	Whether HTTPS should be forced.

	shouldRememberUser ()
	Indicate whether the user should be remembered independently of the session ID.

	shutdown ()
	Shut down a session.

	suggestLoginUsername ( $index)
	Get a suggested username for the login form.

	unpersist ()
	Make this session not persisted across requests.

Private Member Functions
	autosave ()
	Save the session, unless delayed.

	checkPHPSession ()
	For backwards compatibility, open the PHP session when the global session is persisted.

Private Attributes
bool	$checkPHPSessionRecursionGuard = false

int	$curIndex = 0

array null	$data = null

bool	$dataDirty = false

string	$dataHash = null
	Used to detect subarray modifications.

int	$delaySave = 0

int	$expires = 0

bool	$forceHTTPS = false

bool	$forcePersist = false

SessionId	$id

int	$lifetime

int	$loggedOut = 0

LoggerInterface	$logger

bool	$metaDirty = false

bool	$persist = false

SessionProvider	$provider
	provider

array null	$providerMetadata = null
	provider-specified metadata

bool	$remember = false

WebRequest[]	$requests = []
	Session requests.

bool	$shutdown = false

CachedBagOStuff	$store

bool	$usePhpSessionHandling = true

User	$user

Detailed Description

This is the actual workhorse for Session.

Most code does not need to use this class, you want \MediaWiki\Session\Session. The exceptions are SessionProviders and SessionMetadata hook functions, which get an instance of this class rather than Session.

The reasons for this split are:

A session can be attached to multiple requests, but we want the Session object to have some features that correspond to just one of those requests.
We want reasonable garbage collection behavior, but we also want the SessionManager to hold a reference to every active session so it can be saved when the request ends.

Since: 1.27

Definition at line 49 of file SessionBackend.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\SessionBackend::__construct	(	SessionId	$id,
		SessionInfo	$info,
		CachedBagOStuff	$store,
		LoggerInterface	$logger,
			$lifetime )

Parameters

SessionId	$id
SessionInfo	$info	Session info to populate from
CachedBagOStuff	$store	Backend data store
LoggerInterface	$logger
int	$lifetime	Session data lifetime in seconds

Definition at line 125 of file SessionBackend.php.

Member Function Documentation

◆ addData()

MediaWiki\Session\SessionBackend::addData ( array $newData )

Add data to the session.

Overwrites any existing data under the same keys.

Parameters

array $newData Key-value pairs to add to the session

Definition at line 547 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$data, $value, and(), MediaWiki\Session\SessionBackend\getData(), and wfGetAllCallers().

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession().

◆ autosave()

MediaWiki\Session\SessionBackend::autosave ( )

private

Save the session, unless delayed.

See also: SessionBackend::save()

Definition at line 626 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\delaySave(), and save.

Referenced by MediaWiki\Session\SessionBackend\persist(), MediaWiki\Session\SessionBackend\renew(), MediaWiki\Session\SessionBackend\resetId(), MediaWiki\Session\SessionBackend\setForceHTTPS(), MediaWiki\Session\SessionBackend\setLoggedOutTimestamp(), MediaWiki\Session\SessionBackend\setProviderMetadata(), MediaWiki\Session\SessionBackend\setRememberUser(), MediaWiki\Session\SessionBackend\setUser(), and MediaWiki\Session\SessionBackend\unpersist().

◆ canSetUser()

MediaWiki\Session\SessionBackend::canSetUser ( )

Indicate whether the session user info can be changed.

Returns: bool

Definition at line 406 of file SessionBackend.php.

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

◆ checkPHPSession()

MediaWiki\Session\SessionBackend::checkPHPSession ( )

private

For backwards compatibility, open the PHP session when the global session is persisted.

Definition at line 772 of file SessionBackend.php.

References and(), MediaWiki\Session\SessionManager\getGlobalSession(), MediaWiki\Session\SessionBackend\getId(), and MediaWiki\Session\PHPSessionHandler\isEnabled().

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

◆ delaySave()

MediaWiki\Session\SessionBackend::delaySave ( )

Delay automatic saving while multiple updates are being made.

Calls to save() will not be delayed.

Returns: \Wikimedia\ScopedCallback When this goes out of scope, a save will be triggered

Definition at line 612 of file SessionBackend.php.

References and(), MediaWiki\Session\SessionBackend\delaySave(), and save.

Referenced by MediaWiki\Session\SessionBackend\autosave(), and MediaWiki\Session\SessionBackend\delaySave().

◆ deregisterSession()

MediaWiki\Session\SessionBackend::deregisterSession ( $index )

Deregister a Session.

Access:\n private For use by \MediaWiki\Session\Session::__destruct() only

Parameters

int $index

Definition at line 203 of file SessionBackend.php.

References and(), save, and MediaWiki\Session\SessionBackend\shutdown().

◆ dirty()

MediaWiki\Session\SessionBackend::dirty ( )

Mark data as dirty.

Access:\n private For use by \MediaWiki\Session\Session only.

Definition at line 567 of file SessionBackend.php.

References wfGetAllCallers().

Referenced by MediaWiki\Session\SessionBackendTest\testSave().

◆ getAllowedUserRights()

MediaWiki\Session\SessionBackend::getAllowedUserRights ( )

Fetch the rights allowed the user when this session is active.

Returns: null|string[] Allowed user rights, or null to allow all.

Definition at line 398 of file SessionBackend.php.

◆ getData()

& MediaWiki\Session\SessionBackend::getData ( )

Fetch the session data array.

Note the caller is responsible for calling $this->dirty() if anything in the array is changed.

Access:\n private For use by \MediaWiki\Session\Session only.

Returns: array

Definition at line 536 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$data.

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

◆ getId()

MediaWiki\Session\SessionBackend::getId ( )

Returns the session ID.

Returns: string

Definition at line 224 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$id.

Referenced by MediaWiki\Session\SessionBackend\checkPHPSession(), MediaWiki\Session\SessionManager\deregisterSessionBackend(), MediaWiki\Session\CookieSessionProvider\persistSession(), and MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession().

◆ getLoggedOutTimestamp()

MediaWiki\Session\SessionBackend::getLoggedOutTimestamp ( )

Fetch the "logged out" timestamp.

Returns: int

Definition at line 475 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$loggedOut.

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession().

◆ getProvider()

MediaWiki\Session\SessionBackend::getProvider ( )

Fetch the SessionProvider for this session.

Returns: SessionProviderInterface

Definition at line 281 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$provider.

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

◆ getProviderMetadata()

MediaWiki\Session\SessionBackend::getProviderMetadata ( )

Fetch provider metadata.

Access:\n protected For use by SessionProvider subclasses only

Returns: array|null

Definition at line 502 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$providerMetadata.

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

◆ getRequest()

MediaWiki\Session\SessionBackend::getRequest ( $index )

Returns the request associated with a Session.

Parameters

int $index Session index

Returns: WebRequest

Definition at line 379 of file SessionBackend.php.

References and().

◆ getSession()

MediaWiki\Session\SessionBackend::getSession ( WebRequest $request )

Return a new Session for this backend.

Parameters

WebRequest $request

Returns: Session

Definition at line 191 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$curIndex, and $request.

◆ getSessionId()

MediaWiki\Session\SessionBackend::getSessionId ( )

Fetch the SessionId object.

Access:\n private For internal use by WebRequest

Returns: SessionId

Definition at line 233 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$id.

Referenced by MediaWiki\Session\SessionManager\changeBackendId(), MediaWiki\Session\SessionManager\deregisterSessionBackend(), and MediaWiki\Session\SessionBackend\save().

◆ getUser()

MediaWiki\Session\SessionBackend::getUser ( )

Returns the authenticated user for this session.

Returns: User

Definition at line 390 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$user.

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession(), and MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession().

◆ isPersistent()

MediaWiki\Session\SessionBackend::isPersistent ( )

Indicate whether this session is persisted across requests.

For example, if cookies are set.

Returns: bool

Definition at line 292 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$persist.

Referenced by MediaWiki\Session\SessionBackendTest\testSave().

◆ persist()

MediaWiki\Session\SessionBackend::persist ( )

Make this session persisted across requests.

If the session is already persistent, equivalent to calling $this->renew().

Definition at line 302 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\SessionBackend\persist(), and MediaWiki\Session\SessionBackend\renew().

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionBackend\persist(), MediaWiki\Session\SessionBackend\renew(), MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\unpersist().

◆ renew()

MediaWiki\Session\SessionBackend::renew ( )

Renew the session by resaving everything.

Resets the TTL in the backend store if the session is near expiring, and re-persists the session to any active WebRequests if persistent.

Definition at line 583 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\SessionBackend\persist(), and wfGetAllCallers().

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

◆ resetId()

MediaWiki\Session\SessionBackend::resetId ( )

Changes the session ID.

Returns: string New ID (might be the same as the old)

Definition at line 241 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$id, and(), MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\PHPSessionHandler\isEnabled(), and string.

◆ save()

MediaWiki\Session\SessionBackend::save ( $closing = false )

Save the session.

Update both the backend data and the associated WebRequest(s) to reflect the state of the SessionBackend. This might include persisting or unpersisting the session.

Parameters

bool $closing Whether the session is being closed

Definition at line 641 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackendTest\testSave().

◆ setForceHTTPS()

MediaWiki\Session\SessionBackend::setForceHTTPS ( $force )

Set whether HTTPS should be forced.

Parameters

bool $force

Definition at line 458 of file SessionBackend.php.

References and(), and MediaWiki\Session\SessionBackend\autosave().

◆ setLoggedOutTimestamp()

MediaWiki\Session\SessionBackend::setLoggedOutTimestamp ( $ts = null )

Set the "logged out" timestamp.

Parameters

int | null $ts

Definition at line 483 of file SessionBackend.php.

References and(), and MediaWiki\Session\SessionBackend\autosave().

◆ setProviderMetadata()

MediaWiki\Session\SessionBackend::setProviderMetadata ( $metadata )

Set provider metadata.

Access:\n protected For use by SessionProvider subclasses only

Parameters

array | null $metadata

Definition at line 511 of file SessionBackend.php.

References and(), and MediaWiki\Session\SessionBackend\autosave().

◆ setRememberUser()

MediaWiki\Session\SessionBackend::setRememberUser ( $remember )

Set whether the user should be remembered independently of the session ID.

Parameters

bool $remember

Definition at line 361 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$remember, and(), and MediaWiki\Session\SessionBackend\autosave().

◆ setUser()

MediaWiki\Session\SessionBackend::setUser ( $user )

Set a new user for this session.

Note: This should only be called when the user has been authenticated via a login process

Parameters

User $user User to set on the session. This may become a "UserValue" in the future, or User may be refactored into such.

Definition at line 417 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$user, and(), MediaWiki\Session\SessionBackend\autosave(), and MediaWiki\Session\SessionBackend\canSetUser().

◆ shouldForceHTTPS()

MediaWiki\Session\SessionBackend::shouldForceHTTPS ( )

Whether HTTPS should be forced.

Returns: bool

Definition at line 450 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$forceHTTPS.

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession(), and MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession().

◆ shouldRememberUser()

MediaWiki\Session\SessionBackend::shouldRememberUser ( )

Indicate whether the user should be remembered independently of the session ID.

Returns: bool

Definition at line 352 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$remember.

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession().

◆ shutdown()

MediaWiki\Session\SessionBackend::shutdown ( )

Shut down a session.

Access:\n private For use by \MediaWiki\Session\SessionManager::shutdown() only

Definition at line 215 of file SessionBackend.php.

References save, and MediaWiki\Session\SessionBackend\shutdown().

Referenced by MediaWiki\Session\SessionBackend\deregisterSession(), and MediaWiki\Session\SessionBackend\shutdown().

◆ suggestLoginUsername()

MediaWiki\Session\SessionBackend::suggestLoginUsername ( $index )

Get a suggested username for the login form.

Parameters

int $index Session index

Returns: string|null

Definition at line 439 of file SessionBackend.php.

References and().

◆ unpersist()

MediaWiki\Session\SessionBackend::unpersist ( )

Make this session not persisted across requests.

Definition at line 321 of file SessionBackend.php.

References and(), MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\PHPSessionHandler\isEnabled(), and MediaWiki\Session\SessionBackend\persist().

Member Data Documentation

◆ $checkPHPSessionRecursionGuard

bool MediaWiki\Session\SessionBackend::$checkPHPSessionRecursionGuard = false

private

Definition at line 113 of file SessionBackend.php.

◆ $curIndex

int MediaWiki\Session\SessionBackend::$curIndex = 0

private

Definition at line 90 of file SessionBackend.php.

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

◆ $data

array null MediaWiki\Session\SessionBackend::$data = null

private

Definition at line 63 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\addData(), and MediaWiki\Session\SessionBackend\getData().

◆ $dataDirty

bool MediaWiki\Session\SessionBackend::$dataDirty = false

private

Definition at line 72 of file SessionBackend.php.

◆ $dataHash

string MediaWiki\Session\SessionBackend::$dataHash = null

private

Used to detect subarray modifications.

Definition at line 75 of file SessionBackend.php.

◆ $delaySave

int MediaWiki\Session\SessionBackend::$delaySave = 0

private

Definition at line 108 of file SessionBackend.php.

◆ $expires

int MediaWiki\Session\SessionBackend::$expires = 0

private

Definition at line 102 of file SessionBackend.php.

◆ $forceHTTPS

bool MediaWiki\Session\SessionBackend::$forceHTTPS = false

private

Definition at line 60 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\shouldForceHTTPS().

◆ $forcePersist

bool MediaWiki\Session\SessionBackend::$forcePersist = false

private

Definition at line 66 of file SessionBackend.php.

◆ $id

SessionId MediaWiki\Session\SessionBackend::$id

private

Definition at line 51 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionBackend\getId(), MediaWiki\Session\SessionBackend\getSessionId(), and MediaWiki\Session\SessionBackend\resetId().

◆ $lifetime

int MediaWiki\Session\SessionBackend::$lifetime

private

Definition at line 84 of file SessionBackend.php.

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

◆ $loggedOut

int MediaWiki\Session\SessionBackend::$loggedOut = 0

private

Definition at line 105 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getLoggedOutTimestamp(), and MediaWiki\Session\SessionBackend\save().

◆ $logger

LoggerInterface MediaWiki\Session\SessionBackend::$logger

private

Definition at line 81 of file SessionBackend.php.

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

◆ $metaDirty

bool MediaWiki\Session\SessionBackend::$metaDirty = false

private

Definition at line 69 of file SessionBackend.php.

◆ $persist

bool MediaWiki\Session\SessionBackend::$persist = false

private

Definition at line 54 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\isPersistent(), and MediaWiki\Session\SessionBackend\save().

◆ $provider

SessionProvider MediaWiki\Session\SessionBackend::$provider

private

provider

Definition at line 96 of file SessionBackend.php.

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

◆ $providerMetadata

array null MediaWiki\Session\SessionBackend::$providerMetadata = null

private

provider-specified metadata

Definition at line 99 of file SessionBackend.php.

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

◆ $remember

bool MediaWiki\Session\SessionBackend::$remember = false

private

Definition at line 57 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\save(), MediaWiki\Session\SessionBackend\setRememberUser(), and MediaWiki\Session\SessionBackend\shouldRememberUser().

◆ $requests

WebRequest [] MediaWiki\Session\SessionBackend::$requests = []

private

Session requests.

Definition at line 93 of file SessionBackend.php.

◆ $shutdown

bool MediaWiki\Session\SessionBackend::$shutdown = false

private

Definition at line 116 of file SessionBackend.php.

◆ $store

CachedBagOStuff MediaWiki\Session\SessionBackend::$store

private

Definition at line 78 of file SessionBackend.php.

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

◆ $usePhpSessionHandling

bool MediaWiki\Session\SessionBackend::$usePhpSessionHandling = true

private

Definition at line 111 of file SessionBackend.php.

◆ $user

User MediaWiki\Session\SessionBackend::$user

private

Definition at line 87 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getUser(), MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\setUser().

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

includes/session/SessionBackend.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addData()

◆ autosave()

◆ canSetUser()

◆ checkPHPSession()

◆ delaySave()

◆ deregisterSession()

◆ dirty()

◆ getAllowedUserRights()

◆ getData()

◆ getId()

◆ getLoggedOutTimestamp()

◆ getProvider()

◆ getProviderMetadata()

◆ getRequest()

◆ getSession()

◆ getSessionId()

◆ getUser()

◆ isPersistent()

◆ persist()

◆ renew()

◆ resetId()

◆ save()

◆ setForceHTTPS()

◆ setLoggedOutTimestamp()

◆ setProviderMetadata()

◆ setRememberUser()

◆ setUser()

◆ shouldForceHTTPS()

◆ shouldRememberUser()

◆ shutdown()

◆ suggestLoginUsername()

◆ unpersist()

Member Data Documentation

◆ $checkPHPSessionRecursionGuard

◆ $curIndex

◆ $data

◆ $dataDirty

◆ $dataHash

◆ $delaySave

◆ $expires

◆ $forceHTTPS

◆ $forcePersist

◆ $id

◆ $lifetime

◆ $loggedOut

◆ $logger

◆ $metaDirty

◆ $persist

◆ $provider

◆ $providerMetadata

◆ $remember

◆ $requests

◆ $shutdown

◆ $store

◆ $usePhpSessionHandling

◆ $user