1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
72 lines
1.7 KiB
PHP
72 lines
1.7 KiB
PHP
<?php
|
|
/**
|
|
* MediaWiki session ID holder
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Session
|
|
*/
|
|
|
|
namespace MediaWiki\Session;
|
|
|
|
/**
|
|
* Value object holding the session ID in a manner that can be globally
|
|
* updated.
|
|
*
|
|
* This class exists because we want WebRequest to refer to the session, but it
|
|
* can't hold the Session itself due to issues with circular references and it
|
|
* can't just hold the ID as a string because we need to be able to update the
|
|
* ID when SessionBackend::resetId() is called.
|
|
*
|
|
* @newable
|
|
*
|
|
* @ingroup Session
|
|
* @since 1.27
|
|
*/
|
|
final class SessionId {
|
|
/** @var string */
|
|
private $id;
|
|
|
|
/**
|
|
* @stable to call
|
|
*
|
|
* @param string $id
|
|
*/
|
|
public function __construct( $id ) {
|
|
$this->id = $id;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getId() {
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* @internal For use by \MediaWiki\Session\SessionManager only
|
|
* @param string $id
|
|
*/
|
|
public function setId( $id ) {
|
|
$this->id = $id;
|
|
}
|
|
|
|
public function __toString() {
|
|
return $this->id;
|
|
}
|
|
|
|
}
|