1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
<?php
/**
* Representation of a page title within %MediaWiki.
*
* 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
* @license GPL 2+
* @author Daniel Kinzler
*/
use Wikimedia\Assert\Assert;
/**
* Represents a page (or page fragment) title within %MediaWiki.
*
* @note In contrast to Title, this is designed to be a plain value object. That is,
* it is immutable, does not use global state, and causes no side effects.
*
* @note TitleValue represents the title of a local page (or fragment of a page).
* It does not represent a link, and does not support interwiki prefixes etc.
*
* @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
* @since 1.23
*/
class TitleValue {
/**
* @var int
*/
protected $namespace;
/**
* @var string
*/
protected $dbkey;
/**
* @var string
*/
protected $fragment;
/**
* Constructs a TitleValue.
*
* @note TitleValue expects a valid DB key; typically, a TitleValue is constructed either
* from a database entry, or by a TitleParser. We could apply "some" normalization here,
* such as substituting spaces by underscores, but that would encourage the use of
* un-normalized text when constructing TitleValues. For constructing a TitleValue from
* user input or external sources, use a TitleParser.
*
* @param int $namespace The namespace ID. This is not validated.
* @param string $dbkey The page title in valid DBkey form. No normalization is applied.
* @param string $fragment The fragment title. Use '' to represent the whole page.
* No validation or normalization is applied.
*
* @throws InvalidArgumentException
*/
public function __construct( $namespace, $dbkey, $fragment = '' ) {
Assert::parameterType( 'integer', $namespace, '$namespace' );
Assert::parameterType( 'string', $dbkey, '$dbkey' );
Assert::parameterType( 'string', $fragment, '$fragment' );
// Sanity check, no full validation or normalization applied here!
Assert::parameter( !preg_match( '/^_|[ \r\n\t]|_$/', $dbkey ), '$dbkey', 'invalid DB key' );
Assert::parameter( $dbkey !== '', '$dbkey', 'should not be empty' );
$this->namespace = $namespace;
$this->dbkey = $dbkey;
$this->fragment = $fragment;
}
/**
* @return int
*/
public function getNamespace() {
return $this->namespace;
}
/**
* @return string
*/
public function getFragment() {
return $this->fragment;
}
/**
* Returns the title's DB key, as supplied to the constructor,
* without namespace prefix or fragment.
*
* @return string
*/
public function getDBkey() {
return $this->dbkey;
}
/**
* Returns the title in text form,
* without namespace prefix or fragment.
*
* This is computed from the DB key by replacing any underscores with spaces.
*
* @note To get a title string that includes the namespace and/or fragment,
* use a TitleFormatter.
*
* @return string
*/
public function getText() {
return str_replace( '_', ' ', $this->getDBkey() );
}
/**
* Creates a new TitleValue for a different fragment of the same page.
*
* @param string $fragment The fragment name, or "" for the entire page.
*
* @return TitleValue
*/
public function createFragmentTitle( $fragment ) {
return new TitleValue( $this->namespace, $this->dbkey, $fragment );
}
/**
* Returns a string representation of the title, for logging. This is purely informative
* and must not be used programmatically. Use the appropriate TitleFormatter to generate
* the correct string representation for a given use.
*
* @return string
*/
public function __toString() {
$name = $this->namespace . ':' . $this->dbkey;
if ( $this->fragment !== '' ) {
$name .= '#' . $this->fragment;
}
return $name;
}
}
|
