includes/session/SessionManagerInterface.php

   1 <?php
   2 /**
   3  * MediaWiki\Session entry point interface
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Session
  22  */
  23
  24 namespace MediaWiki\Session;
  25
  26 use Psr\Log\LoggerAwareInterface;
  27 use User;
  28 use WebRequest;
  29
  30 /**
  31  * This exists to make IDEs happy, so they don't see the
  32  * internal-but-required-to-be-public methods on SessionManager.
  33  *
  34  * @ingroup Session
  35  * @since 1.27
  36  */
  37 interface SessionManagerInterface extends LoggerAwareInterface {
  38         /**
  39          * Fetch the session for a request
  40          *
  41          * @note You probably want to use $request->getSession() instead. It's more
  42          *  efficient and doesn't break FauxRequests or sessions that were changed
  43          *  by $this->getSessionById() or $this->getEmptySession().
  44          * @param WebRequest $request Any existing associated session will be reset
  45          *  to the session corresponding to the data in the request itself.
  46          * @return Session
  47          * @throws \OverflowException if there are multiple sessions tied for top
  48          *  priority in the request. Exception has a property "sessionInfos"
  49          *  holding the SessionInfo objects for the sessions involved.
  50          */
  51         public function getSessionForRequest( WebRequest $request );
  52
  53         /**
  54          * Fetch a session by ID
  55          * @param string $id
  56          * @param bool $create If no session exists for $id, try to create a new one.
  57          *  May still return null if a session for $id exists but cannot be loaded.
  58          * @param WebRequest|null $request Corresponding request. Any existing
  59          *  session associated with this WebRequest object will be overwritten.
  60          * @return Session|null
  61          */
  62         public function getSessionById( $id, $create = false, WebRequest $request = null );
  63
  64         /**
  65          * Fetch a new, empty session
  66          *
  67          * The first provider configured that is able to provide an empty session
  68          * will be used.
  69          *
  70          * @param WebRequest|null $request Corresponding request. Any existing
  71          *  session associated with this WebRequest object will be overwritten.
  72          * @return Session
  73          */
  74         public function getEmptySession( WebRequest $request = null );
  75
  76         /**
  77          * Invalidate sessions for a user
  78          *
  79          * After calling this, existing sessions should be invalid. For mutable
  80          * session providers, this generally means the user has to log in again;
  81          * for immutable providers, it generally means the loss of session data.
  82          *
  83          * @param User $user
  84          */
  85         public function invalidateSessionsForUser( User $user );
  86
  87         /**
  88          * Return the HTTP headers that need varying on.
  89          *
  90          * The return value is such that someone could theoretically do this:
  91          * @code
  92          *  foreach ( $provider->getVaryHeaders() as $header => $options ) {
  93          *      $outputPage->addVaryHeader( $header, $options );
  94          *  }
  95          * @endcode
  96          *
  97          * @return array
  98          */
  99         public function getVaryHeaders();
 100
 101         /**
 102          * Return the list of cookies that need varying on.
 103          * @return string[]
 104          */
 105         public function getVaryCookies();
 106
 107 }