3 * A service for generating links from page titles
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
22 * @author Daniel Kinzler
24 use MediaWiki\Linker\LinkTarget
;
27 * A service for generating links from page titles.
29 * @see https://www.mediawiki.org/wiki/Requests_for_comment/TitleValue
32 class MediaWikiPageLinkRenderer
implements PageLinkRenderer
{
44 * @note $formatter and $baseUrl are currently not used for generating links,
45 * since we still rely on the Linker class to generate the actual HTML.
46 * Once this is reversed so that Linker becomes a legacy interface to
47 * HtmlPageLinkRenderer, we will be using them, so it seems prudent to
48 * already declare the dependency and inject them.
50 * @param TitleFormatter $formatter Formatter for generating the target title string
51 * @param string $baseUrl (currently unused, pending refactoring of Linker).
52 * Defaults to $wgArticlePath.
54 public function __construct( TitleFormatter
$formatter, $baseUrl = null ) {
55 if ( $baseUrl === null ) {
56 $baseUrl = $GLOBALS['wgArticlePath'];
59 $this->formatter
= $formatter;
60 $this->baseUrl
= $baseUrl;
64 * Returns the (partial) URL for the given page (including any section identifier).
66 * @param LinkTarget $page The link's target
67 * @param array $params Any additional URL parameters.
71 public function getPageUrl( LinkTarget
$page, $params = [] ) {
72 // TODO: move the code from Linker::linkUrl here!
73 // The below is just a rough estimation!
75 $name = $this->formatter
->getPrefixedText( $page );
76 $name = str_replace( ' ', '_', $name );
77 $name = wfUrlencode( $name );
79 $url = $this->baseUrl
. $name;
82 $separator = ( strpos( $url, '?' ) ) ?
'&' : '?';
83 $url .= $separator . wfArrayToCgi( $params );
86 $fragment = $page->getFragment();
87 if ( $fragment !== '' ) {
88 $url = $url . '#' . wfUrlencode( $fragment );
95 * Returns an HTML link to the given page, using the given surface text.
97 * @param LinkTarget $linkTarget The link's target
98 * @param string $text The link's surface text (will be derived from $page if not given).
102 public function renderHtmlLink( LinkTarget
$linkTarget, $text = null ) {
103 if ( $text === null ) {
104 $text = $this->formatter
->getFullText( $linkTarget );
107 // TODO: move the logic implemented by Linker here,
108 // using $this->formatter and $this->baseUrl, and
109 // re-implement Linker to use a HtmlPageLinkRenderer.
111 $title = Title
::newFromLinkTarget( $linkTarget );
112 $link = Linker
::link( $title, htmlspecialchars( $text ) );
118 * Returns a wikitext link to the given page, using the given surface text.
120 * @param LinkTarget $page The link's target
121 * @param string $text The link's surface text (will be derived from $page if not given).
125 public function renderWikitextLink( LinkTarget
$page, $text = null ) {
126 if ( $text === null ) {
127 $text = $this->formatter
->getFullText( $page );
130 $name = $this->formatter
->getFullText( $page );
132 return '[[:' . $name . '|' . wfEscapeWikiText( $text ) . ']]';