Adapter for PHP's session handling. More...

Inheritance diagram for MediaWiki\Session\PHPSessionHandler:

Collaboration diagram for MediaWiki\Session\PHPSessionHandler:

[legend]

Public Member Functions
	close ()
	Close the session (handler) More...

	destroy ( $id)
	Destroy a session. More...

	gc ( $maxlifetime)
	Execute garbage collection. More...

	open ( $save_path, $session_name)
	Initialize the session (handler) More...

	read ( $id)
	Read session data. More...

	setManager (SessionManager $manager, BagOStuff $store, LoggerInterface $logger)
	Set the manager, store, and logger. More...

	write ( $id, $dataStr)
	Write session data. More...

Static Public Member Functions
static	install (SessionManager $manager)
	Install a session handler for the current web request. More...

static	isEnabled ()
	Test whether the handler is installed and enabled. More...

static	isInstalled ()
	Test whether the handler is installed. More...

Protected Member Functions
	__construct (SessionManager $manager)

Static Protected Member Functions
static	returnFailure ()
	Workaround for PHP5 bug. More...

static	returnSuccess ()
	Workaround for PHP5 bug. More...

Protected Attributes
bool	$enable = false
	Whether PHP session handling is enabled. More...

LoggerInterface	$logger

SessionManager null	$manager

array	$sessionFieldCache = []
	Track original session fields for later modification check. More...

BagOStuff null	$store

	$warn = true

Static Protected Attributes
static PHPSessionHandler	$instance = null

Private Member Functions
	setEnableFlags ( $PHPSessionHandling)
	Set $this->enable and $this->warn. More...

Detailed Description

Adapter for PHP's session handling.

Since: 1.27

Definition at line 34 of file PHPSessionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\PHPSessionHandler::__construct ( SessionManager $manager )

protected

Definition at line 54 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\$manager, RequestContext\getMain(), MediaWiki\Session\PHPSessionHandler\setEnableFlags(), and MediaWiki\Session\SessionManager\setupPHPSessionHandler().

Member Function Documentation

◆ close()

MediaWiki\Session\PHPSessionHandler::close ( )

Close the session (handler)

Access:\n private For internal use only

Returns: bool|int Success (see self::returnSuccess())

Definition at line 214 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\returnSuccess().

◆ destroy()

MediaWiki\Session\PHPSessionHandler::destroy ( $id )

Destroy a session.

Access:\n private For internal use only

Parameters

string $id Session id

Returns: bool|int Success (see self::returnSuccess())

Definition at line 362 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\returnSuccess().

◆ gc()

MediaWiki\Session\PHPSessionHandler::gc ( $maxlifetime )

Execute garbage collection.

Access:\n private For internal use only

Parameters

int $maxlifetime Maximum session life time (ignored)

Returns: bool|int Success (see self::returnSuccess()) See T135576

Definition at line 383 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\returnSuccess(), and store.

◆ install()

static MediaWiki\Session\PHPSessionHandler::install ( SessionManager $manager )

static

Install a session handler for the current web request.

Parameters

SessionManager $manager

Definition at line 108 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\$manager, and MediaWiki\Session\SessionManager\setupPHPSessionHandler().

Referenced by MediaWiki\Session\TestUtils\setSessionManagerSingleton(), MediaWiki\Session\SessionManagerTest\testGetGlobalSession(), RequestContextTest\testImportScopedSession(), MediaWiki\Session\PHPSessionHandlerTest\testInstall(), MediaWiki\Session\SessionBackendTest\testResetIdOfGlobalSession(), MediaWiki\Session\PHPSessionHandlerTest\testSessionHandling(), MediaWiki\Session\SessionBackendTest\testTakeOverGlobalSession(), and MediaWiki\Session\SessionBackendTest\testUnpersistOfGlobalSession().

◆ isEnabled()

static MediaWiki\Session\PHPSessionHandler::isEnabled ( )

static

Test whether the handler is installed and enabled.

Returns: bool

Definition at line 100 of file PHPSessionHandler.php.

Referenced by MediaWiki\Session\SessionBackend\checkPHPSession(), MediaWiki\Session\SessionManager\getGlobalSession(), MediaWiki\Session\SessionBackend\resetId(), MediaWiki\Session\PHPSessionHandlerTest\testEnableFlags(), MediaWiki\Session\SessionBackendTest\testResetIdOfGlobalSession(), MediaWiki\Session\SessionBackendTest\testTakeOverGlobalSession(), MediaWiki\Session\SessionBackendTest\testUnpersistOfGlobalSession(), and MediaWiki\Session\SessionBackend\unpersist().

◆ isInstalled()

static MediaWiki\Session\PHPSessionHandler::isInstalled ( )

static

Test whether the handler is installed.

Returns: bool

Definition at line 92 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\$instance.

Referenced by MediaWiki\Session\TestUtils\setSessionManagerSingleton(), MediaWiki\Session\SessionManagerTest\testGetGlobalSession(), MediaWiki\Session\PHPSessionHandlerTest\testInstall(), MediaWiki\Session\SessionBackendTest\testResetIdOfGlobalSession(), MediaWiki\Session\SessionBackendTest\testTakeOverGlobalSession(), and MediaWiki\Session\SessionBackendTest\testUnpersistOfGlobalSession().

◆ open()

MediaWiki\Session\PHPSessionHandler::open	(	$save_path,
		$session_name
	)

Initialize the session (handler)

Access:\n private For internal use only

Parameters

string	$save_path	Path used to store session files (ignored)
string	$session_name	Session name (ignored)

Returns: bool|int Success (see self::returnSuccess())

Definition at line 199 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\returnSuccess().

◆ read()

MediaWiki\Session\PHPSessionHandler::read ( $id )

Read session data.

Access:\n private For internal use only

Parameters

string $id Session id

Returns: string Session data

Definition at line 228 of file PHPSessionHandler.php.

◆ returnFailure()

static MediaWiki\Session\PHPSessionHandler::returnFailure ( )

staticprotected

Workaround for PHP5 bug.

See also: self::returnSuccess()

Returns: bool|int

Definition at line 188 of file PHPSessionHandler.php.

References false.

Referenced by MediaWiki\Session\PHPSessionHandler\write().

◆ returnSuccess()

static MediaWiki\Session\PHPSessionHandler::returnSuccess ( )

staticprotected

Workaround for PHP5 bug.

PHP5 has a bug in handling boolean return values for SessionHandlerInterface methods, it expects 0 or -1 instead of true or false. See https://wiki.php.net/rfc/session.user.return-value.

PHP7 and HHVM are not affected.

Todo:: When we drop support for Zend PHP 5, this can be removed.

Returns: bool|int

Definition at line 178 of file PHPSessionHandler.php.

References true.

Referenced by MediaWiki\Session\PHPSessionHandler\close(), MediaWiki\Session\PHPSessionHandler\destroy(), MediaWiki\Session\PHPSessionHandler\gc(), MediaWiki\Session\PHPSessionHandler\open(), and MediaWiki\Session\PHPSessionHandler\write().

◆ setEnableFlags()

MediaWiki\Session\PHPSessionHandler::setEnableFlags ( $PHPSessionHandling )

private

Set $this->enable and $this->warn.

Separate just because there doesn't seem to be a good way to test it otherwise.

Parameters

string $PHPSessionHandling See $wgPHPSessionHandling

Definition at line 69 of file PHPSessionHandler.php.

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

◆ setManager()

MediaWiki\Session\PHPSessionHandler::setManager	(	SessionManager	$manager,
		BagOStuff	$store,
		LoggerInterface	$logger
	)

Set the manager, store, and logger.

Access:\n private Use self::install().

Parameters

SessionManager	$manager
BagOStuff	$store
LoggerInterface	$logger

Definition at line 150 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\$logger, MediaWiki\Session\PHPSessionHandler\$manager, MediaWiki\Session\PHPSessionHandler\$store, and store.

◆ write()

MediaWiki\Session\PHPSessionHandler::write	(	$id,
		$dataStr
	)

Write session data.

Access:\n private For internal use only

Parameters

string	$id	Session id
string	$dataStr	Session data. Not that you should ever call this directly, but note that this has the same issues with code injection via user-controlled data as does PHP's unserialize function.

Returns: bool|int Success (see self::returnSuccess())

Definition at line 256 of file PHPSessionHandler.php.

References $cache, $value, as, MediaWiki\Session\PHPSessionHandler\returnFailure(), MediaWiki\Session\PHPSessionHandler\returnSuccess(), and wfDeprecated().

Member Data Documentation

◆ $enable

bool MediaWiki\Session\PHPSessionHandler::$enable = false

protected

Whether PHP session handling is enabled.

Definition at line 39 of file PHPSessionHandler.php.

◆ $instance

PHPSessionHandler MediaWiki\Session\PHPSessionHandler::$instance = null

staticprotected

Definition at line 36 of file PHPSessionHandler.php.

Referenced by MediaWiki\Session\PHPSessionHandler\isInstalled().

◆ $logger

LoggerInterface MediaWiki\Session\PHPSessionHandler::$logger

protected

Definition at line 49 of file PHPSessionHandler.php.

Referenced by MediaWiki\Session\PHPSessionHandler\setManager().

◆ $manager

SessionManager null MediaWiki\Session\PHPSessionHandler::$manager

protected

Definition at line 43 of file PHPSessionHandler.php.

Referenced by MediaWiki\Session\PHPSessionHandler\__construct(), MediaWiki\Session\PHPSessionHandler\install(), and MediaWiki\Session\PHPSessionHandler\setManager().

◆ $sessionFieldCache

array MediaWiki\Session\PHPSessionHandler::$sessionFieldCache = []

protected

Track original session fields for later modification check.

Definition at line 52 of file PHPSessionHandler.php.

◆ $store

BagOStuff null MediaWiki\Session\PHPSessionHandler::$store

protected

Definition at line 46 of file PHPSessionHandler.php.

Referenced by MediaWiki\Session\PHPSessionHandler\setManager().

◆ $warn

MediaWiki\Session\PHPSessionHandler::$warn = true

protected

Definition at line 40 of file PHPSessionHandler.php.

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

includes/session/PHPSessionHandler.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ destroy()

◆ gc()

◆ install()

◆ isEnabled()

◆ isInstalled()

◆ open()

◆ read()

◆ returnFailure()

◆ returnSuccess()

◆ setEnableFlags()

◆ setManager()

◆ write()

Member Data Documentation

◆ $enable

◆ $instance

◆ $logger

◆ $manager

◆ $sessionFieldCache

◆ $store

◆ $warn