3 * Methods to make links and related items.
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
24 * Some internal bits split of from Skin.php. These functions are used
25 * for primarily page content: links, embedded images, table of contents. Links
26 * are also used in the skin.
28 * @todo turn this into a legacy interface for HtmlPageLinkRenderer and similar services.
34 * Flags for userToolLinks()
36 const TOOL_LINKS_NOBLOCK
= 1;
37 const TOOL_LINKS_EMAIL
= 2;
40 * Get the appropriate HTML attributes to add to the "a" element of an interwiki link.
42 * @deprecated since 1.25
44 * @param string $title The title text for the link, URL-encoded (???) but
46 * @param string $unused Unused
47 * @param string $class The contents of the class attribute; if an empty
48 * string is passed, which is the default value, defaults to 'external'.
51 static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
54 wfDeprecated( __METHOD__
, '1.25' );
56 # @todo FIXME: We have a whole bunch of handling here that doesn't happen in
57 # getExternalLinkAttributes, why?
58 $title = urldecode( $title );
59 $title = $wgContLang->checkTitleEncoding( $title );
60 $title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );
62 return self
::getLinkAttributesInternal( $title, $class );
66 * Get the appropriate HTML attributes to add to the "a" element of an internal link.
68 * @deprecated since 1.25
70 * @param string $title The title text for the link, URL-encoded (???) but
72 * @param string $unused Unused
73 * @param string $class The contents of the class attribute, default none
76 static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
77 wfDeprecated( __METHOD__
, '1.25' );
79 $title = urldecode( $title );
80 $title = strtr( $title, '_', ' ' );
81 return self
::getLinkAttributesInternal( $title, $class );
85 * Get the appropriate HTML attributes to add to the "a" element of an internal
86 * link, given the Title object for the page we want to link to.
88 * @deprecated since 1.25
91 * @param string $unused Unused
92 * @param string $class The contents of the class attribute, default none
93 * @param string|bool $title Optional (unescaped) string to use in the title
94 * attribute; if false, default to the name of the page we're linking to
97 static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
98 wfDeprecated( __METHOD__
, '1.25' );
100 if ( $title === false ) {
101 $title = $nt->getPrefixedText();
103 return self
::getLinkAttributesInternal( $title, $class );
107 * Common code for getLinkAttributesX functions
109 * @deprecated since 1.25
111 * @param string $title
112 * @param string $class
116 private static function getLinkAttributesInternal( $title, $class ) {
117 wfDeprecated( __METHOD__
, '1.25' );
119 $title = htmlspecialchars( $title );
120 $class = htmlspecialchars( $class );
122 if ( $class != '' ) {
123 $r .= " class=\"$class\"";
125 if ( $title != '' ) {
126 $r .= " title=\"$title\"";
132 * Return the CSS colour of a known link
135 * @param int $threshold User defined threshold
136 * @return string CSS class
138 public static function getLinkColour( $t, $threshold ) {
140 if ( $t->isRedirect() ) {
142 $colour = 'mw-redirect';
143 } elseif ( $threshold > 0 && $t->isContentPage() &&
144 $t->exists() && $t->getLength() < $threshold
153 * This function returns an HTML link to the given target. It serves a few
155 * 1) If $target is a Title, the correct URL to link to will be figured
157 * 2) It automatically adds the usual classes for various types of link
158 * targets: "new" for red links, "stub" for short articles, etc.
159 * 3) It escapes all attribute values safely so there's no risk of XSS.
160 * 4) It provides a default tooltip if the target is a Title (the page
161 * name of the target).
162 * link() replaces the old functions in the makeLink() family.
164 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
166 * @param Title $target Can currently only be a Title, but this may
167 * change to support Images, literal URLs, etc.
168 * @param string $html The HTML contents of the <a> element, i.e.,
169 * the link text. This is raw HTML and will not be escaped. If null,
170 * defaults to the prefixed text of the Title; or if the Title is just a
171 * fragment, the contents of the fragment.
172 * @param array $customAttribs A key => value array of extra HTML attributes,
173 * such as title and class. (href is ignored.) Classes will be
174 * merged with the default classes, while other attributes will replace
175 * default attributes. All passed attribute values will be HTML-escaped.
176 * A false attribute value means to suppress that attribute.
177 * @param array $query The query string to append to the URL
178 * you're linking to, in key => value array form. Query keys and values
179 * will be URL-encoded.
180 * @param string|array $options String or array of strings:
181 * 'known': Page is known to exist, so don't check if it does.
182 * 'broken': Page is known not to exist, so don't check if it does.
183 * 'noclasses': Don't add any classes automatically (includes "new",
184 * "stub", "mw-redirect", "extiw"). Only use the class attribute
185 * provided, if any, so you get a simple blue link with no funny i-
187 * 'forcearticlepath': Use the article path always, even with a querystring.
188 * Has compatibility issues on some setups, so avoid wherever possible.
189 * 'http': Force a full URL with http:// as the scheme.
190 * 'https': Force a full URL with https:// as the scheme.
191 * @return string HTML <a> attribute
193 public static function link(
194 $target, $html = null, $customAttribs = array(), $query = array(), $options = array()
196 if ( !$target instanceof Title
) {
197 wfWarn( __METHOD__
. ': Requires $target to be a Title object.', 2 );
198 return "<!-- ERROR -->$html";
201 if ( is_string( $query ) ) {
202 // some functions withing core using this still hand over query strings
203 wfDeprecated( __METHOD__
. ' with parameter $query as string (should be array)', '1.20' );
204 $query = wfCgiToArray( $query );
206 $options = (array)$options;
208 $dummy = new DummyLinker
; // dummy linker instance for bc on the hooks
211 if ( !Hooks
::run( 'LinkBegin',
212 array( $dummy, $target, &$html, &$customAttribs, &$query, &$options, &$ret ) )
217 # Normalize the Title if it's a special page
218 $target = self
::normaliseSpecialPage( $target );
220 # If we don't know whether the page exists, let's find out.
221 if ( !in_array( 'known', $options ) && !in_array( 'broken', $options ) ) {
222 if ( $target->isKnown() ) {
223 $options[] = 'known';
225 $options[] = 'broken';
230 if ( in_array( "forcearticlepath", $options ) && $query ) {
235 # Note: we want the href attribute first, for prettiness.
236 $attribs = array( 'href' => self
::linkUrl( $target, $query, $options ) );
237 if ( in_array( 'forcearticlepath', $options ) && $oldquery ) {
238 $attribs['href'] = wfAppendQuery( $attribs['href'], $oldquery );
241 $attribs = array_merge(
243 self
::linkAttribs( $target, $customAttribs, $options )
245 if ( is_null( $html ) ) {
246 $html = self
::linkText( $target );
250 if ( Hooks
::run( 'LinkEnd', array( $dummy, $target, $options, &$html, &$attribs, &$ret ) ) ) {
251 $ret = Html
::rawElement( 'a', $attribs, $html );
258 * Identical to link(), except $options defaults to 'known'.
262 public static function linkKnown(
263 $target, $html = null, $customAttribs = array(),
264 $query = array(), $options = array( 'known', 'noclasses' )
266 return self
::link( $target, $html, $customAttribs, $query, $options );
270 * Returns the Url used to link to a Title
272 * @param Title $target
273 * @param array $query Query parameters
274 * @param array $options
277 private static function linkUrl( $target, $query, $options ) {
278 # We don't want to include fragments for broken links, because they
279 # generally make no sense.
280 if ( in_array( 'broken', $options ) && $target->hasFragment() ) {
281 $target = clone $target;
282 $target->setFragment( '' );
285 # If it's a broken link, add the appropriate query pieces, unless
286 # there's already an action specified, or unless 'edit' makes no sense
287 # (i.e., for a nonexistent special page).
288 if ( in_array( 'broken', $options ) && empty( $query['action'] )
289 && !$target->isSpecialPage() ) {
290 $query['action'] = 'edit';
291 $query['redlink'] = '1';
294 if ( in_array( 'http', $options ) ) {
296 } elseif ( in_array( 'https', $options ) ) {
297 $proto = PROTO_HTTPS
;
299 $proto = PROTO_RELATIVE
;
302 $ret = $target->getLinkURL( $query, false, $proto );
307 * Returns the array of attributes used when linking to the Title $target
309 * @param Title $target
310 * @param array $attribs
311 * @param array $options
315 private static function linkAttribs( $target, $attribs, $options ) {
319 if ( !in_array( 'noclasses', $options ) ) {
320 # Now build the classes.
323 if ( in_array( 'broken', $options ) ) {
327 if ( $target->isExternal() ) {
328 $classes[] = 'extiw';
331 if ( !in_array( 'broken', $options ) ) { # Avoid useless calls to LinkCache (see r50387)
332 $colour = self
::getLinkColour( $target, $wgUser->getStubThreshold() );
333 if ( $colour !== '' ) {
334 $classes[] = $colour; # mw-redirect or stub
337 if ( $classes != array() ) {
338 $defaults['class'] = implode( ' ', $classes );
342 # Get a default title attribute.
343 if ( $target->getPrefixedText() == '' ) {
344 # A link like [[#Foo]]. This used to mean an empty title
345 # attribute, but that's silly. Just don't output a title.
346 } elseif ( in_array( 'known', $options ) ) {
347 $defaults['title'] = $target->getPrefixedText();
349 $defaults['title'] = wfMessage( 'red-link-title', $target->getPrefixedText() )->text();
352 # Finally, merge the custom attribs with the default ones, and iterate
353 # over that, deleting all "false" attributes.
355 $merged = Sanitizer
::mergeAttributes( $defaults, $attribs );
356 foreach ( $merged as $key => $val ) {
357 # A false value suppresses the attribute, and we don't want the
358 # href attribute to be overridden.
359 if ( $key != 'href' && $val !== false ) {
367 * Default text of the links to the Title $target
369 * @param Title $target
373 private static function linkText( $target ) {
374 if ( !$target instanceof Title
) {
375 wfWarn( __METHOD__
. ': Requires $target to be a Title object.' );
378 // If the target is just a fragment, with no title, we return the fragment
379 // text. Otherwise, we return the title text itself.
380 if ( $target->getPrefixedText() === '' && $target->hasFragment() ) {
381 return htmlspecialchars( $target->getFragment() );
384 return htmlspecialchars( $target->getPrefixedText() );
388 * Make appropriate markup for a link to the current article. This is
389 * currently rendered as the bold link text. The calling sequence is the
390 * same as the other make*LinkObj static functions, despite $query not
394 * @param string $html [optional]
395 * @param string $query [optional]
396 * @param string $trail [optional]
397 * @param string $prefix [optional]
401 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
402 $ret = "<strong class=\"selflink\">{$prefix}{$html}</strong>{$trail}";
403 if ( !Hooks
::run( 'SelfLinkBegin', array( $nt, &$html, &$trail, &$prefix, &$ret ) ) ) {
408 $html = htmlspecialchars( $nt->getPrefixedText() );
410 list( $inside, $trail ) = self
::splitTrail( $trail );
411 return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
415 * Get a message saying that an invalid title was encountered.
416 * This should be called after a method like Title::makeTitleSafe() returned
417 * a value indicating that the title object is invalid.
419 * @param IContextSource $context Context to use to get the messages
420 * @param int $namespace Namespace number
421 * @param string $title Text of the title, without the namespace part
424 public static function getInvalidTitleDescription( IContextSource
$context, $namespace, $title ) {
427 // First we check whether the namespace exists or not.
428 if ( MWNamespace
::exists( $namespace ) ) {
429 if ( $namespace == NS_MAIN
) {
430 $name = $context->msg( 'blanknamespace' )->text();
432 $name = $wgContLang->getFormattedNsText( $namespace );
434 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
436 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
441 * @param Title $title
444 static function normaliseSpecialPage( Title
$title ) {
445 if ( $title->isSpecialPage() ) {
446 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
450 $ret = SpecialPage
::getTitleFor( $name, $subpage, $title->getFragment() );
458 * Returns the filename part of an url.
459 * Used as alternative text for external images.
465 private static function fnamePart( $url ) {
466 $basename = strrchr( $url, '/' );
467 if ( false === $basename ) {
470 $basename = substr( $basename, 1 );
476 * Return the code for images which were added via external links,
477 * via Parser::maybeMakeExternalImage().
484 public static function makeExternalImage( $url, $alt = '' ) {
486 $alt = self
::fnamePart( $url );
489 $success = Hooks
::run( 'LinkerMakeExternalImage', array( &$url, &$alt, &$img ) );
491 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
492 . "with url {$url} and alt text {$alt} to {$img}\n", true );
495 return Html
::element( 'img',
502 * Given parameters derived from [[Image:Foo|options...]], generate the
503 * HTML that that syntax inserts in the page.
505 * @param Parser $parser
506 * @param Title $title Title object of the file (not the currently viewed page)
507 * @param File $file File object, or false if it doesn't exist
508 * @param array $frameParams Associative array of parameters external to the media handler.
509 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
510 * will often be false.
511 * thumbnail If present, downscale and frame
512 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
513 * framed Shows image in original size in a frame
514 * frameless Downscale but don't frame
515 * upright If present, tweak default sizes for portrait orientation
516 * upright_factor Fudge factor for "upright" tweak (default 0.75)
517 * border If present, show a border around the image
518 * align Horizontal alignment (left, right, center, none)
519 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
520 * bottom, text-bottom)
521 * alt Alternate text for image (i.e. alt attribute). Plain text.
522 * class HTML for image classes. Plain text.
523 * caption HTML for image caption.
524 * link-url URL to link to
525 * link-title Title object to link to
526 * link-target Value for the target attribute, only with link-url
527 * no-link Boolean, suppress description link
529 * @param array $handlerParams Associative array of media handler parameters, to be passed
530 * to transform(). Typical keys are "width" and "page".
531 * @param string|bool $time Timestamp of the file, set as false for current
532 * @param string $query Query params for desc url
533 * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
535 * @return string HTML for an image, with links, wrappers, etc.
537 public static function makeImageLink( Parser
$parser, Title
$title,
538 $file, $frameParams = array(), $handlerParams = array(), $time = false,
539 $query = "", $widthOption = null
542 $dummy = new DummyLinker
;
543 if ( !Hooks
::run( 'ImageBeforeProduceHTML', array( &$dummy, &$title,
544 &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
548 if ( $file && !$file->allowInlineDisplay() ) {
549 wfDebug( __METHOD__
. ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
550 return self
::link( $title );
555 $hp =& $handlerParams;
557 // Clean up parameters
558 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
559 if ( !isset( $fp['align'] ) ) {
562 if ( !isset( $fp['alt'] ) ) {
565 if ( !isset( $fp['title'] ) ) {
568 if ( !isset( $fp['class'] ) ) {
572 $prefix = $postfix = '';
574 if ( 'center' == $fp['align'] ) {
575 $prefix = '<div class="center">';
577 $fp['align'] = 'none';
579 if ( $file && !isset( $hp['width'] ) ) {
580 if ( isset( $hp['height'] ) && $file->isVectorized() ) {
581 // If its a vector image, and user only specifies height
582 // we don't want it to be limited by its "normal" width.
583 global $wgSVGMaxSize;
584 $hp['width'] = $wgSVGMaxSize;
586 $hp['width'] = $file->getWidth( $page );
589 if ( isset( $fp['thumbnail'] )
590 ||
isset( $fp['manualthumb'] )
591 ||
isset( $fp['framed'] )
592 ||
isset( $fp['frameless'] )
595 global $wgThumbLimits, $wgThumbUpright;
597 if ( $widthOption === null ||
!isset( $wgThumbLimits[$widthOption] ) ) {
598 $widthOption = User
::getDefaultOption( 'thumbsize' );
601 // Reduce width for upright images when parameter 'upright' is used
602 if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
603 $fp['upright'] = $wgThumbUpright;
606 // For caching health: If width scaled down due to upright
607 // parameter, round to full __0 pixel to avoid the creation of a
608 // lot of odd thumbs.
609 $prefWidth = isset( $fp['upright'] ) ?
610 round( $wgThumbLimits[$widthOption] * $fp['upright'], -1 ) :
611 $wgThumbLimits[$widthOption];
613 // Use width which is smaller: real image width or user preference width
614 // Unless image is scalable vector.
615 if ( !isset( $hp['height'] ) && ( $hp['width'] <= 0 ||
616 $prefWidth < $hp['width'] ||
$file->isVectorized() ) ) {
617 $hp['width'] = $prefWidth;
622 if ( isset( $fp['thumbnail'] ) ||
isset( $fp['manualthumb'] ) ||
isset( $fp['framed'] ) ) {
623 # Create a thumbnail. Alignment depends on the writing direction of
624 # the page content language (right-aligned for LTR languages,
625 # left-aligned for RTL languages)
627 # If a thumbnail width has not been provided, it is set
628 # to the default user option as specified in Language*.php
629 if ( $fp['align'] == '' ) {
630 $fp['align'] = $parser->getTargetLanguage()->alignEnd();
632 return $prefix . self
::makeThumbLink2( $title, $file, $fp, $hp, $time, $query ) . $postfix;
635 if ( $file && isset( $fp['frameless'] ) ) {
636 $srcWidth = $file->getWidth( $page );
637 # For "frameless" option: do not present an image bigger than the
638 # source (for bitmap-style images). This is the same behavior as the
639 # "thumb" option does it already.
640 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
641 $hp['width'] = $srcWidth;
645 if ( $file && isset( $hp['width'] ) ) {
646 # Create a resized image, without the additional thumbnail features
647 $thumb = $file->transform( $hp );
653 $s = self
::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
655 self
::processResponsiveImages( $file, $thumb, $hp );
658 'title' => $fp['title'],
659 'valign' => isset( $fp['valign'] ) ?
$fp['valign'] : false,
660 'img-class' => $fp['class'] );
661 if ( isset( $fp['border'] ) ) {
662 $params['img-class'] .= ( $params['img-class'] !== '' ?
' ' : '' ) . 'thumbborder';
664 $params = self
::getImageLinkMTOParams( $fp, $query, $parser ) +
$params;
666 $s = $thumb->toHtml( $params );
668 if ( $fp['align'] != '' ) {
669 $s = "<div class=\"float{$fp['align']}\">{$s}</div>";
671 return str_replace( "\n", ' ', $prefix . $s . $postfix );
675 * See makeImageLink()
676 * When this function is removed, remove if( $parser instanceof Parser ) check there too
677 * @deprecated since 1.20
679 public static function makeImageLink2( Title
$title, $file, $frameParams = array(),
680 $handlerParams = array(), $time = false, $query = "", $widthOption = null ) {
681 return self
::makeImageLink( null, $title, $file, $frameParams,
682 $handlerParams, $time, $query, $widthOption );
686 * Get the link parameters for MediaTransformOutput::toHtml() from given
687 * frame parameters supplied by the Parser.
688 * @param array $frameParams The frame parameters
689 * @param string $query An optional query string to add to description page links
690 * @param Parser|null $parser
693 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
694 $mtoParams = array();
695 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
696 $mtoParams['custom-url-link'] = $frameParams['link-url'];
697 if ( isset( $frameParams['link-target'] ) ) {
698 $mtoParams['custom-target-link'] = $frameParams['link-target'];
701 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
702 foreach ( $extLinkAttrs as $name => $val ) {
703 // Currently could include 'rel' and 'target'
704 $mtoParams['parser-extlink-' . $name] = $val;
707 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
708 $mtoParams['custom-title-link'] = self
::normaliseSpecialPage( $frameParams['link-title'] );
709 } elseif ( !empty( $frameParams['no-link'] ) ) {
712 $mtoParams['desc-link'] = true;
713 $mtoParams['desc-query'] = $query;
719 * Make HTML for a thumbnail including image, border and caption
720 * @param Title $title
721 * @param File|bool $file File object or false if it doesn't exist
722 * @param string $label
724 * @param string $align
725 * @param array $params
726 * @param bool $framed
727 * @param string $manualthumb
730 public static function makeThumbLinkObj( Title
$title, $file, $label = '', $alt,
731 $align = 'right', $params = array(), $framed = false, $manualthumb = ""
733 $frameParams = array(
739 $frameParams['framed'] = true;
741 if ( $manualthumb ) {
742 $frameParams['manualthumb'] = $manualthumb;
744 return self
::makeThumbLink2( $title, $file, $frameParams, $params );
748 * @param Title $title
750 * @param array $frameParams
751 * @param array $handlerParams
753 * @param string $query
756 public static function makeThumbLink2( Title
$title, $file, $frameParams = array(),
757 $handlerParams = array(), $time = false, $query = ""
759 $exists = $file && $file->exists();
763 $hp =& $handlerParams;
765 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
766 if ( !isset( $fp['align'] ) ) {
767 $fp['align'] = 'right';
769 if ( !isset( $fp['alt'] ) ) {
772 if ( !isset( $fp['title'] ) ) {
775 if ( !isset( $fp['caption'] ) ) {
779 if ( empty( $hp['width'] ) ) {
780 // Reduce width for upright images when parameter 'upright' is used
781 $hp['width'] = isset( $fp['upright'] ) ?
130 : 180;
785 $manualthumb = false;
788 $outerWidth = $hp['width'] +
2;
790 if ( isset( $fp['manualthumb'] ) ) {
791 # Use manually specified thumbnail
792 $manual_title = Title
::makeTitleSafe( NS_FILE
, $fp['manualthumb'] );
793 if ( $manual_title ) {
794 $manual_img = wfFindFile( $manual_title );
796 $thumb = $manual_img->getUnscaledThumb( $hp );
802 } elseif ( isset( $fp['framed'] ) ) {
803 // Use image dimensions, don't scale
804 $thumb = $file->getUnscaledThumb( $hp );
807 # Do not present an image bigger than the source, for bitmap-style images
808 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
809 $srcWidth = $file->getWidth( $page );
810 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
811 $hp['width'] = $srcWidth;
813 $thumb = $file->transform( $hp );
817 $outerWidth = $thumb->getWidth() +
2;
819 $outerWidth = $hp['width'] +
2;
823 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
824 # So we don't need to pass it here in $query. However, the URL for the
825 # zoom icon still needs it, so we make a unique query for it. See bug 14771
826 $url = $title->getLocalURL( $query );
828 $url = wfAppendQuery( $url, array( 'page' => $page ) );
831 && !isset( $fp['link-title'] )
832 && !isset( $fp['link-url'] )
833 && !isset( $fp['no-link'] ) ) {
834 $fp['link-url'] = $url;
837 $s = "<div class=\"thumb t{$fp['align']}\">"
838 . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
841 $s .= self
::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
843 } elseif ( !$thumb ) {
844 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
847 if ( !$noscale && !$manualthumb ) {
848 self
::processResponsiveImages( $file, $thumb, $hp );
852 'title' => $fp['title'],
853 'img-class' => ( isset( $fp['class'] ) && $fp['class'] !== ''
855 : '' ) . 'thumbimage'
857 $params = self
::getImageLinkMTOParams( $fp, $query ) +
$params;
858 $s .= $thumb->toHtml( $params );
859 if ( isset( $fp['framed'] ) ) {
862 $zoomIcon = Html
::rawElement( 'div', array( 'class' => 'magnify' ),
863 Html
::rawElement( 'a', array(
865 'class' => 'internal',
866 'title' => wfMessage( 'thumbnail-more' )->text() ),
870 $s .= ' <div class="thumbcaption">' . $zoomIcon . $fp['caption'] . "</div></div></div>";
871 return str_replace( "\n", ' ', $s );
875 * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
879 * @param MediaTransformOutput $thumb
880 * @param array $hp Image parameters
882 public static function processResponsiveImages( $file, $thumb, $hp ) {
883 global $wgResponsiveImages;
884 if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
886 $hp15['width'] = round( $hp['width'] * 1.5 );
888 $hp20['width'] = $hp['width'] * 2;
889 if ( isset( $hp['height'] ) ) {
890 $hp15['height'] = round( $hp['height'] * 1.5 );
891 $hp20['height'] = $hp['height'] * 2;
894 $thumb15 = $file->transform( $hp15 );
895 $thumb20 = $file->transform( $hp20 );
896 if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
897 $thumb->responsiveUrls
['1.5'] = $thumb15->getUrl();
899 if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
900 $thumb->responsiveUrls
['2'] = $thumb20->getUrl();
906 * Make a "broken" link to an image
908 * @param Title $title
909 * @param string $label Link label (plain text)
910 * @param string $query Query string
911 * @param string $unused1 Unused parameter kept for b/c
912 * @param string $unused2 Unused parameter kept for b/c
913 * @param bool $time A file of a certain timestamp was requested
916 public static function makeBrokenImageLinkObj( $title, $label = '',
917 $query = '', $unused1 = '', $unused2 = '', $time = false
919 if ( !$title instanceof Title
) {
920 wfWarn( __METHOD__
. ': Requires $title to be a Title object.' );
921 return "<!-- ERROR -->" . htmlspecialchars( $label );
924 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
925 if ( $label == '' ) {
926 $label = $title->getPrefixedText();
928 $encLabel = htmlspecialchars( $label );
929 $currentExists = $time ?
( wfFindFile( $title ) != false ) : false;
931 if ( ( $wgUploadMissingFileUrl ||
$wgUploadNavigationUrl ||
$wgEnableUploads )
934 $redir = RepoGroup
::singleton()->getLocalRepo()->checkRedirect( $title );
937 return self
::linkKnown( $title, $encLabel, array(), wfCgiToArray( $query ) );
940 $href = self
::getUploadUrl( $title, $query );
942 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
943 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES
) . '">' .
947 return self
::linkKnown( $title, $encLabel, array(), wfCgiToArray( $query ) );
951 * Get the URL to upload a certain file
953 * @param Title $destFile Title object of the file to upload
954 * @param string $query Urlencoded query string to prepend
955 * @return string Urlencoded URL
957 protected static function getUploadUrl( $destFile, $query = '' ) {
958 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
959 $q = 'wpDestFile=' . $destFile->getPartialURL();
960 if ( $query != '' ) {
964 if ( $wgUploadMissingFileUrl ) {
965 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
966 } elseif ( $wgUploadNavigationUrl ) {
967 return wfAppendQuery( $wgUploadNavigationUrl, $q );
969 $upload = SpecialPage
::getTitleFor( 'Upload' );
970 return $upload->getLocalURL( $q );
975 * Create a direct link to a given uploaded file.
977 * @param Title $title
978 * @param string $html Pre-sanitized HTML
979 * @param string $time MW timestamp of file creation time
980 * @return string HTML
982 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
983 $img = wfFindFile( $title, array( 'time' => $time ) );
984 return self
::makeMediaLinkFile( $title, $img, $html );
988 * Create a direct link to a given uploaded file.
989 * This will make a broken link if $file is false.
991 * @param Title $title
992 * @param File|bool $file File object or false
993 * @param string $html Pre-sanitized HTML
994 * @return string HTML
996 * @todo Handle invalid or missing images better.
998 public static function makeMediaLinkFile( Title
$title, $file, $html = '' ) {
999 if ( $file && $file->exists() ) {
1000 $url = $file->getURL();
1001 $class = 'internal';
1003 $url = self
::getUploadUrl( $title );
1007 $alt = $title->getText();
1008 if ( $html == '' ) {
1019 if ( !Hooks
::run( 'LinkerMakeMediaLinkFile',
1020 array( $title, $file, &$html, &$attribs, &$ret ) ) ) {
1021 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
1022 . "with url {$url} and text {$html} to {$ret}\n", true );
1026 return Html
::rawElement( 'a', $attribs, $html );
1030 * Make a link to a special page given its name and, optionally,
1031 * a message key from the link text.
1032 * Usage example: Linker::specialLink( 'Recentchanges' )
1034 * @param string $name
1035 * @param string $key
1038 public static function specialLink( $name, $key = '' ) {
1040 $key = strtolower( $name );
1043 return self
::linkKnown( SpecialPage
::getTitleFor( $name ), wfMessage( $key )->text() );
1047 * Make an external link
1048 * @param string $url URL to link to
1049 * @param string $text Text of link
1050 * @param bool $escape Do we escape the link text?
1051 * @param string $linktype Type of external link. Gets added to the classes
1052 * @param array $attribs Array of extra attributes to <a>
1053 * @param Title|null $title Title object used for title specific link attributes
1056 public static function makeExternalLink( $url, $text, $escape = true,
1057 $linktype = '', $attribs = array(), $title = null
1060 $class = "external";
1062 $class .= " $linktype";
1064 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
1065 $class .= " {$attribs['class']}";
1067 $attribs['class'] = $class;
1070 $text = htmlspecialchars( $text );
1076 $attribs['rel'] = Parser
::getExternalLinkRel( $url, $title );
1078 $success = Hooks
::run( 'LinkerMakeExternalLink',
1079 array( &$url, &$text, &$link, &$attribs, $linktype ) );
1081 wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
1082 . "with url {$url} and text {$text} to {$link}\n", true );
1085 $attribs['href'] = $url;
1086 return Html
::rawElement( 'a', $attribs, $text );
1090 * Make user link (or user contributions for unregistered users)
1091 * @param int $userId User id in database.
1092 * @param string $userName User name in database.
1093 * @param string $altUserName Text to display instead of the user name (optional)
1094 * @return string HTML fragment
1095 * @since 1.19 Method exists for a long time. $altUserName was added in 1.19.
1097 public static function userLink( $userId, $userName, $altUserName = false ) {
1098 $classes = 'mw-userlink';
1099 if ( $userId == 0 ) {
1100 $page = SpecialPage
::getTitleFor( 'Contributions', $userName );
1101 if ( $altUserName === false ) {
1102 $altUserName = IP
::prettifyIP( $userName );
1104 $classes .= ' mw-anonuserlink'; // Separate link class for anons (bug 43179)
1106 $page = Title
::makeTitle( NS_USER
, $userName );
1111 htmlspecialchars( $altUserName !== false ?
$altUserName : $userName ),
1112 array( 'class' => $classes )
1117 * Generate standard user tool links (talk, contributions, block link, etc.)
1119 * @param int $userId User identifier
1120 * @param string $userText User name or IP address
1121 * @param bool $redContribsWhenNoEdits Should the contributions link be
1122 * red if the user has no edits?
1123 * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK
1124 * and Linker::TOOL_LINKS_EMAIL).
1125 * @param int $edits User edit count (optional, for performance)
1126 * @return string HTML fragment
1128 public static function userToolLinks(
1129 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
1131 global $wgUser, $wgDisableAnonTalk, $wgLang;
1132 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
1133 $blockable = !( $flags & self
::TOOL_LINKS_NOBLOCK
);
1134 $addEmailLink = $flags & self
::TOOL_LINKS_EMAIL
&& $userId;
1138 $items[] = self
::userTalkLink( $userId, $userText );
1141 // check if the user has an edit
1143 if ( $redContribsWhenNoEdits ) {
1144 if ( intval( $edits ) === 0 && $edits !== 0 ) {
1145 $user = User
::newFromId( $userId );
1146 $edits = $user->getEditCount();
1148 if ( $edits === 0 ) {
1149 $attribs['class'] = 'new';
1152 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
1154 $items[] = self
::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
1156 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
1157 $items[] = self
::blockLink( $userId, $userText );
1160 if ( $addEmailLink && $wgUser->canSendEmail() ) {
1161 $items[] = self
::emailLink( $userId, $userText );
1164 Hooks
::run( 'UserToolLinksEdit', array( $userId, $userText, &$items ) );
1167 return wfMessage( 'word-separator' )->escaped()
1168 . '<span class="mw-usertoollinks">'
1169 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
1177 * Alias for userToolLinks( $userId, $userText, true );
1178 * @param int $userId User identifier
1179 * @param string $userText User name or IP address
1180 * @param int $edits User edit count (optional, for performance)
1183 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
1184 return self
::userToolLinks( $userId, $userText, true, 0, $edits );
1188 * @param int $userId User id in database.
1189 * @param string $userText User name in database.
1190 * @return string HTML fragment with user talk link
1192 public static function userTalkLink( $userId, $userText ) {
1193 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
1194 $userTalkLink = self
::link( $userTalkPage, wfMessage( 'talkpagelinktext' )->escaped() );
1195 return $userTalkLink;
1199 * @param int $userId Userid
1200 * @param string $userText User name in database.
1201 * @return string HTML fragment with block link
1203 public static function blockLink( $userId, $userText ) {
1204 $blockPage = SpecialPage
::getTitleFor( 'Block', $userText );
1205 $blockLink = self
::link( $blockPage, wfMessage( 'blocklink' )->escaped() );
1210 * @param int $userId Userid
1211 * @param string $userText User name in database.
1212 * @return string HTML fragment with e-mail user link
1214 public static function emailLink( $userId, $userText ) {
1215 $emailPage = SpecialPage
::getTitleFor( 'Emailuser', $userText );
1216 $emailLink = self
::link( $emailPage, wfMessage( 'emaillink' )->escaped() );
1221 * Generate a user link if the current user is allowed to view it
1222 * @param Revision $rev
1223 * @param bool $isPublic Show only if all users can see it
1224 * @return string HTML fragment
1226 public static function revUserLink( $rev, $isPublic = false ) {
1227 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1228 $link = wfMessage( 'rev-deleted-user' )->escaped();
1229 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1230 $link = self
::userLink( $rev->getUser( Revision
::FOR_THIS_USER
),
1231 $rev->getUserText( Revision
::FOR_THIS_USER
) );
1233 $link = wfMessage( 'rev-deleted-user' )->escaped();
1235 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1236 return '<span class="history-deleted">' . $link . '</span>';
1242 * Generate a user tool link cluster if the current user is allowed to view it
1243 * @param Revision $rev
1244 * @param bool $isPublic Show only if all users can see it
1245 * @return string HTML
1247 public static function revUserTools( $rev, $isPublic = false ) {
1248 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1249 $link = wfMessage( 'rev-deleted-user' )->escaped();
1250 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1251 $userId = $rev->getUser( Revision
::FOR_THIS_USER
);
1252 $userText = $rev->getUserText( Revision
::FOR_THIS_USER
);
1253 $link = self
::userLink( $userId, $userText )
1254 . self
::userToolLinks( $userId, $userText );
1256 $link = wfMessage( 'rev-deleted-user' )->escaped();
1258 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1259 return ' <span class="history-deleted">' . $link . '</span>';
1265 * This function is called by all recent changes variants, by the page history,
1266 * and by the user contributions list. It is responsible for formatting edit
1267 * summaries. It escapes any HTML in the summary, but adds some CSS to format
1268 * auto-generated comments (from section editing) and formats [[wikilinks]].
1270 * @author Erik Moeller <moeller@scireview.de>
1272 * Note: there's not always a title to pass to this function.
1273 * Since you can't set a default parameter for a reference, I've turned it
1274 * temporarily to a value pass. Should be adjusted further. --brion
1276 * @param string $comment
1277 * @param Title|null $title Title object (to generate link to the section in autocomment)
1279 * @param bool $local Whether section links should refer to local page
1280 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1281 * For use with external changes.
1283 * @return mixed|string
1285 public static function formatComment(
1286 $comment, $title = null, $local = false, $wikiId = null
1288 # Sanitize text a bit:
1289 $comment = str_replace( "\n", " ", $comment );
1290 # Allow HTML entities (for bug 13815)
1291 $comment = Sanitizer
::escapeHtmlAllowEntities( $comment );
1293 # Render autocomments and make links:
1294 $comment = self
::formatAutocomments( $comment, $title, $local, $wikiId );
1295 $comment = self
::formatLinksInComment( $comment, $title, $local, $wikiId );
1301 * Converts autogenerated comments in edit summaries into section links.
1303 * The pattern for autogen comments is / * foo * /, which makes for
1305 * We look for all comments, match any text before and after the comment,
1306 * add a separator where needed and format the comment itself with CSS
1307 * Called by Linker::formatComment.
1309 * @param string $comment Comment text
1310 * @param Title|null $title An optional title object used to links to sections
1311 * @param bool $local Whether section links should refer to local page
1312 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1313 * as used by WikiMap.
1315 * @return string Formatted comment (wikitext)
1317 private static function formatAutocomments(
1318 $comment, $title = null, $local = false, $wikiId = null
1320 // @todo $append here is something of a hack to preserve the status
1321 // quo. Someone who knows more about bidi and such should decide
1322 // (1) what sane rendering even *is* for an LTR edit summary on an RTL
1323 // wiki, both when autocomments exist and when they don't, and
1324 // (2) what markup will make that actually happen.
1326 $comment = preg_replace_callback(
1327 // To detect the presence of content before or after the
1328 // auto-comment, we use capturing groups inside optional zero-width
1329 // assertions. But older versions of PCRE can't directly make
1330 // zero-width assertions optional, so wrap them in a non-capturing
1332 '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
1333 function ( $match ) use ( $title, $local, $wikiId, &$append ) {
1336 // Ensure all match positions are defined
1337 $match +
= array( '', '', '', '' );
1339 $pre = $match[1] !== '';
1341 $post = $match[3] !== '';
1345 'FormatAutocomments',
1346 array( &$comment, $pre, $auto, $post, $title, $local, $wikiId )
1349 if ( $comment === null ) {
1353 # Remove links that a user may have manually put in the autosummary
1354 # This could be improved by copying as much of Parser::stripSectionName as desired.
1355 $section = str_replace( '[[:', '', $section );
1356 $section = str_replace( '[[', '', $section );
1357 $section = str_replace( ']]', '', $section );
1359 $section = Sanitizer
::normalizeSectionNameWhitespace( $section ); # bug 22784
1361 $sectionTitle = Title
::newFromText( '#' . $section );
1363 $sectionTitle = Title
::makeTitleSafe( $title->getNamespace(),
1364 $title->getDBkey(), $section );
1366 if ( $sectionTitle ) {
1367 $link = Linker
::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
1373 # written summary $presep autocomment (summary /* section */)
1374 $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1377 # autocomment $postsep written summary (/* section */ summary)
1378 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1380 $auto = '<span class="autocomment">' . $auto . '</span>';
1381 $comment = $pre . $link . $wgLang->getDirMark()
1382 . '<span dir="auto">' . $auto;
1383 $append .= '</span>';
1389 return $comment . $append;
1393 * Formats wiki links and media links in text; all other wiki formatting
1396 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1397 * @param string $comment Text to format links in
1398 * @param Title|null $title An optional title object used to links to sections
1399 * @param bool $local Whether section links should refer to local page
1400 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1401 * as used by WikiMap.
1405 public static function formatLinksInComment(
1406 $comment, $title = null, $local = false, $wikiId = null
1408 return preg_replace_callback(
1411 :? # ignore optional leading colon
1412 ([^\]|]+) # 1. link target; page names cannot include ] or |
1414 # 2. a pipe-separated substring; only the last is captured
1415 # Stop matching at | and ]] without relying on backtracking.
1419 ([^[]*) # 3. link trail (the text up until the next link)
1421 function ( $match ) use ( $title, $local, $wikiId ) {
1424 $medians = '(?:' . preg_quote( MWNamespace
::getCanonicalName( NS_MEDIA
), '/' ) . '|';
1425 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
1427 $comment = $match[0];
1429 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1430 if ( strpos( $match[1], '%' ) !== false ) {
1432 rawurldecode( $match[1] ),
1433 array( '<' => '<', '>' => '>' )
1437 # Handle link renaming [[foo|text]] will show link as "text"
1438 if ( $match[2] != "" ) {
1443 $submatch = array();
1445 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1446 # Media link; trail not supported.
1447 $linkRegexp = '/\[\[(.*?)\]\]/';
1448 $title = Title
::makeTitleSafe( NS_FILE
, $submatch[1] );
1450 $thelink = Linker
::makeMediaLinkObj( $title, $text );
1453 # Other kind of link
1454 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1455 $trail = $submatch[1];
1459 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1460 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1461 $match[1] = substr( $match[1], 1 );
1463 list( $inside, $trail ) = Linker
::splitTrail( $trail );
1466 $linkTarget = Linker
::normalizeSubpageLink( $title, $match[1], $linkText );
1468 $target = Title
::newFromText( $linkTarget );
1470 if ( $target->getText() == '' && !$target->isExternal()
1471 && !$local && $title
1473 $newTarget = clone ( $title );
1474 $newTarget->setFragment( '#' . $target->getFragment() );
1475 $target = $newTarget;
1478 $thelink = Linker
::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
1482 // If the link is still valid, go ahead and replace it in!
1483 $comment = preg_replace(
1485 StringUtils
::escapeRegexReplacement( $thelink ),
1498 * Generates a link to the given Title
1500 * @note This is only public for technical reasons. It's not intended for use outside Linker.
1502 * @param Title $title
1503 * @param string $text
1504 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
1505 * as used by WikiMap.
1506 * @param string|string[] $options See the $options parameter in Linker::link.
1508 * @return string HTML link
1510 public static function makeCommentLink(
1511 Title
$title, $text, $wikiId = null, $options = array()
1513 if ( $wikiId !== null && !$title->isExternal() ) {
1514 $link = Linker
::makeExternalLink(
1515 WikiMap
::getForeignURL(
1517 $title->getPrefixedText(),
1518 $title->getFragment()
1521 /* escape = */ false // Already escaped
1524 $link = Linker
::link( $title, $text, array(), array(), $options );
1531 * @param Title $contextTitle
1532 * @param string $target
1533 * @param string $text
1536 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1539 # :Foobar -- override special treatment of prefix (images, language links)
1540 # /Foobar -- convert to CurrentPage/Foobar
1541 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
1542 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1543 # ../Foobar -- convert to CurrentPage/Foobar,
1544 # (from CurrentPage/CurrentSubPage)
1545 # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
1546 # (from CurrentPage/CurrentSubPage)
1548 $ret = $target; # default return value is no change
1550 # Some namespaces don't allow subpages,
1551 # so only perform processing if subpages are allowed
1552 if ( $contextTitle && MWNamespace
::hasSubpages( $contextTitle->getNamespace() ) ) {
1553 $hash = strpos( $target, '#' );
1554 if ( $hash !== false ) {
1555 $suffix = substr( $target, $hash );
1556 $target = substr( $target, 0, $hash );
1561 $target = trim( $target );
1562 # Look at the first character
1563 if ( $target != '' && $target[0] === '/' ) {
1564 # / at end means we don't want the slash to be shown
1566 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1567 if ( $trailingSlashes ) {
1568 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1570 $noslash = substr( $target, 1 );
1573 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1574 if ( $text === '' ) {
1575 $text = $target . $suffix;
1576 } # this might be changed for ugliness reasons
1578 # check for .. subpage backlinks
1580 $nodotdot = $target;
1581 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1583 $nodotdot = substr( $nodotdot, 3 );
1585 if ( $dotdotcount > 0 ) {
1586 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1587 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1588 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1589 # / at the end means don't show full path
1590 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1591 $nodotdot = rtrim( $nodotdot, '/' );
1592 if ( $text === '' ) {
1593 $text = $nodotdot . $suffix;
1596 $nodotdot = trim( $nodotdot );
1597 if ( $nodotdot != '' ) {
1598 $ret .= '/' . $nodotdot;
1610 * Wrap a comment in standard punctuation and formatting if
1611 * it's non-empty, otherwise return empty string.
1613 * @param string $comment
1614 * @param Title|null $title Title object (to generate link to section in autocomment) or null
1615 * @param bool $local Whether section links should refer to local page
1616 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
1617 * For use with external changes.
1621 public static function commentBlock(
1622 $comment, $title = null, $local = false, $wikiId = null
1624 // '*' used to be the comment inserted by the software way back
1625 // in antiquity in case none was provided, here for backwards
1626 // compatibility, acc. to brion -ævar
1627 if ( $comment == '' ||
$comment == '*' ) {
1630 $formatted = self
::formatComment( $comment, $title, $local, $wikiId );
1631 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1632 return " <span class=\"comment\">$formatted</span>";
1637 * Wrap and format the given revision's comment block, if the current
1638 * user is allowed to view it.
1640 * @param Revision $rev
1641 * @param bool $local Whether section links should refer to local page
1642 * @param bool $isPublic Show only if all users can see it
1643 * @return string HTML fragment
1645 public static function revComment( Revision
$rev, $local = false, $isPublic = false ) {
1646 if ( $rev->getComment( Revision
::RAW
) == "" ) {
1649 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) && $isPublic ) {
1650 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1651 } elseif ( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
1652 $block = self
::commentBlock( $rev->getComment( Revision
::FOR_THIS_USER
),
1653 $rev->getTitle(), $local );
1655 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1657 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
1658 return " <span class=\"history-deleted\">$block</span>";
1667 public static function formatRevisionSize( $size ) {
1669 $stxt = wfMessage( 'historyempty' )->escaped();
1671 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1672 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1674 return "<span class=\"history-size\">$stxt</span>";
1678 * Add another level to the Table of Contents
1682 public static function tocIndent() {
1687 * Finish one or more sublevels on the Table of Contents
1692 public static function tocUnindent( $level ) {
1693 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ?
$level : 0 );
1697 * parameter level defines if we are on an indentation level
1699 * @param string $anchor
1700 * @param string $tocline
1701 * @param string $tocnumber
1702 * @param string $level
1703 * @param string|bool $sectionIndex
1706 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1707 $classes = "toclevel-$level";
1708 if ( $sectionIndex !== false ) {
1709 $classes .= " tocsection-$sectionIndex";
1711 return "\n<li class=\"$classes\"><a href=\"#" .
1712 $anchor . '"><span class="tocnumber">' .
1713 $tocnumber . '</span> <span class="toctext">' .
1714 $tocline . '</span></a>';
1718 * End a Table Of Contents line.
1719 * tocUnindent() will be used instead if we're ending a line below
1723 public static function tocLineEnd() {
1728 * Wraps the TOC in a table and provides the hide/collapse javascript.
1730 * @param string $toc Html of the Table Of Contents
1731 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1732 * @return string Full html of the TOC
1734 public static function tocList( $toc, $lang = false ) {
1735 $lang = wfGetLangObj( $lang );
1736 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1738 return '<div id="toc" class="toc">'
1739 . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1741 . "</ul>\n</div>\n";
1745 * Generate a table of contents from a section tree.
1747 * @param array $tree Return value of ParserOutput::getSections()
1748 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1749 * @return string HTML fragment
1751 public static function generateTOC( $tree, $lang = false ) {
1754 foreach ( $tree as $section ) {
1755 if ( $section['toclevel'] > $lastLevel ) {
1756 $toc .= self
::tocIndent();
1757 } elseif ( $section['toclevel'] < $lastLevel ) {
1758 $toc .= self
::tocUnindent(
1759 $lastLevel - $section['toclevel'] );
1761 $toc .= self
::tocLineEnd();
1764 $toc .= self
::tocLine( $section['anchor'],
1765 $section['line'], $section['number'],
1766 $section['toclevel'], $section['index'] );
1767 $lastLevel = $section['toclevel'];
1769 $toc .= self
::tocLineEnd();
1770 return self
::tocList( $toc, $lang );
1774 * Create a headline for content
1776 * @param int $level The level of the headline (1-6)
1777 * @param string $attribs Any attributes for the headline, starting with
1778 * a space and ending with '>'
1779 * This *must* be at least '>' for no attribs
1780 * @param string $anchor The anchor to give the headline (the bit after the #)
1781 * @param string $html Html for the text of the header
1782 * @param string $link HTML to add for the section edit link
1783 * @param bool|string $legacyAnchor A second, optional anchor to give for
1784 * backward compatibility (false to omit)
1786 * @return string HTML headline
1788 public static function makeHeadline( $level, $attribs, $anchor, $html,
1789 $link, $legacyAnchor = false
1791 $ret = "<h$level$attribs"
1792 . "<span class=\"mw-headline\" id=\"$anchor\">$html</span>"
1795 if ( $legacyAnchor !== false ) {
1796 $ret = "<div id=\"$legacyAnchor\"></div>$ret";
1802 * Split a link trail, return the "inside" portion and the remainder of the trail
1803 * as a two-element array
1804 * @param string $trail
1807 static function splitTrail( $trail ) {
1809 $regex = $wgContLang->linkTrail();
1811 if ( $trail !== '' ) {
1813 if ( preg_match( $regex, $trail, $m ) ) {
1818 return array( $inside, $trail );
1822 * Generate a rollback link for a given revision. Currently it's the
1823 * caller's responsibility to ensure that the revision is the top one. If
1824 * it's not, of course, the user will get an error message.
1826 * If the calling page is called with the parameter &bot=1, all rollback
1827 * links also get that parameter. It causes the edit itself and the rollback
1828 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1829 * changes, so this allows sysops to combat a busy vandal without bothering
1832 * If the option verify is set this function will return the link only in case the
1833 * revision can be reverted. Please note that due to performance limitations
1834 * it might be assumed that a user isn't the only contributor of a page while
1835 * (s)he is, which will lead to useless rollback links. Furthermore this wont
1836 * work if $wgShowRollbackEditCount is disabled, so this can only function
1837 * as an additional check.
1839 * If the option noBrackets is set the rollback link wont be enclosed in []
1841 * @param Revision $rev
1842 * @param IContextSource $context Context to use or null for the main context.
1843 * @param array $options
1846 public static function generateRollback( $rev, IContextSource
$context = null,
1847 $options = array( 'verify' )
1849 if ( $context === null ) {
1850 $context = RequestContext
::getMain();
1854 if ( in_array( 'verify', $options ) ) {
1855 $editCount = self
::getRollbackEditCount( $rev, true );
1856 if ( $editCount === false ) {
1861 $inner = self
::buildRollbackLink( $rev, $context, $editCount );
1863 if ( !in_array( 'noBrackets', $options ) ) {
1864 $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
1867 return '<span class="mw-rollback-link">' . $inner . '</span>';
1871 * This function will return the number of revisions which a rollback
1872 * would revert and, if $verify is set it will verify that a revision
1873 * can be reverted (that the user isn't the only contributor and the
1874 * revision we might rollback to isn't deleted). These checks can only
1875 * function as an additional check as this function only checks against
1876 * the last $wgShowRollbackEditCount edits.
1878 * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1879 * is set and the user is the only contributor of the page.
1881 * @param Revision $rev
1882 * @param bool $verify Try to verify that this revision can really be rolled back
1883 * @return int|bool|null
1885 public static function getRollbackEditCount( $rev, $verify ) {
1886 global $wgShowRollbackEditCount;
1887 if ( !is_int( $wgShowRollbackEditCount ) ||
!$wgShowRollbackEditCount > 0 ) {
1888 // Nothing has happened, indicate this by returning 'null'
1892 $dbr = wfGetDB( DB_SLAVE
);
1894 // Up to the value of $wgShowRollbackEditCount revisions are counted
1895 $res = $dbr->select(
1897 array( 'rev_user_text', 'rev_deleted' ),
1898 // $rev->getPage() returns null sometimes
1899 array( 'rev_page' => $rev->getTitle()->getArticleID() ),
1902 'USE INDEX' => array( 'revision' => 'page_timestamp' ),
1903 'ORDER BY' => 'rev_timestamp DESC',
1904 'LIMIT' => $wgShowRollbackEditCount +
1
1910 foreach ( $res as $row ) {
1911 if ( $rev->getUserText( Revision
::RAW
) != $row->rev_user_text
) {
1913 ( $row->rev_deleted
& Revision
::DELETED_TEXT
1914 ||
$row->rev_deleted
& Revision
::DELETED_USER
1916 // If the user or the text of the revision we might rollback
1917 // to is deleted in some way we can't rollback. Similar to
1918 // the sanity checks in WikiPage::commitRollback.
1927 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1928 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1929 // and there weren't any other revisions. That means that the current user is the only
1930 // editor, so we can't rollback
1937 * Build a raw rollback link, useful for collections of "tool" links
1939 * @param Revision $rev
1940 * @param IContextSource|null $context Context to use or null for the main context.
1941 * @param int $editCount Number of edits that would be reverted
1942 * @return string HTML fragment
1944 public static function buildRollbackLink( $rev, IContextSource
$context = null,
1947 global $wgShowRollbackEditCount, $wgMiserMode;
1949 // To config which pages are affected by miser mode
1950 $disableRollbackEditCountSpecialPage = array( 'Recentchanges', 'Watchlist' );
1952 if ( $context === null ) {
1953 $context = RequestContext
::getMain();
1956 $title = $rev->getTitle();
1958 'action' => 'rollback',
1959 'from' => $rev->getUserText(),
1960 'token' => $context->getUser()->getEditToken( array(
1961 $title->getPrefixedText(),
1965 if ( $context->getRequest()->getBool( 'bot' ) ) {
1966 $query['bot'] = '1';
1967 $query['hidediff'] = '1'; // bug 15999
1970 $disableRollbackEditCount = false;
1971 if ( $wgMiserMode ) {
1972 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1973 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1974 $disableRollbackEditCount = true;
1980 if ( !$disableRollbackEditCount
1981 && is_int( $wgShowRollbackEditCount )
1982 && $wgShowRollbackEditCount > 0
1984 if ( !is_numeric( $editCount ) ) {
1985 $editCount = self
::getRollbackEditCount( $rev, false );
1988 if ( $editCount > $wgShowRollbackEditCount ) {
1989 $editCount_output = $context->msg( 'rollbacklinkcount-morethan' )
1990 ->numParams( $wgShowRollbackEditCount )->parse();
1992 $editCount_output = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1998 array( 'title' => $context->msg( 'tooltip-rollback' )->text() ),
2000 array( 'known', 'noclasses' )
2005 $context->msg( 'rollbacklink' )->escaped(),
2006 array( 'title' => $context->msg( 'tooltip-rollback' )->text() ),
2008 array( 'known', 'noclasses' )
2014 * Returns HTML for the "templates used on this page" list.
2016 * Make an HTML list of templates, and then add a "More..." link at
2017 * the bottom. If $more is null, do not add a "More..." link. If $more
2018 * is a Title, make a link to that title and use it. If $more is a string,
2019 * directly paste it in as the link (escaping needs to be done manually).
2020 * Finally, if $more is a Message, call toString().
2022 * @param array $templates Array of templates from Article::getUsedTemplate or similar
2023 * @param bool $preview Whether this is for a preview
2024 * @param bool $section Whether this is for a section edit
2025 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
2026 * @return string HTML output
2028 public static function formatTemplates( $templates, $preview = false,
2029 $section = false, $more = null
2034 if ( count( $templates ) > 0 ) {
2035 # Do a batch existence check
2036 $batch = new LinkBatch
;
2037 foreach ( $templates as $title ) {
2038 $batch->addObj( $title );
2042 # Construct the HTML
2043 $outText = '<div class="mw-templatesUsedExplanation">';
2045 $outText .= wfMessage( 'templatesusedpreview' )->numParams( count( $templates ) )
2047 } elseif ( $section ) {
2048 $outText .= wfMessage( 'templatesusedsection' )->numParams( count( $templates ) )
2051 $outText .= wfMessage( 'templatesused' )->numParams( count( $templates ) )
2054 $outText .= "</div><ul>\n";
2056 usort( $templates, 'Title::compare' );
2057 foreach ( $templates as $titleObj ) {
2059 $restrictions = $titleObj->getRestrictions( 'edit' );
2060 if ( $restrictions ) {
2061 // Check backwards-compatible messages
2063 if ( $restrictions === array( 'sysop' ) ) {
2064 $msg = wfMessage( 'template-protected' );
2065 } elseif ( $restrictions === array( 'autoconfirmed' ) ) {
2066 $msg = wfMessage( 'template-semiprotected' );
2068 if ( $msg && !$msg->isDisabled() ) {
2069 $protected = $msg->parse();
2071 // Construct the message from restriction-level-*
2072 // e.g. restriction-level-sysop, restriction-level-autoconfirmed
2074 foreach ( $restrictions as $r ) {
2075 $msgs[] = wfMessage( "restriction-level-$r" )->parse();
2077 $protected = wfMessage( 'parentheses' )
2078 ->rawParams( $wgLang->commaList( $msgs ) )->escaped();
2081 if ( $titleObj->quickUserCan( 'edit' ) ) {
2082 $editLink = self
::link(
2084 wfMessage( 'editlink' )->escaped(),
2086 array( 'action' => 'edit' )
2089 $editLink = self
::link(
2091 wfMessage( 'viewsourcelink' )->escaped(),
2093 array( 'action' => 'edit' )
2096 $outText .= '<li>' . self
::link( $titleObj )
2097 . wfMessage( 'word-separator' )->escaped()
2098 . wfMessage( 'parentheses' )->rawParams( $editLink )->escaped()
2099 . wfMessage( 'word-separator' )->escaped()
2100 . $protected . '</li>';
2103 if ( $more instanceof Title
) {
2104 $outText .= '<li>' . self
::link( $more, wfMessage( 'moredotdotdot' ) ) . '</li>';
2105 } elseif ( $more ) {
2106 $outText .= "<li>$more</li>";
2109 $outText .= '</ul>';
2115 * Returns HTML for the "hidden categories on this page" list.
2117 * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
2119 * @return string HTML output
2121 public static function formatHiddenCategories( $hiddencats ) {
2124 if ( count( $hiddencats ) > 0 ) {
2125 # Construct the HTML
2126 $outText = '<div class="mw-hiddenCategoriesExplanation">';
2127 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
2128 $outText .= "</div><ul>\n";
2130 foreach ( $hiddencats as $titleObj ) {
2131 # If it's hidden, it must exist - no need to check with a LinkBatch
2133 . self
::link( $titleObj, null, array(), array(), 'known' )
2136 $outText .= '</ul>';
2142 * Format a size in bytes for output, using an appropriate
2143 * unit (B, KB, MB or GB) according to the magnitude in question
2145 * @param int $size Size to format
2148 public static function formatSize( $size ) {
2150 return htmlspecialchars( $wgLang->formatSize( $size ) );
2154 * Given the id of an interface element, constructs the appropriate title
2155 * attribute from the system messages. (Note, this is usually the id but
2156 * isn't always, because sometimes the accesskey needs to go on a different
2157 * element than the id, for reverse-compatibility, etc.)
2159 * @param string $name Id of the element, minus prefixes.
2160 * @param string|null $options Null or the string 'withaccess' to add an access-
2162 * @return string Contents of the title attribute (which you must HTML-
2163 * escape), or false for no title attribute
2165 public static function titleAttrib( $name, $options = null ) {
2167 $message = wfMessage( "tooltip-$name" );
2169 if ( !$message->exists() ) {
2172 $tooltip = $message->text();
2173 # Compatibility: formerly some tooltips had [alt-.] hardcoded
2174 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
2175 # Message equal to '-' means suppress it.
2176 if ( $tooltip == '-' ) {
2181 if ( $options == 'withaccess' ) {
2182 $accesskey = self
::accesskey( $name );
2183 if ( $accesskey !== false ) {
2184 // Should be build the same as in jquery.accessKeyLabel.js
2185 if ( $tooltip === false ||
$tooltip === '' ) {
2186 $tooltip = wfMessage( 'brackets', $accesskey )->text();
2188 $tooltip .= wfMessage( 'word-separator' )->text();
2189 $tooltip .= wfMessage( 'brackets', $accesskey )->text();
2197 public static $accesskeycache;
2200 * Given the id of an interface element, constructs the appropriate
2201 * accesskey attribute from the system messages. (Note, this is usually
2202 * the id but isn't always, because sometimes the accesskey needs to go on
2203 * a different element than the id, for reverse-compatibility, etc.)
2205 * @param string $name Id of the element, minus prefixes.
2206 * @return string Contents of the accesskey attribute (which you must HTML-
2207 * escape), or false for no accesskey attribute
2209 public static function accesskey( $name ) {
2210 if ( isset( self
::$accesskeycache[$name] ) ) {
2211 return self
::$accesskeycache[$name];
2214 $message = wfMessage( "accesskey-$name" );
2216 if ( !$message->exists() ) {
2219 $accesskey = $message->plain();
2220 if ( $accesskey === '' ||
$accesskey === '-' ) {
2221 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2222 # attribute, but this is broken for accesskey: that might be a useful
2228 self
::$accesskeycache[$name] = $accesskey;
2229 return self
::$accesskeycache[$name];
2233 * Get a revision-deletion link, or disabled link, or nothing, depending
2234 * on user permissions & the settings on the revision.
2236 * Will use forward-compatible revision ID in the Special:RevDelete link
2237 * if possible, otherwise the timestamp-based ID which may break after
2241 * @param Revision $rev
2242 * @param Title $title
2243 * @return string HTML fragment
2245 public static function getRevDeleteLink( User
$user, Revision
$rev, Title
$title ) {
2246 $canHide = $user->isAllowed( 'deleterevision' );
2247 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2251 if ( !$rev->userCan( Revision
::DELETED_RESTRICTED
, $user ) ) {
2252 return Linker
::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2254 if ( $rev->getId() ) {
2255 // RevDelete links using revision ID are stable across
2256 // page deletion and undeletion; use when possible.
2258 'type' => 'revision',
2259 'target' => $title->getPrefixedDBkey(),
2260 'ids' => $rev->getId()
2263 // Older deleted entries didn't save a revision ID.
2264 // We have to refer to these by timestamp, ick!
2266 'type' => 'archive',
2267 'target' => $title->getPrefixedDBkey(),
2268 'ids' => $rev->getTimestamp()
2271 return Linker
::revDeleteLink( $query,
2272 $rev->isDeleted( Revision
::DELETED_RESTRICTED
), $canHide );
2277 * Creates a (show/hide) link for deleting revisions/log entries
2279 * @param array $query Query parameters to be passed to link()
2280 * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2281 * @param bool $delete Set to true to use (show/hide) rather than (show)
2283 * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2284 * span to allow for customization of appearance with CSS
2286 public static function revDeleteLink( $query = array(), $restricted = false, $delete = true ) {
2287 $sp = SpecialPage
::getTitleFor( 'Revisiondelete' );
2288 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2289 $html = wfMessage( $msgKey )->escaped();
2290 $tag = $restricted ?
'strong' : 'span';
2291 $link = self
::link( $sp, $html, array(), $query, array( 'known', 'noclasses' ) );
2294 array( 'class' => 'mw-revdelundel-link' ),
2295 wfMessage( 'parentheses' )->rawParams( $link )->escaped()
2300 * Creates a dead (show/hide) link for deleting revisions/log entries
2302 * @param bool $delete Set to true to use (show/hide) rather than (show)
2304 * @return string HTML text wrapped in a span to allow for customization
2305 * of appearance with CSS
2307 public static function revDeleteLinkDisabled( $delete = true ) {
2308 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2309 $html = wfMessage( $msgKey )->escaped();
2310 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2311 return Xml
::tags( 'span', array( 'class' => 'mw-revdelundel-link' ), $htmlParentheses );
2314 /* Deprecated methods */
2317 * @deprecated since 1.16 Use link(); warnings since 1.21
2319 * Make a link for a title which may or may not be in the database. If you need to
2320 * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
2321 * call to this will result in a DB query.
2323 * @param Title $nt The title object to make the link from, e.g. from Title::newFromText.
2324 * @param string $text Link text
2325 * @param string $query Optional query part
2326 * @param string $trail Optional trail. Alphabetic characters at the start of this string will
2327 * be included in the link text. Other characters will be appended after
2328 * the end of the link.
2329 * @param string $prefix Optional prefix. As trail, only before instead of after.
2332 static function makeLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
2333 wfDeprecated( __METHOD__
, '1.21' );
2335 $query = wfCgiToArray( $query );
2336 list( $inside, $trail ) = self
::splitTrail( $trail );
2337 if ( $text === '' ) {
2338 $text = self
::linkText( $nt );
2341 $ret = self
::link( $nt, "$prefix$text$inside", array(), $query ) . $trail;
2347 * @deprecated since 1.16 Use link(); warnings since 1.21
2349 * Make a link for a title which definitely exists. This is faster than makeLinkObj because
2350 * it doesn't have to do a database query. It's also valid for interwiki titles and special
2353 * @param Title $title Title object of target page
2354 * @param string $text Text to replace the title
2355 * @param string $query Link target
2356 * @param string $trail Text after link
2357 * @param string $prefix Text before link text
2358 * @param string $aprops Extra attributes to the a-element
2359 * @param string $style Style to apply - if empty, use getInternalLinkAttributesObj instead
2360 * @return string The a-element
2362 static function makeKnownLinkObj(
2363 $title, $text = '', $query = '', $trail = '', $prefix = '', $aprops = '', $style = ''
2365 wfDeprecated( __METHOD__
, '1.21' );
2367 if ( $text == '' ) {
2368 $text = self
::linkText( $title );
2370 $attribs = Sanitizer
::mergeAttributes(
2371 Sanitizer
::decodeTagAttributes( $aprops ),
2372 Sanitizer
::decodeTagAttributes( $style )
2374 $query = wfCgiToArray( $query );
2375 list( $inside, $trail ) = self
::splitTrail( $trail );
2377 $ret = self
::link( $title, "$prefix$text$inside", $attribs, $query,
2378 array( 'known', 'noclasses' ) ) . $trail;
2384 * Returns the attributes for the tooltip and access key.
2385 * @param string $name
2388 public static function tooltipAndAccesskeyAttribs( $name ) {
2389 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2390 # no attribute" instead of "output '' as value for attribute", this
2391 # would be three lines.
2393 'title' => self
::titleAttrib( $name, 'withaccess' ),
2394 'accesskey' => self
::accesskey( $name )
2396 if ( $attribs['title'] === false ) {
2397 unset( $attribs['title'] );
2399 if ( $attribs['accesskey'] === false ) {
2400 unset( $attribs['accesskey'] );
2406 * Returns raw bits of HTML, use titleAttrib()
2407 * @param string $name
2408 * @param array|null $options
2409 * @return null|string
2411 public static function tooltip( $name, $options = null ) {
2412 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2413 # no attribute" instead of "output '' as value for attribute", this
2414 # would be two lines.
2415 $tooltip = self
::titleAttrib( $name, $options );
2416 if ( $tooltip === false ) {
2419 return Xml
::expandAttributes( array(
2432 * Use PHP's magic __call handler to transform instance calls to a dummy instance
2433 * into static calls to the new Linker for backwards compatibility.
2435 * @param string $fname Name of called method
2436 * @param array $args Arguments to the method
2439 public function __call( $fname, $args ) {
2440 return call_user_func_array( array( 'Linker', $fname ), $args );