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
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 * @newable
36 *
37 * @ingroup Session
38 * @since 1.27
39 */
40final class SessionId {
41    /** @var string */
42    private $id;
43
44    /**
45     * @stable to call
46     *
47     * @param string $id
48     */
49    public function __construct( $id ) {
50        $this->id = $id;
51    }
52
53    /**
54     * @return string
55     */
56    public function getId() {
57        return $this->id;
58    }
59
60    /**
61     * @internal For use by \MediaWiki\Session\SessionManager only
62     * @param string $id
63     */
64    public function setId( $id ) {
65        $this->id = $id;
66    }
67
68    public function __toString() {
69        return $this->id;
70    }
71
72}