MediaWiki  master
MediaWiki\Session\SessionId Class Reference

Value object holding the session ID in a manner that can be globally updated. More...

Public Member Functions

 __construct ( $id)
 Stable for calling. More...
 
 __toString ()
 
 getId ()
 Get the ID. More...
 
 setId ( $id)
 Set the ID. More...
 

Private Attributes

string $id
 

Detailed Description

Value object holding the session ID in a manner that can be globally updated.

This class exists because we want WebRequest to refer to the session, but it can't hold the Session itself due to issues with circular references and it can't just hold the ID as a string because we need to be able to update the ID when SessionBackend::resetId() is called.

@newable

Since
1.27

Definition at line 40 of file SessionId.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\SessionId::__construct (   $id)

Stable for calling.

Parameters
string$id

Definition at line 49 of file SessionId.php.

References MediaWiki\Session\SessionId\$id.

Member Function Documentation

◆ __toString()

MediaWiki\Session\SessionId::__toString ( )

Definition at line 70 of file SessionId.php.

References MediaWiki\Session\SessionId\$id.

◆ getId()

MediaWiki\Session\SessionId::getId ( )

Get the ID.

Returns
string

Definition at line 57 of file SessionId.php.

References MediaWiki\Session\SessionId\$id.

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

◆ setId()

MediaWiki\Session\SessionId::setId (   $id)

Set the ID.

Definition at line 66 of file SessionId.php.

References MediaWiki\Session\SessionId\$id.

Member Data Documentation

◆ $id


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