Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
4 / 4
CRAP
100.00% covered (success)
100.00%
1 / 1
SessionId
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
4 / 4
4
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getId
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 setId
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 __toString
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
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
24namespace MediaWiki\Session;
25
26use Stringable;
27
28/**
29 * Value object holding the session ID in a manner that can be globally
30 * updated.
31 *
32 * This class exists because we want WebRequest to refer to the session, but it
33 * can't hold the Session itself due to issues with circular references and it
34 * can't just hold the ID as a string because we need to be able to update the
35 * ID when SessionBackend::resetId() is called.
36 *
37 * @newable
38 *
39 * @ingroup Session
40 * @since 1.27
41 */
42final class SessionId implements Stringable {
43    /** @var string */
44    private $id;
45
46    /**
47     * @stable to call
48     *
49     * @param string $id
50     */
51    public function __construct( $id ) {
52        $this->id = $id;
53    }
54
55    /**
56     * @return string
57     */
58    public function getId() {
59        return $this->id;
60    }
61
62    /**
63     * @internal For use by \MediaWiki\Session\SessionManager only
64     * @param string $id
65     */
66    public function setId( $id ) {
67        $this->id = $id;
68    }
69
70    public function __toString() {
71        return $this->id;
72    }
73
74}