MediaWiki  1.28.0
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) 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)
 

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

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

Member Function Documentation

MediaWiki\Session\PHPSessionHandler::close ( )

Close the session (handler)

Access:
private For internal use only
Returns
bool Success

Definition at line 187 of file PHPSessionHandler.php.

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

Destroy a session.

Access:
private For internal use only
Parameters
string$idSession id
Returns
bool Success

Definition at line 335 of file PHPSessionHandler.php.

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

Execute garbage collection.

Access:
private For internal use only
Parameters
int$maxlifetimeMaximum session life time (ignored)
Returns
bool Success

Definition at line 355 of file PHPSessionHandler.php.

References store.

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

Initialize the session (handler)

Access:
private For internal use only
Parameters
string$save_pathPath used to store session files (ignored)
string$session_nameSession name (ignored)
Returns
bool Success

Definition at line 172 of file PHPSessionHandler.php.

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

Read session data.

Access:
private For internal use only
Parameters
string$idSession id
Returns
string Session data

Definition at line 201 of file PHPSessionHandler.php.

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$PHPSessionHandlingSee $wgPHPSessionHandling

Definition at line 69 of file PHPSessionHandler.php.

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

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

Set the manager, store, and logger.

Access:
private Use self::install().
Parameters
SessionManager$manager
BagOStuff$store
LoggerInterface$store

Definition at line 150 of file PHPSessionHandler.php.

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

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

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

Write session data.

Access:
private For internal use only
Parameters
string$idSession id
string$dataStrSession 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 Success

Definition at line 229 of file PHPSessionHandler.php.

References $cache, $value, as, and wfDeprecated().

Member Data Documentation

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

Whether PHP session handling is enabled.

Definition at line 39 of file PHPSessionHandler.php.

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

Definition at line 36 of file PHPSessionHandler.php.

LoggerInterface MediaWiki\Session\PHPSessionHandler::$logger
protected
SessionManager null MediaWiki\Session\PHPSessionHandler::$manager
protected
array MediaWiki\Session\PHPSessionHandler::$sessionFieldCache = []
protected

Track original session fields for later modification check.

Definition at line 52 of file PHPSessionHandler.php.

BagOStuff null MediaWiki\Session\PHPSessionHandler::$store
protected
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: