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
|
<?php
/**
* Represents a link rendering 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
* @license GPL 2+
* @author Daniel Kinzler
*/
use MediaWiki\Linker\LinkTarget;
/**
* Represents a link rendering service for %MediaWiki.
*
* This is designed to encapsulate the knowledge about how page titles map to
* URLs, and how links are encoded in a given output format.
*
* @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
* @since 1.23
*/
interface PageLinkRenderer {
/**
* Returns the URL for the given page.
*
* @todo expand this to cover the functionality of Linker::linkUrl
*
* @param LinkTarget $page The link's target
* @param array $params Any additional URL parameters.
*
* @return string
*/
public function getPageUrl( LinkTarget $page, $params = [] );
/**
* Returns an HTML link to the given page, using the given surface text.
*
* @todo expand this to cover the functionality of Linker::link
*
* @param LinkTarget $page The link's target
* @param string $text The link's surface text (will be derived from $page if not given).
*
* @return string
*/
public function renderHtmlLink( LinkTarget $page, $text = null );
/**
* Returns a wikitext link to the given page, using the given surface text.
*
* @param LinkTarget $page The link's target
* @param string $text The link's surface text (will be derived from $page if not given).
*
* @return string
*/
public function renderWikitextLink( LinkTarget $page, $text = null );
}
|
