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
|
<?php
/**
* 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 Addshore
*/
namespace MediaWiki\Linker;
/**
* Represents the target of a wiki link.
*
* @see https://www.mediawiki.org/wiki/Manual:Modeling_pages
*
* @since 1.27
*/
interface LinkTarget {
/**
* Get the namespace index.
*
* @since 1.27
* @return int Namespace index
*/
public function getNamespace(): int;
/**
* Convenience function to check if the target is in a given namespace.
*
* @since 1.27
* @param int $ns
* @return bool
*/
public function inNamespace( int $ns ): bool;
/**
* Get the link fragment in text form (i.e. the bit after the hash `#`).
*
* @since 1.27
* @return string link fragment
*/
public function getFragment(): string;
/**
* Whether the link target has a fragment.
*
* @since 1.27
* @return bool
*/
public function hasFragment(): bool;
/**
* Get the main part of the link target, in canonical database form.
*
* The main part is the link target without namespace prefix or hash fragment.
* The database form means that spaces become underscores, this is also
* used for URLs.
*
* @since 1.27
* @return string
*/
public function getDBkey(): string;
/**
* Get the main part of the link target, in text form.
*
* The main part is the link target without namespace prefix or hash fragment.
* The text form is used for display purposes.
*
* 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.
*
* @since 1.27
* @return string
*/
public function getText(): string;
/**
* Create a new LinkTarget with a different fragment on the same page.
*
* It is expected that the same type of object will be returned, but the
* only requirement is that it is a LinkTarget.
*
* @since 1.27
* @param string $fragment The fragment override, or "" to remove it.
* @return LinkTarget
*/
public function createFragmentTarget( string $fragment );
/**
* Whether this LinkTarget has an interwiki component.
*
* @since 1.27
* @return bool
*/
public function isExternal(): bool;
/**
* The interwiki component of this LinkTarget.
*
* @since 1.27
* @return string
*/
public function getInterwiki(): string;
/**
* Check whether the given LinkTarget refers to the same target as this LinkTarget.
*
* Two link targets are considered the same if they have the same interwiki prefix,
* are in the same namespace, have the same main part, and the same fragment.
*
* @since 1.36
* @param LinkTarget $other
* @return bool
*/
public function isSameLinkAs( LinkTarget $other ): bool;
/**
* Return an informative human-readable representation of the link target,
* for use in logging and debugging.
*
* @return string
*/
public function __toString(): string;
}
|
