3 * Representation of a page title within MediaWiki.
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.
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.
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
21 * @author Daniel Kinzler
23 use MediaWiki\Linker\LinkTarget
;
24 use Wikimedia\Assert\Assert
;
25 use Wikimedia\Assert\ParameterTypeException
;
28 * Represents a page (or page fragment) title within MediaWiki.
30 * @note In contrast to Title, this is designed to be a plain value object. That is,
31 * it is immutable, does not use global state, and causes no side effects.
33 * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
36 class TitleValue
implements LinkTarget
{
39 * @deprecated in 1.31. This class is immutable. Use the getter for access.
45 * @deprecated in 1.31. This class is immutable. Use the getter for access.
51 * @deprecated in 1.31. This class is immutable. Use the getter for access.
57 * @deprecated in 1.31. This class is immutable. Use the getter for access.
63 * Text form including namespace/interwiki, initialised on demand
65 * Only public to share cache with TitleFormatter
70 public $prefixedText = null;
73 * Constructs a TitleValue.
75 * @note TitleValue expects a valid namespace and name; typically, a TitleValue is constructed
76 * either from a database entry, or by a TitleParser. For constructing a TitleValue from user
77 * input or external sources, use a TitleParser.
79 * @param int $namespace The namespace ID. This is not validated.
80 * @param string $title The page title in either DBkey or text form. No normalization is applied
81 * beyond underscore/space conversion.
82 * @param string $fragment The fragment title. Use '' to represent the whole page.
83 * No validation or normalization is applied.
84 * @param string $interwiki The interwiki component
86 * @throws InvalidArgumentException
88 public function __construct( $namespace, $title, $fragment = '', $interwiki = '' ) {
89 if ( !is_int( $namespace ) ) {
90 throw new ParameterTypeException( '$namespace', 'int' );
92 if ( !is_string( $title ) ) {
93 throw new ParameterTypeException( '$title', 'string' );
95 if ( !is_string( $fragment ) ) {
96 throw new ParameterTypeException( '$fragment', 'string' );
98 if ( !is_string( $interwiki ) ) {
99 throw new ParameterTypeException( '$interwiki', 'string' );
102 // Sanity check, no full validation or normalization applied here!
103 Assert
::parameter( !preg_match( '/^[_ ]|[\r\n\t]|[_ ]$/', $title ), '$title',
104 "invalid name '$title'" );
107 ( $namespace === NS_MAIN
&& ( $fragment !== '' ||
$interwiki !== '' ) ),
109 'should not be empty unless namespace is main and fragment or interwiki is non-empty'
112 $this->namespace = $namespace;
113 $this->dbkey
= strtr( $title, ' ', '_' );
114 $this->fragment
= $fragment;
115 $this->interwiki
= $interwiki;
122 public function getNamespace() {
123 return $this->namespace;
131 public function inNamespace( $ns ) {
132 return $this->namespace == $ns;
139 public function getFragment() {
140 return $this->fragment
;
147 public function hasFragment() {
148 return $this->fragment
!== '';
152 * Returns the title's DB key, as supplied to the constructor,
153 * without namespace prefix or fragment.
158 public function getDBkey() {
163 * Returns the title in text form,
164 * without namespace prefix or fragment.
167 * This is computed from the DB key by replacing any underscores with spaces.
169 * @note To get a title string that includes the namespace and/or fragment,
170 * use a TitleFormatter.
174 public function getText() {
175 return str_replace( '_', ' ', $this->dbkey
);
179 * Creates a new TitleValue for a different fragment of the same page.
182 * @param string $fragment The fragment name, or "" for the entire page.
186 public function createFragmentTarget( $fragment ) {
187 return new TitleValue(
196 * Whether it has an interwiki part
201 public function isExternal() {
202 return $this->interwiki
!== '';
206 * Returns the interwiki part
211 public function getInterwiki() {
212 return $this->interwiki
;
216 * Returns a string representation of the title, for logging. This is purely informative
217 * and must not be used programmatically. Use the appropriate TitleFormatter to generate
218 * the correct string representation for a given use.
223 public function __toString() {
224 $name = $this->namespace . ':' . $this->dbkey
;
226 if ( $this->fragment
!== '' ) {
227 $name .= '#' . $this->fragment
;
230 if ( $this->interwiki
!== '' ) {
231 $name = $this->interwiki
. ':' . $name;