Value object holding the session ID in a manner that can be globally updated. More...
Public Member Functions | |
| __construct ( $id) | |
| __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.
- Since
- 1.27
Definition at line 38 of file SessionId.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Session\SessionId::__construct | ( | $id | ) |
- Parameters
-
string $id
Definition at line 45 of file SessionId.php.
References MediaWiki\Session\SessionId\$id.
Member Function Documentation
◆ __toString()
| MediaWiki\Session\SessionId::__toString | ( | ) |
Definition at line 66 of file SessionId.php.
References MediaWiki\Session\SessionId\$id.
◆ getId()
| MediaWiki\Session\SessionId::getId | ( | ) |
Get the ID.
- Returns
- string
Definition at line 53 of file SessionId.php.
References MediaWiki\Session\SessionId\$id.
Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionBackendTest\getBackend(), and MediaWiki\Session\SessionBackendTest\testConstructor().
◆ setId()
| MediaWiki\Session\SessionId::setId | ( | $id | ) |
Set the ID.
- Access:\n private For use by \MediaWiki\Session\SessionManager only
- Parameters
-
string $id
Definition at line 62 of file SessionId.php.
References MediaWiki\Session\SessionId\$id.
Member Data Documentation
◆ $id
|
private |
Definition at line 40 of file SessionId.php.
Referenced by MediaWiki\Session\SessionId\__construct(), MediaWiki\Session\SessionId\__toString(), MediaWiki\Session\SessionId\getId(), and MediaWiki\Session\SessionId\setId().
The documentation for this class was generated from the following file:
- includes/session/SessionId.php
