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
|
<?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;
/**
* @since 1.27
*/
interface LinkTarget {
/**
* Get the namespace index.
* @since 1.27
*
* @return int Namespace index
*/
public function getNamespace();
/**
* Convenience function to test if it is in the namespace
* @since 1.27
*
* @param int $ns
* @return bool
*/
public function inNamespace( $ns );
/**
* Get the link fragment (i.e. the bit after the #) in text form.
* @since 1.27
*
* @return string link fragment
*/
public function getFragment();
/**
* Whether the link target has a fragment
* @since 1.27
*
* @return bool
*/
public function hasFragment();
/**
* Get the main part with underscores.
* @since 1.27
*
* @return string Main part of the link, with underscores (for use in href attributes)
*/
public function getDBkey();
/**
* Returns the link in text form, without namespace prefix or fragment.
* This is computed from the DB key by replacing any underscores with spaces.
* @since 1.27
*
* @return string
*/
public function getText();
/**
* Creates a new LinkTarget for a different fragment of 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 name, or "" for the entire page.
*
* @return LinkTarget
*/
public function createFragmentTarget( $fragment );
/**
* Whether this LinkTarget has an interwiki component
* @since 1.27
*
* @return bool
*/
public function isExternal();
/**
* The interwiki component of this LinkTarget
* @since 1.27
*
* @return string
*/
public function getInterwiki();
/**
* Checks 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,
* the same namespace ID, the same text, and the same fragment.
*
* @since 1.36
*
* @param LinkTarget $other
* @return bool
*/
public function isSameLinkAs( LinkTarget $other );
/**
* Returns an informative human readable representation of the page identity,
* for use in logging and debugging.
*
* @return string
*/
public function __toString(): string;
}
|
