tests/phpunit/includes/session/TestBagOStuff.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Session;
   4
   5 use MediaWiki\MainConfigNames;
   6 use MediaWiki\MediaWikiServices;
   7 use Wikimedia\ObjectCache\CachedBagOStuff;
   8 use Wikimedia\ObjectCache\HashBagOStuff;
   9
  10 /**
  11  * BagOStuff with utility functions for MediaWiki\\Session\\* testing
  12  */
  13 class TestBagOStuff extends CachedBagOStuff {
  14
  15         public function __construct() {
  16                 parent::__construct( new HashBagOStuff );
  17         }
  18
  19         /**
  20          * @param string $id Session ID
  21          * @param array $data Session data
  22          */
  23         public function setSessionData( $id, array $data ) {
  24                 $this->setSession( $id, [ 'data' => $data ] );
  25         }
  26
  27         /**
  28          * @param string $id Session ID
  29          * @param array $metadata Session metadata
  30          */
  31         public function setSessionMeta( $id, array $metadata ) {
  32                 $this->setSession( $id, [ 'metadata' => $metadata ] );
  33         }
  34
  35         /**
  36          * @param string $id Session ID
  37          * @param array $blob Session metadata and data
  38          */
  39         public function setSession( $id, array $blob ) {
  40                 $blob += [
  41                         'data' => [],
  42                         'metadata' => [],
  43                 ];
  44                 $blob['metadata'] += [
  45                         'userId' => 0,
  46                         'userName' => null,
  47                         'userToken' => null,
  48                         'provider' => 'DummySessionProvider',
  49                 ];
  50
  51                 $this->setRawSession( $id, $blob );
  52         }
  53
  54         /**
  55          * @param string $id Session ID
  56          * @param array|mixed $blob Session metadata and data
  57          */
  58         public function setRawSession( $id, $blob ) {
  59                 $expiry = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::ObjectCacheSessionExpiry );
  60                 $this->set( $this->makeKey( 'MWSession', $id ), $blob, $expiry );
  61         }
  62
  63         /**
  64          * @param string $id Session ID
  65          * @return mixed
  66          */
  67         public function getSession( $id ) {
  68                 return $this->get( $this->makeKey( 'MWSession', $id ) );
  69         }
  70
  71         /**
  72          * @param string $id Session ID
  73          * @return mixed
  74          */
  75         public function getSessionFromBackend( $id ) {
  76                 return $this->store->get( $this->makeKey( 'MWSession', $id ) );
  77         }
  78
  79         /**
  80          * @param string $id Session ID
  81          */
  82         public function deleteSession( $id ) {
  83                 $this->delete( $this->makeKey( 'MWSession', $id ) );
  84         }
  85
  86 }
  87
  88 /** @deprecated class alias since 1.42 */
  89 class_alias( TestBagOStuff::class, 'MediaWiki\\Session\\TestBagOStuff' );