MediaWiki\Session\PHPSessionHandler Class Reference

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

Inheritance diagram for MediaWiki\Session\PHPSessionHandler:

Collaboration diagram for MediaWiki\Session\PHPSessionHandler:

Public Member Functions
	close ()
	Close the session (handler)
	destroy ( $id)
	Destroy a session.
	gc ( $maxlifetime)
	Execute garbage collection.
	open ( $save_path, $session_name)
	Initialize the session (handler)
	read ( $id)
	Read session data.
	setManager (SessionManagerInterface $manager, BagOStuff $store, LoggerInterface $logger)
	Set the manager, store, and logger.
	write ( $id, $dataStr)
	Write session data.

Static Public Member Functions
static	install (SessionManager $manager)
	Install a session handler for the current web request.
static	isEnabled ()
	Test whether the handler is installed and enabled.
static	isInstalled ()
	Test whether the handler is installed.

Protected Member Functions
	__construct (SessionManager $manager)

Protected Attributes
bool	$enable = false
	Whether PHP session handling is enabled.
LoggerInterface	$logger
SessionManagerInterface null	$manager
array	$sessionFieldCache = []
	Track original session fields for later modification check.
BagOStuff null	$store
bool	$warn = true

Static Protected Attributes
static PHPSessionHandler	$instance = null

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

Detailed Description

Adapter for PHP's session handling.

Since

1.27

Definition at line 35 of file PHPSessionHandler.php.

Constructor & Destructor Documentation

__construct()

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

protected

Definition at line 57 of file PHPSessionHandler.php.

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

Member Function Documentation

close()

MediaWiki\Session\PHPSessionHandler::close

(

)

Close the session (handler)

Definition at line 198 of file PHPSessionHandler.php.

destroy()

MediaWiki\Session\PHPSessionHandler::destroy

(

$id

)

Destroy a session.

Definition at line 349 of file PHPSessionHandler.php.

gc()

MediaWiki\Session\PHPSessionHandler::gc

(

$maxlifetime

)

Execute garbage collection.

Definition at line 371 of file PHPSessionHandler.php.

install()

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

static

Install a session handler for the current web request.

Parameters

SessionManager

$manager

Definition at line 111 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\$manager.

isEnabled()

static MediaWiki\Session\PHPSessionHandler::isEnabled ( )

static

Test whether the handler is installed and enabled.

Returns

bool

Definition at line 103 of file PHPSessionHandler.php.

Referenced by MediaWiki\Session\SessionBackend\checkPHPSession(), MediaWiki\Session\SessionManager\getGlobalSession(), MediaWiki\Session\SessionBackend\resetId(), and MediaWiki\Session\SessionBackend\unpersist().

isInstalled()

static MediaWiki\Session\PHPSessionHandler::isInstalled ( )

static

Test whether the handler is installed.

Returns

bool

Definition at line 95 of file PHPSessionHandler.php.

References MediaWiki\Session\PHPSessionHandler\$instance.

open()

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

Initialize the session (handler)

Definition at line 182 of file PHPSessionHandler.php.

read()

MediaWiki\Session\PHPSessionHandler::read

(

$id

)

Read session data.

Definition at line 213 of file PHPSessionHandler.php.

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 72 of file PHPSessionHandler.php.

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

setManager()

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

Set the manager, store, and logger.

Definition at line 159 of file PHPSessionHandler.php.

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

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

write()

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

Write session data.

Definition at line 242 of file PHPSessionHandler.php.

References $cache, and wfDeprecated().

Member Data Documentation

$enable

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

protected

Whether PHP session handling is enabled.

Definition at line 40 of file PHPSessionHandler.php.

$instance

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

staticprotected

Definition at line 37 of file PHPSessionHandler.php.

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

$logger

LoggerInterface MediaWiki\Session\PHPSessionHandler::$logger

protected

Definition at line 52 of file PHPSessionHandler.php.

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

$manager

SessionManagerInterface null MediaWiki\Session\PHPSessionHandler::$manager

protected

Definition at line 46 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 55 of file PHPSessionHandler.php.

$store

BagOStuff null MediaWiki\Session\PHPSessionHandler::$store

protected

Definition at line 49 of file PHPSessionHandler.php.

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

$warn

bool MediaWiki\Session\PHPSessionHandler::$warn = true

protected

Definition at line 43 of file PHPSessionHandler.php.

---

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

• includes/session/PHPSessionHandler.php