includes/session/SessionId.php

   1 <?php
   2 /**
   3  * MediaWiki session ID holder
   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 /**
  27  * Value object holding the session ID in a manner that can be globally
  28  * updated.
  29  *
  30  * This class exists because we want WebRequest to refer to the session, but it
  31  * can't hold the Session itself due to issues with circular references and it
  32  * can't just hold the ID as a string because we need to be able to update the
  33  * ID when SessionBackend::resetId() is called.
  34  *
  35  * @ingroup Session
  36  * @since 1.27
  37  */
  38 final class SessionId {
  39         /** @var string */
  40         private $id;
  41
  42         /**
  43          * @param string $id
  44          */
  45         public function __construct( $id ) {
  46                 $this->id = $id;
  47         }
  48
  49         /**
  50          * Get the ID
  51          * @return string
  52          */
  53         public function getId() {
  54                 return $this->id;
  55         }
  56
  57         /**
  58          * Set the ID
  59          * @private For use by \MediaWiki\Session\SessionManager only
  60          * @param string $id
  61          */
  62         public function setId( $id ) {
  63                 $this->id = $id;
  64         }
  65
  66         public function __toString() {
  67                 return $this->id;
  68         }
  69
  70 }