MediaWiki REL1_31
Static Public Member Functions | List of all members
MediaWiki\Session\TestUtils Class Reference

Utility functions for Session unit tests. More...

Static Public Member Functions

static getDummySession ( $backend=null, $index=-1, $logger=null)
 If you need a Session for testing but don't want to create a backend to construct one, use this.
 
static getDummySessionBackend ()
 If you need a SessionBackend for testing but don't want to create a real one, use this.
 
static setSessionManagerSingleton (SessionManager $manager=null)
 Override the singleton for unit testing.
 

Detailed Description

Utility functions for Session unit tests.

Definition at line 11 of file TestUtils.php.

Member Function Documentation

◆ getDummySession()

static MediaWiki\Session\TestUtils::getDummySession ( $backend = null,
$index = -1,
$logger = null )
static

If you need a Session for testing but don't want to create a backend to construct one, use this.

Parameters
object$backendObject to serve as the SessionBackend
int$index
LoggerInterface$logger
Returns
Session

Definition at line 86 of file TestUtils.php.

Referenced by MediaWiki\Session\SessionTest\testArrayAccess(), MediaWiki\Session\SessionTest\testClear(), MediaWiki\Session\SessionTest\testDataAccess(), MediaWiki\Session\SessionTest\testMethods(), MediaWiki\Session\SessionTest\testSecrets(), MediaWiki\Session\SessionTest\testSecretsRoundTripping(), and MediaWiki\Session\SessionTest\testTokens().

◆ getDummySessionBackend()

static MediaWiki\Session\TestUtils::getDummySessionBackend ( )
static

If you need a SessionBackend for testing but don't want to create a real one, use this.

Returns
SessionBackend Unconfigured! Use reflection to set any private fields necessary.

Definition at line 65 of file TestUtils.php.

References $ret.

Referenced by MediaWiki\Session\SessionTest\testConstructor(), MediaWiki\Session\BotPasswordSessionProviderTest\testGetAllowedUserRights(), and MediaWiki\Session\SessionProviderTest\testGetAllowedUserRights().

◆ setSessionManagerSingleton()

static MediaWiki\Session\TestUtils::setSessionManagerSingleton ( SessionManager $manager = null)
static

Override the singleton for unit testing.

Parameters
SessionManager | null$manager
Returns
\\Wikimedia\ScopedCallback|null

Definition at line 18 of file TestUtils.php.

References MediaWiki\Session\PHPSessionHandler\install(), and MediaWiki\Session\PHPSessionHandler\isInstalled().

Referenced by MediaWiki\Session\SessionManagerTest\testGetGlobalSession(), MediaWiki\Session\SessionBackendTest\testResetIdOfGlobalSession(), MediaWiki\Session\SessionManagerTest\testSingleton(), MediaWiki\Session\SessionBackendTest\testTakeOverGlobalSession(), and MediaWiki\Session\SessionBackendTest\testUnpersistOfGlobalSession().

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