tests/phpunit/includes/session/TestBagOStuff.php

   1 <?php
   2
   3 namespace MediaWiki\Session;
   4
   5 /**
   6  * BagOStuff with utility functions for MediaWiki\\Session\\* testing
   7  */
   8 class TestBagOStuff extends \HashBagOStuff {
   9
  10         /**
  11          * @param string $id Session ID
  12          * @param array $data Session data
  13          * @param int $expiry Expiry
  14          * @param User $user User for metadata
  15          */
  16         public function setSessionData( $id, array $data, $expiry = 0, User $user = null ) {
  17                 $this->setSession( $id, array( 'data' => $data ), $expiry, $user );
  18         }
  19
  20         /**
  21          * @param string $id Session ID
  22          * @param array $metadata Session metadata
  23          * @param int $expiry Expiry
  24          */
  25         public function setSessionMeta( $id, array $metadata, $expiry = 0 ) {
  26                 $this->setSession( $id, array( 'metadata' => $metadata ), $expiry );
  27         }
  28
  29         /**
  30          * @param string $id Session ID
  31          * @param array $blob Session metadata and data
  32          * @param int $expiry Expiry
  33          * @param User $user User for metadata
  34          */
  35         public function setSession( $id, array $blob, $expiry = 0, User $user = null ) {
  36                 $blob += array(
  37                         'data' => array(),
  38                         'metadata' => array(),
  39                 );
  40                 $blob['metadata'] += array(
  41                         'userId' => $user ? $user->getId() : 0,
  42                         'userName' => $user ? $user->getName() : null,
  43                         'userToken' => $user ? $user->getToken( true ) : null,
  44                         'provider' => 'DummySessionProvider',
  45                 );
  46
  47                 $this->setRawSession( $id, $blob, $expiry, $user );
  48         }
  49
  50         /**
  51          * @param string $id Session ID
  52          * @param array|mixed $blob Session metadata and data
  53          * @param int $expiry Expiry
  54          */
  55         public function setRawSession( $id, $blob, $expiry = 0 ) {
  56                 if ( $expiry <= 0 ) {
  57                         $expiry = \RequestContext::getMain()->getConfig()->get( 'ObjectCacheSessionExpiry' );
  58                 }
  59
  60                 $this->set( wfMemcKey( '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( wfMemcKey( 'MWSession', $id ) );
  69         }
  70
  71         /**
  72          * @param string $id Session ID
  73          */
  74         public function deleteSession( $id ) {
  75                 $this->delete( wfMemcKey( 'MWSession', $id ) );
  76         }
  77
  78 }