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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<?php
/**
* A title formatter service for 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
* @author Daniel Kinzler
*/
namespace MediaWiki\Title;
use InvalidArgumentException;
use MediaWiki\Cache\GenderCache;
use MediaWiki\Language\Language;
use MediaWiki\Page\PageReference;
use Wikimedia\Parsoid\Core\LinkTarget;
/**
* A title formatter service for MediaWiki.
*
* This is designed to encapsulate knowledge about conventions for the title
* forms to be used in the database, in urls, in wikitext, etc.
*
* @note Normalization and validation is applied while parsing, not when formatting.
* It's possible to construct a TitleValue with an invalid title, and use TitleFormatter
* to generate an (invalid) title string from it. TitleValues should be constructed only
* via parseTitle() or from a (semi)trusted source, such as the database.
*
* @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
* @since 1.23
*/
class TitleFormatter {
protected Language $language;
protected GenderCache $genderCache;
protected NamespaceInfo $nsInfo;
/**
* @param Language $language The language object to use for localizing namespace names,
* capitalization, etc.
* @param GenderCache $genderCache The gender cache for generating gendered namespace names
* @param NamespaceInfo $nsInfo
*/
public function __construct(
Language $language,
GenderCache $genderCache,
NamespaceInfo $nsInfo
) {
$this->language = $language;
$this->genderCache = $genderCache;
$this->nsInfo = $nsInfo;
}
/**
* Returns the title formatted for display.
* By default, this includes the namespace but not the fragment.
*
* @note Normalization is applied if $title is not in TitleValue::TITLE_FORM.
*
* @param int|false $namespace The namespace ID (or false, if the namespace should be ignored)
* @param string $text The page title. Should be valid. Only minimal normalization is applied.
* Underscores will be replaced.
* @param string $fragment The fragment name (may be empty).
* @param string $interwiki The interwiki prefix (may be empty).
*
* @throws InvalidArgumentException If the namespace is invalid
* @return string
*/
public function formatTitle( $namespace, $text, $fragment = '', $interwiki = '' ) {
$out = '';
if ( $interwiki !== '' ) {
$out = $interwiki . ':';
}
if ( $namespace != 0 ) {
try {
$nsName = $this->getNamespaceName( $namespace, $text );
} catch ( InvalidArgumentException $e ) {
// See T165149. Awkward, but better than erroneously linking to the main namespace.
$nsName = $this->language->getNsText( NS_SPECIAL ) . ":Badtitle/NS{$namespace}";
}
$out .= $nsName . ':';
}
$out .= $text;
if ( $fragment !== '' ) {
$out .= '#' . $fragment;
}
$out = str_replace( '_', ' ', $out );
return $out;
}
/**
* Returns the title text formatted for display, without namespace or fragment.
*
* @param LinkTarget|PageReference $title The title to format
*
* @return string
*/
public function getText( $title ) {
if ( $title instanceof LinkTarget ) {
return $title->getText();
} elseif ( $title instanceof PageReference ) {
return strtr( $title->getDBKey(), '_', ' ' );
} else {
throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $title ) );
}
}
/**
* Returns the title formatted for display, including the namespace name.
*
* @param LinkTarget|PageReference $title The title to format
*
* @return string
* @suppress PhanUndeclaredProperty
*/
public function getPrefixedText( $title ) {
if ( $title instanceof LinkTarget ) {
if ( !isset( $title->prefixedText ) ) {
$title->prefixedText = $this->formatTitle(
$title->getNamespace(),
$title->getText(),
'',
$title->getInterwiki()
);
}
return $title->prefixedText;
} elseif ( $title instanceof PageReference ) {
$title->assertWiki( PageReference::LOCAL );
return $this->formatTitle(
$title->getNamespace(),
$this->getText( $title )
);
} else {
throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $title ) );
}
}
/**
* Return the title in prefixed database key form, with interwiki
* and namespace.
*
* @since 1.27
*
* @param LinkTarget|PageReference $target
* @return string
*/
public function getPrefixedDBkey( $target ) {
if ( $target instanceof LinkTarget ) {
return strtr( $this->formatTitle(
$target->getNamespace(),
$target->getDBkey(),
'',
$target->getInterwiki()
), ' ', '_' );
} elseif ( $target instanceof PageReference ) {
$target->assertWiki( PageReference::LOCAL );
return strtr( $this->formatTitle(
$target->getNamespace(),
$target->getDBkey()
), ' ', '_' );
} else {
throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $target ) );
}
}
/**
* Returns the title formatted for display, with namespace and fragment.
*
* @param LinkTarget|PageReference $title The title to format
*
* @return string
*/
public function getFullText( $title ) {
if ( $title instanceof LinkTarget ) {
return $this->formatTitle(
$title->getNamespace(),
$title->getText(),
$title->getFragment(),
$title->getInterwiki()
);
} elseif ( $title instanceof PageReference ) {
$title->assertWiki( PageReference::LOCAL );
return $this->formatTitle(
$title->getNamespace(),
$this->getText( $title )
);
} else {
throw new InvalidArgumentException( '$title has invalid type: ' . get_class( $title ) );
}
}
/**
* Returns the name of the namespace for the given title.
*
* @note This must take into account gender sensitive namespace names.
*
* @param int $namespace
* @param string $text
*
* @throws InvalidArgumentException If the namespace is invalid
* @return string Namespace name with underscores (not spaces), e.g. 'User_talk'
*/
public function getNamespaceName( $namespace, $text ) {
if ( $this->language->needsGenderDistinction() &&
$this->nsInfo->hasGenderDistinction( $namespace )
) {
// NOTE: we are assuming here that the title text is a user name!
$gender = $this->genderCache->getGenderOf( $text, __METHOD__ );
$name = $this->language->getGenderNsText( $namespace, $gender );
} else {
$name = $this->language->getNsText( $namespace );
}
if ( $name === false ) {
throw new InvalidArgumentException( 'Unknown namespace ID: ' . $namespace );
}
return $name;
}
}
/** @deprecated class alias since 1.41 */
class_alias( TitleFormatter::class, 'TitleFormatter' );
|
