a912fdeb2b5be7af3a8a2ba9a41a9a450f0cede1
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.
35 * Flags for userToolLinks()
37 const TOOL_LINKS_NOBLOCK
= 1;
38 const TOOL_LINKS_EMAIL
= 2;
41 * Get the appropriate HTML attributes to add to the "a" element of an
42 * external link, as created by [wikisyntax].
44 * @param string $class The contents of the class attribute; if an empty
45 * string is passed, which is the default value, defaults to 'external'.
47 * @deprecated since 1.18 Just pass the external class directly to something using Html::expandAttributes
49 static function getExternalLinkAttributes( $class = 'external' ) {
50 wfDeprecated( __METHOD__
, '1.18' );
51 return self
::getLinkAttributesInternal( '', $class );
55 * Get the appropriate HTML attributes to add to the "a" element of an interwiki link.
57 * @param string $title The title text for the link, URL-encoded (???) but
59 * @param string $unused Unused
60 * @param string $class The contents of the class attribute; if an empty
61 * string is passed, which is the default value, defaults to 'external'.
64 static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
67 # @todo FIXME: We have a whole bunch of handling here that doesn't happen in
68 # getExternalLinkAttributes, why?
69 $title = urldecode( $title );
70 $title = $wgContLang->checkTitleEncoding( $title );
71 $title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );
73 return self
::getLinkAttributesInternal( $title, $class );
77 * Get the appropriate HTML attributes to add to the "a" element of an internal link.
79 * @param string $title The title text for the link, URL-encoded (???) but
81 * @param string $unused Unused
82 * @param string $class The contents of the class attribute, default none
85 static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
86 $title = urldecode( $title );
87 $title = str_replace( '_', ' ', $title );
88 return self
::getLinkAttributesInternal( $title, $class );
92 * Get the appropriate HTML attributes to add to the "a" element of an internal
93 * link, given the Title object for the page we want to link to.
96 * @param string $unused Unused
97 * @param string $class The contents of the class attribute, default none
98 * @param string|bool $title Optional (unescaped) string to use in the title
99 * attribute; if false, default to the name of the page we're linking to
102 static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
103 if ( $title === false ) {
104 $title = $nt->getPrefixedText();
106 return self
::getLinkAttributesInternal( $title, $class );
110 * Common code for getLinkAttributesX functions
112 * @param string $title
113 * @param string $class
117 private static function getLinkAttributesInternal( $title, $class ) {
118 $title = htmlspecialchars( $title );
119 $class = htmlspecialchars( $class );
121 if ( $class != '' ) {
122 $r .= " class=\"$class\"";
124 if ( $title != '' ) {
125 $r .= " title=\"$title\"";
131 * Return the CSS colour of a known link
134 * @param int $threshold User defined threshold
135 * @return string CSS class
137 public static function getLinkColour( $t, $threshold ) {
139 if ( $t->isRedirect() ) {
141 $colour = 'mw-redirect';
142 } elseif ( $threshold > 0 && $t->isContentPage() &&
143 $t->exists() && $t->getLength() < $threshold
152 * This function returns an HTML link to the given target. It serves a few
154 * 1) If $target is a Title, the correct URL to link to will be figured
156 * 2) It automatically adds the usual classes for various types of link
157 * targets: "new" for red links, "stub" for short articles, etc.
158 * 3) It escapes all attribute values safely so there's no risk of XSS.
159 * 4) It provides a default tooltip if the target is a Title (the page
160 * name of the target).
161 * link() replaces the old functions in the makeLink() family.
163 * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18.
165 * @param Title $target Can currently only be a Title, but this may
166 * change to support Images, literal URLs, etc.
167 * @param string $html The HTML contents of the <a> element, i.e.,
168 * the link text. This is raw HTML and will not be escaped. If null,
169 * defaults to the prefixed text of the Title; or if the Title is just a
170 * fragment, the contents of the fragment.
171 * @param array $customAttribs A key => value array of extra HTML attributes,
172 * such as title and class. (href is ignored.) Classes will be
173 * merged with the default classes, while other attributes will replace
174 * default attributes. All passed attribute values will be HTML-escaped.
175 * A false attribute value means to suppress that attribute.
176 * @param array $query The query string to append to the URL
177 * you're linking to, in key => value array form. Query keys and values
178 * will be URL-encoded.
179 * @param string|array $options String or array of strings:
180 * 'known': Page is known to exist, so don't check if it does.
181 * 'broken': Page is known not to exist, so don't check if it does.
182 * 'noclasses': Don't add any classes automatically (includes "new",
183 * "stub", "mw-redirect", "extiw"). Only use the class attribute
184 * provided, if any, so you get a simple blue link with no funny i-
186 * 'forcearticlepath': Use the article path always, even with a querystring.
187 * Has compatibility issues on some setups, so avoid wherever possible.
188 * 'http': Force a full URL with http:// as the scheme.
189 * 'https': Force a full URL with https:// as the scheme.
190 * @return string HTML <a> attribute
192 public static function link(
193 $target, $html = null, $customAttribs = array(), $query = array(), $options = array()
195 wfProfileIn( __METHOD__
);
196 if ( !$target instanceof Title
) {
197 wfProfileOut( __METHOD__
);
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 ( !wfRunHooks( 'LinkBegin', array( $dummy, $target, &$html,
212 &$customAttribs, &$query, &$options, &$ret ) ) ) {
213 wfProfileOut( __METHOD__
);
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 wfProfileIn( __METHOD__
. '-checkPageExistence' );
222 if ( !in_array( 'known', $options ) and !in_array( 'broken', $options ) ) {
223 if ( $target->isKnown() ) {
224 $options[] = 'known';
226 $options[] = 'broken';
229 wfProfileOut( __METHOD__
. '-checkPageExistence' );
232 if ( in_array( "forcearticlepath", $options ) && $query ) {
237 # Note: we want the href attribute first, for prettiness.
238 $attribs = array( 'href' => self
::linkUrl( $target, $query, $options ) );
239 if ( in_array( 'forcearticlepath', $options ) && $oldquery ) {
240 $attribs['href'] = wfAppendQuery( $attribs['href'], $oldquery );
243 $attribs = array_merge(
245 self
::linkAttribs( $target, $customAttribs, $options )
247 if ( is_null( $html ) ) {
248 $html = self
::linkText( $target );
252 if ( wfRunHooks( 'LinkEnd', array( $dummy, $target, $options, &$html, &$attribs, &$ret ) ) ) {
253 $ret = Html
::rawElement( 'a', $attribs, $html );
256 wfProfileOut( __METHOD__
);
261 * Identical to link(), except $options defaults to 'known'.
264 public static function linkKnown(
265 $target, $html = null, $customAttribs = array(),
266 $query = array(), $options = array( 'known', 'noclasses' )
268 return self
::link( $target, $html, $customAttribs, $query, $options );
272 * Returns the Url used to link to a Title
274 * @param Title $target
275 * @param array $query query parameters
276 * @param array $options
279 private static function linkUrl( $target, $query, $options ) {
280 wfProfileIn( __METHOD__
);
281 # We don't want to include fragments for broken links, because they
282 # generally make no sense.
283 if ( in_array( 'broken', $options ) && $target->hasFragment() ) {
284 $target = clone $target;
285 $target->setFragment( '' );
288 # If it's a broken link, add the appropriate query pieces, unless
289 # there's already an action specified, or unless 'edit' makes no sense
290 # (i.e., for a nonexistent special page).
291 if ( in_array( 'broken', $options ) && empty( $query['action'] )
292 && !$target->isSpecialPage() ) {
293 $query['action'] = 'edit';
294 $query['redlink'] = '1';
297 if ( in_array( 'http', $options ) ) {
299 } elseif ( in_array( 'https', $options ) ) {
300 $proto = PROTO_HTTPS
;
302 $proto = PROTO_RELATIVE
;
305 $ret = $target->getLinkURL( $query, false, $proto );
306 wfProfileOut( __METHOD__
);
311 * Returns the array of attributes used when linking to the Title $target
313 * @param Title $target
314 * @param array $attribs
315 * @param array $options
319 private static function linkAttribs( $target, $attribs, $options ) {
320 wfProfileIn( __METHOD__
);
324 if ( !in_array( 'noclasses', $options ) ) {
325 wfProfileIn( __METHOD__
. '-getClasses' );
326 # Now build the classes.
329 if ( in_array( 'broken', $options ) ) {
333 if ( $target->isExternal() ) {
334 $classes[] = 'extiw';
337 if ( !in_array( 'broken', $options ) ) { # Avoid useless calls to LinkCache (see r50387)
338 $colour = self
::getLinkColour( $target, $wgUser->getStubThreshold() );
339 if ( $colour !== '' ) {
340 $classes[] = $colour; # mw-redirect or stub
343 if ( $classes != array() ) {
344 $defaults['class'] = implode( ' ', $classes );
346 wfProfileOut( __METHOD__
. '-getClasses' );
349 # Get a default title attribute.
350 if ( $target->getPrefixedText() == '' ) {
351 # A link like [[#Foo]]. This used to mean an empty title
352 # attribute, but that's silly. Just don't output a title.
353 } elseif ( in_array( 'known', $options ) ) {
354 $defaults['title'] = $target->getPrefixedText();
356 $defaults['title'] = wfMessage( 'red-link-title', $target->getPrefixedText() )->text();
359 # Finally, merge the custom attribs with the default ones, and iterate
360 # over that, deleting all "false" attributes.
362 $merged = Sanitizer
::mergeAttributes( $defaults, $attribs );
363 foreach ( $merged as $key => $val ) {
364 # A false value suppresses the attribute, and we don't want the
365 # href attribute to be overridden.
366 if ( $key != 'href' and $val !== false ) {
370 wfProfileOut( __METHOD__
);
375 * Default text of the links to the Title $target
377 * @param Title $target
381 private static function linkText( $target ) {
382 // We might be passed a non-Title by make*LinkObj(). Fail gracefully.
383 if ( !$target instanceof Title
) {
387 // If the target is just a fragment, with no title, we return the fragment
388 // text. Otherwise, we return the title text itself.
389 if ( $target->getPrefixedText() === '' && $target->hasFragment() ) {
390 return htmlspecialchars( $target->getFragment() );
392 return htmlspecialchars( $target->getPrefixedText() );
396 * Make appropriate markup for a link to the current article. This is currently rendered
397 * as the bold link text. The calling sequence is the same as the other make*LinkObj static functions,
398 * despite $query not being used.
401 * @param string $html [optional]
402 * @param string $query [optional]
403 * @param string $trail [optional]
404 * @param string $prefix [optional]
409 public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
411 $html = htmlspecialchars( $nt->getPrefixedText() );
413 list( $inside, $trail ) = self
::splitTrail( $trail );
414 return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
418 * Get a message saying that an invalid title was encountered.
419 * This should be called after a method like Title::makeTitleSafe() returned
420 * a value indicating that the title object is invalid.
422 * @param IContextSource $context Context to use to get the messages
423 * @param int $namespace Namespace number
424 * @param string $title Text of the title, without the namespace part
427 public static function getInvalidTitleDescription( IContextSource
$context, $namespace, $title ) {
430 // First we check whether the namespace exists or not.
431 if ( MWNamespace
::exists( $namespace ) ) {
432 if ( $namespace == NS_MAIN
) {
433 $name = $context->msg( 'blanknamespace' )->text();
435 $name = $wgContLang->getFormattedNsText( $namespace );
437 return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
439 return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
444 * @param Title $title
447 static function normaliseSpecialPage( Title
$title ) {
448 if ( $title->isSpecialPage() ) {
449 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
453 $ret = SpecialPage
::getTitleFor( $name, $subpage, $title->getFragment() );
461 * Returns the filename part of an url.
462 * Used as alternative text for external images.
468 private static function fnamePart( $url ) {
469 $basename = strrchr( $url, '/' );
470 if ( false === $basename ) {
473 $basename = substr( $basename, 1 );
479 * Return the code for images which were added via external links,
480 * via Parser::maybeMakeExternalImage().
487 public static function makeExternalImage( $url, $alt = '' ) {
489 $alt = self
::fnamePart( $url );
492 $success = wfRunHooks( 'LinkerMakeExternalImage', array( &$url, &$alt, &$img ) );
494 wfDebug( "Hook LinkerMakeExternalImage changed the output of external image with url {$url} and alt text {$alt} to {$img}\n", true );
497 return Html
::element( 'img',
504 * Given parameters derived from [[Image:Foo|options...]], generate the
505 * HTML that that syntax inserts in the page.
507 * @param Parser $parser
508 * @param Title $title Title object of the file (not the currently viewed page)
509 * @param File $file File object, or false if it doesn't exist
510 * @param array $frameParams Associative array of parameters external to the media handler.
511 * Boolean parameters are indicated by presence or absence, the value is arbitrary and
512 * will often be false.
513 * thumbnail If present, downscale and frame
514 * manualthumb Image name to use as a thumbnail, instead of automatic scaling
515 * framed Shows image in original size in a frame
516 * frameless Downscale but don't frame
517 * upright If present, tweak default sizes for portrait orientation
518 * upright_factor Fudge factor for "upright" tweak (default 0.75)
519 * border If present, show a border around the image
520 * align Horizontal alignment (left, right, center, none)
521 * valign Vertical alignment (baseline, sub, super, top, text-top, middle,
522 * bottom, text-bottom)
523 * alt Alternate text for image (i.e. alt attribute). Plain text.
524 * class HTML for image classes. Plain text.
525 * caption HTML for image caption.
526 * link-url URL to link to
527 * link-title Title object to link to
528 * link-target Value for the target attribute, only with link-url
529 * no-link Boolean, suppress description link
531 * @param array $handlerParams Associative array of media handler parameters, to be passed
532 * to transform(). Typical keys are "width" and "page".
533 * @param string|bool $time Timestamp of the file, set as false for current
534 * @param string $query Query params for desc url
535 * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize
537 * @return string HTML for an image, with links, wrappers, etc.
539 public static function makeImageLink( /*Parser*/ $parser, Title
$title, $file, $frameParams = array(),
540 $handlerParams = array(), $time = false, $query = "", $widthOption = null
543 $dummy = new DummyLinker
;
544 if ( !wfRunHooks( 'ImageBeforeProduceHTML', array( &$dummy, &$title,
545 &$file, &$frameParams, &$handlerParams, &$time, &$res ) ) ) {
549 if ( $file && !$file->allowInlineDisplay() ) {
550 wfDebug( __METHOD__
. ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
551 return self
::link( $title );
556 $hp =& $handlerParams;
558 // Clean up parameters
559 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
560 if ( !isset( $fp['align'] ) ) {
563 if ( !isset( $fp['alt'] ) ) {
566 if ( !isset( $fp['title'] ) ) {
569 if ( !isset( $fp['class'] ) ) {
573 $prefix = $postfix = '';
575 if ( 'center' == $fp['align'] ) {
576 $prefix = '<div class="center">';
578 $fp['align'] = 'none';
580 if ( $file && !isset( $hp['width'] ) ) {
581 if ( isset( $hp['height'] ) && $file->isVectorized() ) {
582 // If its a vector image, and user only specifies height
583 // we don't want it to be limited by its "normal" width.
584 global $wgSVGMaxSize;
585 $hp['width'] = $wgSVGMaxSize;
587 $hp['width'] = $file->getWidth( $page );
590 if ( isset( $fp['thumbnail'] ) ||
isset( $fp['manualthumb'] ) ||
isset( $fp['framed'] ) ||
isset( $fp['frameless'] ) ||
!$hp['width'] ) {
591 global $wgThumbLimits, $wgThumbUpright;
592 if ( $widthOption === null ||
!isset( $wgThumbLimits[$widthOption] ) ) {
593 $widthOption = User
::getDefaultOption( 'thumbsize' );
596 // Reduce width for upright images when parameter 'upright' is used
597 if ( isset( $fp['upright'] ) && $fp['upright'] == 0 ) {
598 $fp['upright'] = $wgThumbUpright;
600 // For caching health: If width scaled down due to upright parameter, round to full __0 pixel to avoid the creation of a lot of odd thumbs
601 $prefWidth = isset( $fp['upright'] ) ?
602 round( $wgThumbLimits[$widthOption] * $fp['upright'], -1 ) :
603 $wgThumbLimits[$widthOption];
605 // Use width which is smaller: real image width or user preference width
606 // Unless image is scalable vector.
607 if ( !isset( $hp['height'] ) && ( $hp['width'] <= 0 ||
608 $prefWidth < $hp['width'] ||
$file->isVectorized() ) ) {
609 $hp['width'] = $prefWidth;
614 if ( isset( $fp['thumbnail'] ) ||
isset( $fp['manualthumb'] ) ||
isset( $fp['framed'] ) ) {
615 # Create a thumbnail. Alignment depends on the writing direction of
616 # the page content language (right-aligned for LTR languages,
617 # left-aligned for RTL languages)
619 # If a thumbnail width has not been provided, it is set
620 # to the default user option as specified in Language*.php
621 if ( $fp['align'] == '' ) {
622 if ( $parser instanceof Parser
) {
623 $fp['align'] = $parser->getTargetLanguage()->alignEnd();
625 # backwards compatibility, remove with makeImageLink2()
627 $fp['align'] = $wgContLang->alignEnd();
630 return $prefix . self
::makeThumbLink2( $title, $file, $fp, $hp, $time, $query ) . $postfix;
633 if ( $file && isset( $fp['frameless'] ) ) {
634 $srcWidth = $file->getWidth( $page );
635 # For "frameless" option: do not present an image bigger than the source (for bitmap-style images)
636 # This is the same behavior as the "thumb" option does it already.
637 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
638 $hp['width'] = $srcWidth;
642 if ( $file && isset( $hp['width'] ) ) {
643 # Create a resized image, without the additional thumbnail features
644 $thumb = $file->transform( $hp );
650 $s = self
::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
652 self
::processResponsiveImages( $file, $thumb, $hp );
655 'title' => $fp['title'],
656 'valign' => isset( $fp['valign'] ) ?
$fp['valign'] : false,
657 'img-class' => $fp['class'] );
658 if ( isset( $fp['border'] ) ) {
659 $params['img-class'] .= ( $params['img-class'] !== '' ?
' ' : '' ) . 'thumbborder';
661 $params = self
::getImageLinkMTOParams( $fp, $query, $parser ) +
$params;
663 $s = $thumb->toHtml( $params );
665 if ( $fp['align'] != '' ) {
666 $s = "<div class=\"float{$fp['align']}\">{$s}</div>";
668 return str_replace( "\n", ' ', $prefix . $s . $postfix );
672 * See makeImageLink()
673 * When this function is removed, remove if( $parser instanceof Parser ) check there too
674 * @deprecated since 1.20
676 public static function makeImageLink2( Title
$title, $file, $frameParams = array(),
677 $handlerParams = array(), $time = false, $query = "", $widthOption = null ) {
678 return self
::makeImageLink( null, $title, $file, $frameParams,
679 $handlerParams, $time, $query, $widthOption );
683 * Get the link parameters for MediaTransformOutput::toHtml() from given
684 * frame parameters supplied by the Parser.
685 * @param array $frameParams The frame parameters
686 * @param string $query An optional query string to add to description page links
689 private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
690 $mtoParams = array();
691 if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
692 $mtoParams['custom-url-link'] = $frameParams['link-url'];
693 if ( isset( $frameParams['link-target'] ) ) {
694 $mtoParams['custom-target-link'] = $frameParams['link-target'];
697 $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
698 foreach ( $extLinkAttrs as $name => $val ) {
699 // Currently could include 'rel' and 'target'
700 $mtoParams['parser-extlink-' . $name] = $val;
703 } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
704 $mtoParams['custom-title-link'] = self
::normaliseSpecialPage( $frameParams['link-title'] );
705 } elseif ( !empty( $frameParams['no-link'] ) ) {
708 $mtoParams['desc-link'] = true;
709 $mtoParams['desc-query'] = $query;
715 * Make HTML for a thumbnail including image, border and caption
716 * @param Title $title
717 * @param File|bool $file File object or false if it doesn't exist
718 * @param string $label
720 * @param string $align
721 * @param array $params
722 * @param bool $framed
723 * @param string $manualthumb
726 public static function makeThumbLinkObj( Title
$title, $file, $label = '', $alt,
727 $align = 'right', $params = array(), $framed = false, $manualthumb = ""
729 $frameParams = array(
735 $frameParams['framed'] = true;
737 if ( $manualthumb ) {
738 $frameParams['manualthumb'] = $manualthumb;
740 return self
::makeThumbLink2( $title, $file, $frameParams, $params );
744 * @param Title $title
746 * @param array $frameParams
747 * @param array $handlerParams
749 * @param string $query
752 public static function makeThumbLink2( Title
$title, $file, $frameParams = array(),
753 $handlerParams = array(), $time = false, $query = ""
755 global $wgStylePath, $wgContLang;
756 $exists = $file && $file->exists();
760 $hp =& $handlerParams;
762 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
763 if ( !isset( $fp['align'] ) ) {
764 $fp['align'] = 'right';
766 if ( !isset( $fp['alt'] ) ) {
769 if ( !isset( $fp['title'] ) ) {
772 if ( !isset( $fp['caption'] ) ) {
776 if ( empty( $hp['width'] ) ) {
777 // Reduce width for upright images when parameter 'upright' is used
778 $hp['width'] = isset( $fp['upright'] ) ?
130 : 180;
782 $manualthumb = false;
785 $outerWidth = $hp['width'] +
2;
787 if ( isset( $fp['manualthumb'] ) ) {
788 # Use manually specified thumbnail
789 $manual_title = Title
::makeTitleSafe( NS_FILE
, $fp['manualthumb'] );
790 if ( $manual_title ) {
791 $manual_img = wfFindFile( $manual_title );
793 $thumb = $manual_img->getUnscaledThumb( $hp );
799 } elseif ( isset( $fp['framed'] ) ) {
800 // Use image dimensions, don't scale
801 $thumb = $file->getUnscaledThumb( $hp );
804 # Do not present an image bigger than the source, for bitmap-style images
805 # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
806 $srcWidth = $file->getWidth( $page );
807 if ( $srcWidth && !$file->mustRender() && $hp['width'] > $srcWidth ) {
808 $hp['width'] = $srcWidth;
810 $thumb = $file->transform( $hp );
814 $outerWidth = $thumb->getWidth() +
2;
816 $outerWidth = $hp['width'] +
2;
820 # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
821 # So we don't need to pass it here in $query. However, the URL for the
822 # zoom icon still needs it, so we make a unique query for it. See bug 14771
823 $url = $title->getLocalURL( $query );
825 $url = wfAppendQuery( $url, array( 'page' => $page ) );
828 && !isset( $fp['link-title'] )
829 && !isset( $fp['link-url'] )
830 && !isset( $fp['no-link'] ) ) {
831 $fp['link-url'] = $url;
834 $s = "<div class=\"thumb t{$fp['align']}\"><div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";
836 $s .= self
::makeBrokenImageLinkObj( $title, $fp['title'], '', '', '', $time == true );
838 } elseif ( !$thumb ) {
839 $s .= wfMessage( 'thumbnail_error', '' )->escaped();
842 if ( !$noscale && !$manualthumb ) {
843 self
::processResponsiveImages( $file, $thumb, $hp );
847 'title' => $fp['title'],
848 'img-class' => ( isset( $fp['class'] ) && $fp['class'] !== '' ?
$fp['class'] . ' ' : '' ) . 'thumbimage'
850 $params = self
::getImageLinkMTOParams( $fp, $query ) +
$params;
851 $s .= $thumb->toHtml( $params );
852 if ( isset( $fp['framed'] ) ) {
855 $zoomIcon = Html
::rawElement( 'div', array( 'class' => 'magnify' ),
856 Html
::rawElement( 'a', array(
858 'class' => 'internal',
859 'title' => wfMessage( 'thumbnail-more' )->text() ),
860 Html
::element( 'img', array(
861 'src' => $wgStylePath . '/common/images/magnify-clip' . ( $wgContLang->isRTL() ?
'-rtl' : '' ) . '.png',
867 $s .= ' <div class="thumbcaption">' . $zoomIcon . $fp['caption'] . "</div></div></div>";
868 return str_replace( "\n", ' ', $s );
872 * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where
876 * @param MediaTransformOutput $thumb
877 * @param array $hp Image parameters
879 public static function processResponsiveImages( $file, $thumb, $hp ) {
880 global $wgResponsiveImages;
881 if ( $wgResponsiveImages ) {
883 $hp15['width'] = round( $hp['width'] * 1.5 );
885 $hp20['width'] = $hp['width'] * 2;
886 if ( isset( $hp['height'] ) ) {
887 $hp15['height'] = round( $hp['height'] * 1.5 );
888 $hp20['height'] = $hp['height'] * 2;
891 $thumb15 = $file->transform( $hp15 );
892 $thumb20 = $file->transform( $hp20 );
893 if ( $thumb15 && $thumb15->getUrl() !== $thumb->getUrl() ) {
894 $thumb->responsiveUrls
['1.5'] = $thumb15->getUrl();
896 if ( $thumb20 && $thumb20->getUrl() !== $thumb->getUrl() ) {
897 $thumb->responsiveUrls
['2'] = $thumb20->getUrl();
903 * Make a "broken" link to an image
905 * @param Title $title
906 * @param string $label Link label (plain text)
907 * @param string $query Query string
908 * @param string $unused1 Unused parameter kept for b/c
909 * @param string $unused2 Unused parameter kept for b/c
910 * @param bool $time A file of a certain timestamp was requested
913 public static function makeBrokenImageLinkObj( $title, $label = '', $query = '', $unused1 = '', $unused2 = '', $time = false ) {
914 global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
915 if ( ! $title instanceof Title
) {
916 return "<!-- ERROR -->" . htmlspecialchars( $label );
918 wfProfileIn( __METHOD__
);
919 if ( $label == '' ) {
920 $label = $title->getPrefixedText();
922 $encLabel = htmlspecialchars( $label );
923 $currentExists = $time ?
( wfFindFile( $title ) != false ) : false;
925 if ( ( $wgUploadMissingFileUrl ||
$wgUploadNavigationUrl ||
$wgEnableUploads ) && !$currentExists ) {
926 $redir = RepoGroup
::singleton()->getLocalRepo()->checkRedirect( $title );
929 wfProfileOut( __METHOD__
);
930 return self
::linkKnown( $title, $encLabel, array(), wfCgiToArray( $query ) );
933 $href = self
::getUploadUrl( $title, $query );
935 wfProfileOut( __METHOD__
);
936 return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
937 htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES
) . '">' .
941 wfProfileOut( __METHOD__
);
942 return self
::linkKnown( $title, $encLabel, array(), wfCgiToArray( $query ) );
946 * Get the URL to upload a certain file
948 * @param Title $destFile Title object of the file to upload
949 * @param string $query Urlencoded query string to prepend
950 * @return string Urlencoded URL
952 protected static function getUploadUrl( $destFile, $query = '' ) {
953 global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
954 $q = 'wpDestFile=' . $destFile->getPartialURL();
955 if ( $query != '' ) {
959 if ( $wgUploadMissingFileUrl ) {
960 return wfAppendQuery( $wgUploadMissingFileUrl, $q );
961 } elseif ( $wgUploadNavigationUrl ) {
962 return wfAppendQuery( $wgUploadNavigationUrl, $q );
964 $upload = SpecialPage
::getTitleFor( 'Upload' );
965 return $upload->getLocalURL( $q );
970 * Create a direct link to a given uploaded file.
972 * @param Title $title
973 * @param string $html Pre-sanitized HTML
974 * @param string $time MW timestamp of file creation time
975 * @return string HTML
977 public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
978 $img = wfFindFile( $title, array( 'time' => $time ) );
979 return self
::makeMediaLinkFile( $title, $img, $html );
983 * Create a direct link to a given uploaded file.
984 * This will make a broken link if $file is false.
986 * @param Title $title
987 * @param File|bool $file File object or false
988 * @param string $html Pre-sanitized HTML
989 * @return string HTML
991 * @todo Handle invalid or missing images better.
993 public static function makeMediaLinkFile( Title
$title, $file, $html = '' ) {
994 if ( $file && $file->exists() ) {
995 $url = $file->getURL();
998 $url = self
::getUploadUrl( $title );
1002 $alt = $title->getText();
1003 if ( $html == '' ) {
1014 if ( !wfRunHooks( 'LinkerMakeMediaLinkFile',
1015 array( $title, $file, &$html, &$attribs, &$ret ) ) ) {
1016 wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link with url {$url} and text {$html} to {$ret}\n", true );
1020 return Html
::rawElement( 'a', $attribs, $html );
1024 * Make a link to a special page given its name and, optionally,
1025 * a message key from the link text.
1026 * Usage example: Linker::specialLink( 'Recentchanges' )
1028 * @param string $name
1029 * @param string $key
1032 public static function specialLink( $name, $key = '' ) {
1034 $key = strtolower( $name );
1037 return self
::linkKnown( SpecialPage
::getTitleFor( $name ), wfMessage( $key )->text() );
1041 * Make an external link
1042 * @param string $url URL to link to
1043 * @param string $text Text of link
1044 * @param bool $escape Do we escape the link text?
1045 * @param string $linktype Type of external link. Gets added to the classes
1046 * @param array $attribs Array of extra attributes to <a>
1047 * @param Title|null $title Title object used for title specific link attributes
1050 public static function makeExternalLink( $url, $text, $escape = true, $linktype = '', $attribs = array(), $title = null ) {
1052 $class = "external";
1054 $class .= " $linktype";
1056 if ( isset( $attribs['class'] ) && $attribs['class'] ) {
1057 $class .= " {$attribs['class']}";
1059 $attribs['class'] = $class;
1062 $text = htmlspecialchars( $text );
1068 $attribs['rel'] = Parser
::getExternalLinkRel( $url, $title );
1070 $success = wfRunHooks( 'LinkerMakeExternalLink',
1071 array( &$url, &$text, &$link, &$attribs, $linktype ) );
1073 wfDebug( "Hook LinkerMakeExternalLink changed the output of link with url {$url} and text {$text} to {$link}\n", true );
1076 $attribs['href'] = $url;
1077 return Html
::rawElement( 'a', $attribs, $text );
1081 * Make user link (or user contributions for unregistered users)
1082 * @param int $userId User id in database.
1083 * @param string $userName User name in database.
1084 * @param string $altUserName Text to display instead of the user name (optional)
1085 * @return string HTML fragment
1086 * @since 1.19 Method exists for a long time. $altUserName was added in 1.19.
1088 public static function userLink( $userId, $userName, $altUserName = false ) {
1089 $classes = 'mw-userlink';
1090 if ( $userId == 0 ) {
1091 $page = SpecialPage
::getTitleFor( 'Contributions', $userName );
1092 if ( $altUserName === false ) {
1093 $altUserName = IP
::prettifyIP( $userName );
1095 $classes .= ' mw-anonuserlink'; // Separate link class for anons (bug 43179)
1097 $page = Title
::makeTitle( NS_USER
, $userName );
1102 htmlspecialchars( $altUserName !== false ?
$altUserName : $userName ),
1103 array( 'class' => $classes )
1108 * Generate standard user tool links (talk, contributions, block link, etc.)
1110 * @param int $userId User identifier
1111 * @param string $userText User name or IP address
1112 * @param bool $redContribsWhenNoEdits Should the contributions link be
1113 * red if the user has no edits?
1114 * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK and Linker::TOOL_LINKS_EMAIL)
1115 * @param int $edits User edit count (optional, for performance)
1116 * @return string HTML fragment
1118 public static function userToolLinks(
1119 $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
1121 global $wgUser, $wgDisableAnonTalk, $wgLang;
1122 $talkable = !( $wgDisableAnonTalk && 0 == $userId );
1123 $blockable = !( $flags & self
::TOOL_LINKS_NOBLOCK
);
1124 $addEmailLink = $flags & self
::TOOL_LINKS_EMAIL
&& $userId;
1128 $items[] = self
::userTalkLink( $userId, $userText );
1131 // check if the user has an edit
1133 if ( $redContribsWhenNoEdits ) {
1134 if ( intval( $edits ) === 0 && $edits !== 0 ) {
1135 $user = User
::newFromId( $userId );
1136 $edits = $user->getEditCount();
1138 if ( $edits === 0 ) {
1139 $attribs['class'] = 'new';
1142 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $userText );
1144 $items[] = self
::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
1146 if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
1147 $items[] = self
::blockLink( $userId, $userText );
1150 if ( $addEmailLink && $wgUser->canSendEmail() ) {
1151 $items[] = self
::emailLink( $userId, $userText );
1154 wfRunHooks( 'UserToolLinksEdit', array( $userId, $userText, &$items ) );
1157 return wfMessage( 'word-separator' )->plain()
1158 . '<span class="mw-usertoollinks">'
1159 . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
1167 * Alias for userToolLinks( $userId, $userText, true );
1168 * @param int $userId User identifier
1169 * @param string $userText User name or IP address
1170 * @param int $edits User edit count (optional, for performance)
1173 public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
1174 return self
::userToolLinks( $userId, $userText, true, 0, $edits );
1178 * @param int $userId User id in database.
1179 * @param string $userText User name in database.
1180 * @return string HTML fragment with user talk link
1182 public static function userTalkLink( $userId, $userText ) {
1183 $userTalkPage = Title
::makeTitle( NS_USER_TALK
, $userText );
1184 $userTalkLink = self
::link( $userTalkPage, wfMessage( 'talkpagelinktext' )->escaped() );
1185 return $userTalkLink;
1189 * @param int $userId Userid
1190 * @param string $userText User name in database.
1191 * @return string HTML fragment with block link
1193 public static function blockLink( $userId, $userText ) {
1194 $blockPage = SpecialPage
::getTitleFor( 'Block', $userText );
1195 $blockLink = self
::link( $blockPage, wfMessage( 'blocklink' )->escaped() );
1200 * @param int $userId Userid
1201 * @param string $userText User name in database.
1202 * @return string HTML fragment with e-mail user link
1204 public static function emailLink( $userId, $userText ) {
1205 $emailPage = SpecialPage
::getTitleFor( 'Emailuser', $userText );
1206 $emailLink = self
::link( $emailPage, wfMessage( 'emaillink' )->escaped() );
1211 * Generate a user link if the current user is allowed to view it
1212 * @param Revision $rev
1213 * @param bool $isPublic Show only if all users can see it
1214 * @return string HTML fragment
1216 public static function revUserLink( $rev, $isPublic = false ) {
1217 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1218 $link = wfMessage( 'rev-deleted-user' )->escaped();
1219 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1220 $link = self
::userLink( $rev->getUser( Revision
::FOR_THIS_USER
),
1221 $rev->getUserText( Revision
::FOR_THIS_USER
) );
1223 $link = wfMessage( 'rev-deleted-user' )->escaped();
1225 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1226 return '<span class="history-deleted">' . $link . '</span>';
1232 * Generate a user tool link cluster if the current user is allowed to view it
1233 * @param Revision $rev
1234 * @param bool $isPublic Show only if all users can see it
1235 * @return string HTML
1237 public static function revUserTools( $rev, $isPublic = false ) {
1238 if ( $rev->isDeleted( Revision
::DELETED_USER
) && $isPublic ) {
1239 $link = wfMessage( 'rev-deleted-user' )->escaped();
1240 } elseif ( $rev->userCan( Revision
::DELETED_USER
) ) {
1241 $userId = $rev->getUser( Revision
::FOR_THIS_USER
);
1242 $userText = $rev->getUserText( Revision
::FOR_THIS_USER
);
1243 $link = self
::userLink( $userId, $userText )
1244 . wfMessage( 'word-separator' )->plain()
1245 . self
::userToolLinks( $userId, $userText );
1247 $link = wfMessage( 'rev-deleted-user' )->escaped();
1249 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
1250 return ' <span class="history-deleted">' . $link . '</span>';
1256 * This function is called by all recent changes variants, by the page history,
1257 * and by the user contributions list. It is responsible for formatting edit
1258 * summaries. It escapes any HTML in the summary, but adds some CSS to format
1259 * auto-generated comments (from section editing) and formats [[wikilinks]].
1261 * @author Erik Moeller <moeller@scireview.de>
1263 * Note: there's not always a title to pass to this function.
1264 * Since you can't set a default parameter for a reference, I've turned it
1265 * temporarily to a value pass. Should be adjusted further. --brion
1267 * @param string $comment
1268 * @param Title|null $title Title object (to generate link to the section in autocomment) or null
1269 * @param bool $local Whether section links should refer to local page
1270 * @return mixed|string
1272 public static function formatComment( $comment, $title = null, $local = false ) {
1273 wfProfileIn( __METHOD__
);
1275 # Sanitize text a bit:
1276 $comment = str_replace( "\n", " ", $comment );
1277 # Allow HTML entities (for bug 13815)
1278 $comment = Sanitizer
::escapeHtmlAllowEntities( $comment );
1280 # Render autocomments and make links:
1281 $comment = self
::formatAutocomments( $comment, $title, $local );
1282 $comment = self
::formatLinksInComment( $comment, $title, $local );
1284 wfProfileOut( __METHOD__
);
1291 static $autocommentTitle;
1292 static $autocommentLocal;
1295 * Converts autogenerated comments in edit summaries into section links.
1296 * The pattern for autogen comments is / * foo * /, which makes for
1298 * We look for all comments, match any text before and after the comment,
1299 * add a separator where needed and format the comment itself with CSS
1300 * Called by Linker::formatComment.
1302 * @param string $comment Comment text
1303 * @param Title|null $title An optional title object used to links to sections
1304 * @param bool $local Whether section links should refer to local page
1305 * @return string Formatted comment
1307 private static function formatAutocomments( $comment, $title = null, $local = false ) {
1309 self
::$autocommentTitle = $title;
1310 self
::$autocommentLocal = $local;
1311 $comment = preg_replace_callback(
1312 '!(.*)/\*\s*(.*?)\s*\*/(.*)!',
1313 array( 'Linker', 'formatAutocommentsCallback' ),
1315 self
::$autocommentTitle = null;
1316 self
::$autocommentLocal = null;
1321 * Helper function for Linker::formatAutocomments
1322 * @param array $match
1325 private static function formatAutocommentsCallback( $match ) {
1327 $title = self
::$autocommentTitle;
1328 $local = self
::$autocommentLocal;
1334 wfRunHooks( 'FormatAutocomments', array( &$comment, $pre, $auto, $post, $title, $local ) );
1335 if ( $comment === null ) {
1340 # Remove links that a user may have manually put in the autosummary
1341 # This could be improved by copying as much of Parser::stripSectionName as desired.
1342 $section = str_replace( '[[:', '', $section );
1343 $section = str_replace( '[[', '', $section );
1344 $section = str_replace( ']]', '', $section );
1346 $section = Sanitizer
::normalizeSectionNameWhitespace( $section ); # bug 22784
1348 $sectionTitle = Title
::newFromText( '#' . $section );
1350 $sectionTitle = Title
::makeTitleSafe( $title->getNamespace(),
1351 $title->getDBkey(), $section );
1353 if ( $sectionTitle ) {
1354 $link = self
::link( $sectionTitle,
1355 $wgLang->getArrow(), array(), array(),
1362 # written summary $presep autocomment (summary /* section */)
1363 $pre .= wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
1366 # autocomment $postsep written summary (/* section */ summary)
1367 $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
1369 $auto = '<span class="autocomment">' . $auto . '</span>';
1370 $comment = $pre . $link . $wgLang->getDirMark() . '<span dir="auto">' . $auto . $post . '</span>';
1378 static $commentContextTitle;
1379 static $commentLocal;
1382 * Formats wiki links and media links in text; all other wiki formatting
1385 * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
1386 * @param string $comment Text to format links in
1387 * @param Title|null $title An optional title object used to links to sections
1388 * @param bool $local Whether section links should refer to local page
1391 public static function formatLinksInComment( $comment, $title = null, $local = false ) {
1392 self
::$commentContextTitle = $title;
1393 self
::$commentLocal = $local;
1394 $html = preg_replace_callback(
1397 :? # ignore optional leading colon
1398 ([^\]|]+) # 1. link target; page names cannot include ] or |
1400 # 2. a pipe-separated substring; only the last is captured
1401 # Stop matching at | and ]] without relying on backtracking.
1405 ([^[]*) # 3. link trail (the text up until the next link)
1407 array( 'Linker', 'formatLinksInCommentCallback' ),
1409 self
::$commentContextTitle = null;
1410 self
::$commentLocal = null;
1415 * @param array $match
1418 protected static function formatLinksInCommentCallback( $match ) {
1421 $medians = '(?:' . preg_quote( MWNamespace
::getCanonicalName( NS_MEDIA
), '/' ) . '|';
1422 $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA
), '/' ) . '):';
1424 $comment = $match[0];
1426 # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
1427 if ( strpos( $match[1], '%' ) !== false ) {
1428 $match[1] = str_replace( array( '<', '>' ), array( '<', '>' ), rawurldecode( $match[1] ) );
1431 # Handle link renaming [[foo|text]] will show link as "text"
1432 if ( $match[2] != "" ) {
1437 $submatch = array();
1439 if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
1440 # Media link; trail not supported.
1441 $linkRegexp = '/\[\[(.*?)\]\]/';
1442 $title = Title
::makeTitleSafe( NS_FILE
, $submatch[1] );
1444 $thelink = self
::makeMediaLinkObj( $title, $text );
1447 # Other kind of link
1448 if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
1449 $trail = $submatch[1];
1453 $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
1454 if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
1455 $match[1] = substr( $match[1], 1 );
1457 list( $inside, $trail ) = self
::splitTrail( $trail );
1460 $linkTarget = self
::normalizeSubpageLink( self
::$commentContextTitle,
1461 $match[1], $linkText );
1463 $target = Title
::newFromText( $linkTarget );
1465 if ( $target->getText() == '' && !$target->isExternal()
1466 && !self
::$commentLocal && self
::$commentContextTitle
1468 $newTarget = clone ( self
::$commentContextTitle );
1469 $newTarget->setFragment( '#' . $target->getFragment() );
1470 $target = $newTarget;
1472 $thelink = self
::link(
1479 // If the link is still valid, go ahead and replace it in!
1480 $comment = preg_replace( $linkRegexp, StringUtils
::escapeRegexReplacement( $thelink ), $comment, 1 );
1487 * @param Title $contextTitle
1488 * @param string $target
1489 * @param string $text
1492 public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
1495 # :Foobar -- override special treatment of prefix (images, language links)
1496 # /Foobar -- convert to CurrentPage/Foobar
1497 # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial / from text
1498 # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
1499 # ../Foobar -- convert to CurrentPage/Foobar, from CurrentPage/CurrentSubPage
1501 wfProfileIn( __METHOD__
);
1502 $ret = $target; # default return value is no change
1504 # Some namespaces don't allow subpages,
1505 # so only perform processing if subpages are allowed
1506 if ( $contextTitle && MWNamespace
::hasSubpages( $contextTitle->getNamespace() ) ) {
1507 $hash = strpos( $target, '#' );
1508 if ( $hash !== false ) {
1509 $suffix = substr( $target, $hash );
1510 $target = substr( $target, 0, $hash );
1515 $target = trim( $target );
1516 # Look at the first character
1517 if ( $target != '' && $target[0] === '/' ) {
1518 # / at end means we don't want the slash to be shown
1520 $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
1521 if ( $trailingSlashes ) {
1522 $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
1524 $noslash = substr( $target, 1 );
1527 $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
1528 if ( $text === '' ) {
1529 $text = $target . $suffix;
1530 } # this might be changed for ugliness reasons
1532 # check for .. subpage backlinks
1534 $nodotdot = $target;
1535 while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
1537 $nodotdot = substr( $nodotdot, 3 );
1539 if ( $dotdotcount > 0 ) {
1540 $exploded = explode( '/', $contextTitle->getPrefixedText() );
1541 if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
1542 $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
1543 # / at the end means don't show full path
1544 if ( substr( $nodotdot, -1, 1 ) === '/' ) {
1545 $nodotdot = substr( $nodotdot, 0, -1 );
1546 if ( $text === '' ) {
1547 $text = $nodotdot . $suffix;
1550 $nodotdot = trim( $nodotdot );
1551 if ( $nodotdot != '' ) {
1552 $ret .= '/' . $nodotdot;
1560 wfProfileOut( __METHOD__
);
1565 * Wrap a comment in standard punctuation and formatting if
1566 * it's non-empty, otherwise return empty string.
1568 * @param string $comment
1569 * @param Title|null $title Title object (to generate link to section in autocomment) or null
1570 * @param bool $local Whether section links should refer to local page
1574 public static function commentBlock( $comment, $title = null, $local = false ) {
1575 // '*' used to be the comment inserted by the software way back
1576 // in antiquity in case none was provided, here for backwards
1577 // compatibility, acc. to brion -ævar
1578 if ( $comment == '' ||
$comment == '*' ) {
1581 $formatted = self
::formatComment( $comment, $title, $local );
1582 $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
1583 return " <span class=\"comment\">$formatted</span>";
1588 * Wrap and format the given revision's comment block, if the current
1589 * user is allowed to view it.
1591 * @param Revision $rev
1592 * @param bool $local Whether section links should refer to local page
1593 * @param bool $isPublic Show only if all users can see it
1594 * @return string HTML fragment
1596 public static function revComment( Revision
$rev, $local = false, $isPublic = false ) {
1597 if ( $rev->getRawComment() == "" ) {
1600 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) && $isPublic ) {
1601 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1602 } elseif ( $rev->userCan( Revision
::DELETED_COMMENT
) ) {
1603 $block = self
::commentBlock( $rev->getComment( Revision
::FOR_THIS_USER
),
1604 $rev->getTitle(), $local );
1606 $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
1608 if ( $rev->isDeleted( Revision
::DELETED_COMMENT
) ) {
1609 return " <span class=\"history-deleted\">$block</span>";
1618 public static function formatRevisionSize( $size ) {
1620 $stxt = wfMessage( 'historyempty' )->escaped();
1622 $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
1623 $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
1625 return "<span class=\"history-size\">$stxt</span>";
1629 * Add another level to the Table of Contents
1633 public static function tocIndent() {
1638 * Finish one or more sublevels on the Table of Contents
1643 public static function tocUnindent( $level ) {
1644 return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ?
$level : 0 );
1648 * parameter level defines if we are on an indentation level
1650 * @param string $anchor
1651 * @param string $tocline
1652 * @param string $tocnumber
1653 * @param string $level
1654 * @param string|bool $sectionIndex
1657 public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
1658 $classes = "toclevel-$level";
1659 if ( $sectionIndex !== false ) {
1660 $classes .= " tocsection-$sectionIndex";
1662 return "\n<li class=\"$classes\"><a href=\"#" .
1663 $anchor . '"><span class="tocnumber">' .
1664 $tocnumber . '</span> <span class="toctext">' .
1665 $tocline . '</span></a>';
1669 * End a Table Of Contents line.
1670 * tocUnindent() will be used instead if we're ending a line below
1674 public static function tocLineEnd() {
1679 * Wraps the TOC in a table and provides the hide/collapse javascript.
1681 * @param string $toc Html of the Table Of Contents
1682 * @param string|Language|bool $lang Language for the toc title, defaults to user language
1683 * @return string Full html of the TOC
1685 public static function tocList( $toc, $lang = false ) {
1686 $lang = wfGetLangObj( $lang );
1687 $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();
1689 return '<div id="toc" class="toc">'
1690 . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
1692 . "</ul>\n</div>\n";
1696 * Generate a table of contents from a section tree
1699 * @param array $tree Return value of ParserOutput::getSections()
1700 * @return string HTML fragment
1702 public static function generateTOC( $tree ) {
1705 foreach ( $tree as $section ) {
1706 if ( $section['toclevel'] > $lastLevel ) {
1707 $toc .= self
::tocIndent();
1708 } elseif ( $section['toclevel'] < $lastLevel ) {
1709 $toc .= self
::tocUnindent(
1710 $lastLevel - $section['toclevel'] );
1712 $toc .= self
::tocLineEnd();
1715 $toc .= self
::tocLine( $section['anchor'],
1716 $section['line'], $section['number'],
1717 $section['toclevel'], $section['index'] );
1718 $lastLevel = $section['toclevel'];
1720 $toc .= self
::tocLineEnd();
1721 return self
::tocList( $toc );
1725 * Create a headline for content
1727 * @param int $level The level of the headline (1-6)
1728 * @param string $attribs Any attributes for the headline, starting with
1729 * a space and ending with '>'
1730 * This *must* be at least '>' for no attribs
1731 * @param string $anchor The anchor to give the headline (the bit after the #)
1732 * @param string $html Html for the text of the header
1733 * @param string $link HTML to add for the section edit link
1734 * @param bool|string $legacyAnchor A second, optional anchor to give for
1735 * backward compatibility (false to omit)
1737 * @return string HTML headline
1739 public static function makeHeadline( $level, $attribs, $anchor, $html, $link, $legacyAnchor = false ) {
1740 $ret = "<h$level$attribs"
1741 . "<span class=\"mw-headline\" id=\"$anchor\">$html</span>"
1744 if ( $legacyAnchor !== false ) {
1745 $ret = "<div id=\"$legacyAnchor\"></div>$ret";
1751 * Split a link trail, return the "inside" portion and the remainder of the trail
1752 * as a two-element array
1753 * @param string $trail
1756 static function splitTrail( $trail ) {
1758 $regex = $wgContLang->linkTrail();
1760 if ( $trail !== '' ) {
1762 if ( preg_match( $regex, $trail, $m ) ) {
1767 return array( $inside, $trail );
1771 * Generate a rollback link for a given revision. Currently it's the
1772 * caller's responsibility to ensure that the revision is the top one. If
1773 * it's not, of course, the user will get an error message.
1775 * If the calling page is called with the parameter &bot=1, all rollback
1776 * links also get that parameter. It causes the edit itself and the rollback
1777 * to be marked as "bot" edits. Bot edits are hidden by default from recent
1778 * changes, so this allows sysops to combat a busy vandal without bothering
1781 * If the option verify is set this function will return the link only in case the
1782 * revision can be reverted. Please note that due to performance limitations
1783 * it might be assumed that a user isn't the only contributor of a page while
1784 * (s)he is, which will lead to useless rollback links. Furthermore this wont
1785 * work if $wgShowRollbackEditCount is disabled, so this can only function
1786 * as an additional check.
1788 * If the option noBrackets is set the rollback link wont be enclosed in []
1790 * @param Revision $rev
1791 * @param IContextSource $context Context to use or null for the main context.
1792 * @param array $options
1795 public static function generateRollback( $rev, IContextSource
$context = null, $options = array( 'verify' ) ) {
1796 if ( $context === null ) {
1797 $context = RequestContext
::getMain();
1800 if ( in_array( 'verify', $options ) ) {
1801 $editCount = self
::getRollbackEditCount( $rev, true );
1802 if ( $editCount === false ) {
1807 $inner = self
::buildRollbackLink( $rev, $context, $editCount );
1809 if ( !in_array( 'noBrackets', $options ) ) {
1810 $inner = $context->msg( 'brackets' )->rawParams( $inner )->plain();
1813 return '<span class="mw-rollback-link">' . $inner . '</span>';
1817 * This function will return the number of revisions which a rollback
1818 * would revert and, if $verify is set it will verify that a revision
1819 * can be reverted (that the user isn't the only contributor and the
1820 * revision we might rollback to isn't deleted). These checks can only
1821 * function as an additional check as this function only checks against
1822 * the last $wgShowRollbackEditCount edits.
1824 * Returns null if $wgShowRollbackEditCount is disabled or false if $verify
1825 * is set and the user is the only contributor of the page.
1827 * @param Revision $rev
1828 * @param bool $verify Try to verify that this revision can really be rolled back
1829 * @return int|bool|null
1831 public static function getRollbackEditCount( $rev, $verify ) {
1832 global $wgShowRollbackEditCount;
1833 if ( !is_int( $wgShowRollbackEditCount ) ||
!$wgShowRollbackEditCount > 0 ) {
1834 // Nothing has happened, indicate this by returning 'null'
1838 $dbr = wfGetDB( DB_SLAVE
);
1840 // Up to the value of $wgShowRollbackEditCount revisions are counted
1841 $res = $dbr->select(
1843 array( 'rev_user_text', 'rev_deleted' ),
1844 // $rev->getPage() returns null sometimes
1845 array( 'rev_page' => $rev->getTitle()->getArticleID() ),
1848 'USE INDEX' => array( 'revision' => 'page_timestamp' ),
1849 'ORDER BY' => 'rev_timestamp DESC',
1850 'LIMIT' => $wgShowRollbackEditCount +
1
1856 foreach ( $res as $row ) {
1857 if ( $rev->getRawUserText() != $row->rev_user_text
) {
1858 if ( $verify && ( $row->rev_deleted
& Revision
::DELETED_TEXT ||
$row->rev_deleted
& Revision
::DELETED_USER
) ) {
1859 // If the user or the text of the revision we might rollback to is deleted in some way we can't rollback
1860 // Similar to the sanity checks in WikiPage::commitRollback
1869 if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
1870 // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
1871 // and there weren't any other revisions. That means that the current user is the only
1872 // editor, so we can't rollback
1879 * Build a raw rollback link, useful for collections of "tool" links
1881 * @param Revision $rev
1882 * @param IContextSource|null $context Context to use or null for the main context.
1883 * @param int $editCount Number of edits that would be reverted
1884 * @return string HTML fragment
1886 public static function buildRollbackLink( $rev, IContextSource
$context = null, $editCount = false ) {
1887 global $wgShowRollbackEditCount, $wgMiserMode;
1889 // To config which pages are effected by miser mode
1890 $disableRollbackEditCountSpecialPage = array( 'Recentchanges', 'Watchlist' );
1892 if ( $context === null ) {
1893 $context = RequestContext
::getMain();
1896 $title = $rev->getTitle();
1898 'action' => 'rollback',
1899 'from' => $rev->getUserText(),
1900 'token' => $context->getUser()->getEditToken( array( $title->getPrefixedText(), $rev->getUserText() ) ),
1902 if ( $context->getRequest()->getBool( 'bot' ) ) {
1903 $query['bot'] = '1';
1904 $query['hidediff'] = '1'; // bug 15999
1907 $disableRollbackEditCount = false;
1908 if ( $wgMiserMode ) {
1909 foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
1910 if ( $context->getTitle()->isSpecial( $specialPage ) ) {
1911 $disableRollbackEditCount = true;
1917 if ( !$disableRollbackEditCount && is_int( $wgShowRollbackEditCount ) && $wgShowRollbackEditCount > 0 ) {
1918 if ( !is_numeric( $editCount ) ) {
1919 $editCount = self
::getRollbackEditCount( $rev, false );
1922 if ( $editCount > $wgShowRollbackEditCount ) {
1923 $editCount_output = $context->msg( 'rollbacklinkcount-morethan' )->numParams( $wgShowRollbackEditCount )->parse();
1925 $editCount_output = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
1931 array( 'title' => $context->msg( 'tooltip-rollback' )->text() ),
1933 array( 'known', 'noclasses' )
1938 $context->msg( 'rollbacklink' )->escaped(),
1939 array( 'title' => $context->msg( 'tooltip-rollback' )->text() ),
1941 array( 'known', 'noclasses' )
1947 * Returns HTML for the "templates used on this page" list.
1949 * Make an HTML list of templates, and then add a "More..." link at
1950 * the bottom. If $more is null, do not add a "More..." link. If $more
1951 * is a Title, make a link to that title and use it. If $more is a string,
1952 * directly paste it in as the link (escaping needs to be done manually).
1953 * Finally, if $more is a Message, call toString().
1955 * @param array $templates Array of templates from Article::getUsedTemplate or similar
1956 * @param bool $preview Whether this is for a preview
1957 * @param bool $section Whether this is for a section edit
1958 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
1959 * @return string HTML output
1961 public static function formatTemplates( $templates, $preview = false, $section = false, $more = null ) {
1963 wfProfileIn( __METHOD__
);
1966 if ( count( $templates ) > 0 ) {
1967 # Do a batch existence check
1968 $batch = new LinkBatch
;
1969 foreach ( $templates as $title ) {
1970 $batch->addObj( $title );
1974 # Construct the HTML
1975 $outText = '<div class="mw-templatesUsedExplanation">';
1977 $outText .= wfMessage( 'templatesusedpreview' )->numParams( count( $templates ) )
1979 } elseif ( $section ) {
1980 $outText .= wfMessage( 'templatesusedsection' )->numParams( count( $templates ) )
1983 $outText .= wfMessage( 'templatesused' )->numParams( count( $templates ) )
1986 $outText .= "</div><ul>\n";
1988 usort( $templates, 'Title::compare' );
1989 foreach ( $templates as $titleObj ) {
1991 $restrictions = $titleObj->getRestrictions( 'edit' );
1992 if ( $restrictions ) {
1993 // Check backwards-compatible messages
1995 if ( $restrictions === array( 'sysop' ) ) {
1996 $msg = wfMessage( 'template-protected' );
1997 } elseif ( $restrictions === array( 'autoconfirmed' ) ) {
1998 $msg = wfMessage( 'template-semiprotected' );
2000 if ( $msg && !$msg->isDisabled() ) {
2001 $protected = $msg->parse();
2003 // Construct the message from restriction-level-*
2004 // e.g. restriction-level-sysop, restriction-level-autoconfirmed
2006 foreach ( $restrictions as $r ) {
2007 $msgs[] = wfMessage( "restriction-level-$r" )->parse();
2009 $protected = wfMessage( 'parentheses' )
2010 ->rawParams( $wgLang->commaList( $msgs ) )->escaped();
2013 if ( $titleObj->quickUserCan( 'edit' ) ) {
2014 $editLink = self
::link(
2016 wfMessage( 'editlink' )->text(),
2018 array( 'action' => 'edit' )
2021 $editLink = self
::link(
2023 wfMessage( 'viewsourcelink' )->text(),
2025 array( 'action' => 'edit' )
2028 $outText .= '<li>' . self
::link( $titleObj )
2029 . wfMessage( 'word-separator' )->escaped()
2030 . wfMessage( 'parentheses' )->rawParams( $editLink )->escaped()
2031 . wfMessage( 'word-separator' )->escaped()
2032 . $protected . '</li>';
2035 if ( $more instanceof Title
) {
2036 $outText .= '<li>' . self
::link( $more, wfMessage( 'moredotdotdot' ) ) . '</li>';
2037 } elseif ( $more ) {
2038 $outText .= "<li>$more</li>";
2041 $outText .= '</ul>';
2043 wfProfileOut( __METHOD__
);
2048 * Returns HTML for the "hidden categories on this page" list.
2050 * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories
2052 * @return string HTML output
2054 public static function formatHiddenCategories( $hiddencats ) {
2055 wfProfileIn( __METHOD__
);
2058 if ( count( $hiddencats ) > 0 ) {
2059 # Construct the HTML
2060 $outText = '<div class="mw-hiddenCategoriesExplanation">';
2061 $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
2062 $outText .= "</div><ul>\n";
2064 foreach ( $hiddencats as $titleObj ) {
2065 $outText .= '<li>' . self
::link( $titleObj, null, array(), array(), 'known' ) . "</li>\n"; # If it's hidden, it must exist - no need to check with a LinkBatch
2067 $outText .= '</ul>';
2069 wfProfileOut( __METHOD__
);
2074 * Format a size in bytes for output, using an appropriate
2075 * unit (B, KB, MB or GB) according to the magnitude in question
2077 * @param int $size Size to format
2080 public static function formatSize( $size ) {
2082 return htmlspecialchars( $wgLang->formatSize( $size ) );
2086 * Given the id of an interface element, constructs the appropriate title
2087 * attribute from the system messages. (Note, this is usually the id but
2088 * isn't always, because sometimes the accesskey needs to go on a different
2089 * element than the id, for reverse-compatibility, etc.)
2091 * @param string $name Id of the element, minus prefixes.
2092 * @param string|null $options Null or the string 'withaccess' to add an access-
2094 * @return string Contents of the title attribute (which you must HTML-
2095 * escape), or false for no title attribute
2097 public static function titleAttrib( $name, $options = null ) {
2098 wfProfileIn( __METHOD__
);
2100 $message = wfMessage( "tooltip-$name" );
2102 if ( !$message->exists() ) {
2105 $tooltip = $message->text();
2106 # Compatibility: formerly some tooltips had [alt-.] hardcoded
2107 $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
2108 # Message equal to '-' means suppress it.
2109 if ( $tooltip == '-' ) {
2114 if ( $options == 'withaccess' ) {
2115 $accesskey = self
::accesskey( $name );
2116 if ( $accesskey !== false ) {
2117 if ( $tooltip === false ||
$tooltip === '' ) {
2118 $tooltip = wfMessage( 'brackets', $accesskey )->escaped();
2120 $tooltip .= wfMessage( 'word-separator' )->escaped();
2121 $tooltip .= wfMessage( 'brackets', $accesskey )->escaped();
2126 wfProfileOut( __METHOD__
);
2130 static $accesskeycache;
2133 * Given the id of an interface element, constructs the appropriate
2134 * accesskey attribute from the system messages. (Note, this is usually
2135 * the id but isn't always, because sometimes the accesskey needs to go on
2136 * a different element than the id, for reverse-compatibility, etc.)
2138 * @param string $name Id of the element, minus prefixes.
2139 * @return string Contents of the accesskey attribute (which you must HTML-
2140 * escape), or false for no accesskey attribute
2142 public static function accesskey( $name ) {
2143 if ( isset( self
::$accesskeycache[$name] ) ) {
2144 return self
::$accesskeycache[$name];
2146 wfProfileIn( __METHOD__
);
2148 $message = wfMessage( "accesskey-$name" );
2150 if ( !$message->exists() ) {
2153 $accesskey = $message->plain();
2154 if ( $accesskey === '' ||
$accesskey === '-' ) {
2155 # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
2156 # attribute, but this is broken for accesskey: that might be a useful
2162 wfProfileOut( __METHOD__
);
2163 self
::$accesskeycache[$name] = $accesskey;
2164 return self
::$accesskeycache[$name];
2168 * Get a revision-deletion link, or disabled link, or nothing, depending
2169 * on user permissions & the settings on the revision.
2171 * Will use forward-compatible revision ID in the Special:RevDelete link
2172 * if possible, otherwise the timestamp-based ID which may break after
2176 * @param Revision $rev
2177 * @param Revision $title
2178 * @return string HTML fragment
2180 public static function getRevDeleteLink( User
$user, Revision
$rev, Title
$title ) {
2181 $canHide = $user->isAllowed( 'deleterevision' );
2182 if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
2186 if ( !$rev->userCan( Revision
::DELETED_RESTRICTED
, $user ) ) {
2187 return Linker
::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
2189 if ( $rev->getId() ) {
2190 // RevDelete links using revision ID are stable across
2191 // page deletion and undeletion; use when possible.
2193 'type' => 'revision',
2194 'target' => $title->getPrefixedDBkey(),
2195 'ids' => $rev->getId()
2198 // Older deleted entries didn't save a revision ID.
2199 // We have to refer to these by timestamp, ick!
2201 'type' => 'archive',
2202 'target' => $title->getPrefixedDBkey(),
2203 'ids' => $rev->getTimestamp()
2206 return Linker
::revDeleteLink( $query,
2207 $rev->isDeleted( Revision
::DELETED_RESTRICTED
), $canHide );
2212 * Creates a (show/hide) link for deleting revisions/log entries
2214 * @param array $query Query parameters to be passed to link()
2215 * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>"
2216 * @param bool $delete Set to true to use (show/hide) rather than (show)
2218 * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a
2219 * span to allow for customization of appearance with CSS
2221 public static function revDeleteLink( $query = array(), $restricted = false, $delete = true ) {
2222 $sp = SpecialPage
::getTitleFor( 'Revisiondelete' );
2223 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2224 $html = wfMessage( $msgKey )->escaped();
2225 $tag = $restricted ?
'strong' : 'span';
2226 $link = self
::link( $sp, $html, array(), $query, array( 'known', 'noclasses' ) );
2227 return Xml
::tags( $tag, array( 'class' => 'mw-revdelundel-link' ), wfMessage( 'parentheses' )->rawParams( $link )->escaped() );
2231 * Creates a dead (show/hide) link for deleting revisions/log entries
2233 * @param bool $delete Set to true to use (show/hide) rather than (show)
2235 * @return string HTML text wrapped in a span to allow for customization
2236 * of appearance with CSS
2238 public static function revDeleteLinkDisabled( $delete = true ) {
2239 $msgKey = $delete ?
'rev-delundel' : 'rev-showdeleted';
2240 $html = wfMessage( $msgKey )->escaped();
2241 $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
2242 return Xml
::tags( 'span', array( 'class' => 'mw-revdelundel-link' ), $htmlParentheses );
2245 /* Deprecated methods */
2248 * @deprecated since 1.16 Use link(); warnings since 1.21
2250 * Make a link for a title which may or may not be in the database. If you need to
2251 * call this lots of times, pre-fill the link cache with a LinkBatch, otherwise each
2252 * call to this will result in a DB query.
2254 * @param Title $nt The title object to make the link from, e.g. from Title::newFromText.
2255 * @param string $text Link text
2256 * @param string $query Optional query part
2257 * @param string $trail Optional trail. Alphabetic characters at the start of this string will
2258 * be included in the link text. Other characters will be appended after
2259 * the end of the link.
2260 * @param string $prefix Optional prefix. As trail, only before instead of after.
2263 static function makeLinkObj( $nt, $text = '', $query = '', $trail = '', $prefix = '' ) {
2264 wfDeprecated( __METHOD__
, '1.21' );
2266 wfProfileIn( __METHOD__
);
2267 $query = wfCgiToArray( $query );
2268 list( $inside, $trail ) = self
::splitTrail( $trail );
2269 if ( $text === '' ) {
2270 $text = self
::linkText( $nt );
2273 $ret = self
::link( $nt, "$prefix$text$inside", array(), $query ) . $trail;
2275 wfProfileOut( __METHOD__
);
2280 * @deprecated since 1.16 Use link(); warnings since 1.21
2282 * Make a link for a title which definitely exists. This is faster than makeLinkObj because
2283 * it doesn't have to do a database query. It's also valid for interwiki titles and special
2286 * @param Title $title Title object of target page
2287 * @param string $text Text to replace the title
2288 * @param string $query Link target
2289 * @param string $trail Text after link
2290 * @param string $prefix Text before link text
2291 * @param string $aprops Extra attributes to the a-element
2292 * @param string $style Style to apply - if empty, use getInternalLinkAttributesObj instead
2293 * @return string The a-element
2295 static function makeKnownLinkObj(
2296 $title, $text = '', $query = '', $trail = '', $prefix = '', $aprops = '', $style = ''
2298 wfDeprecated( __METHOD__
, '1.21' );
2300 wfProfileIn( __METHOD__
);
2302 if ( $text == '' ) {
2303 $text = self
::linkText( $title );
2305 $attribs = Sanitizer
::mergeAttributes(
2306 Sanitizer
::decodeTagAttributes( $aprops ),
2307 Sanitizer
::decodeTagAttributes( $style )
2309 $query = wfCgiToArray( $query );
2310 list( $inside, $trail ) = self
::splitTrail( $trail );
2312 $ret = self
::link( $title, "$prefix$text$inside", $attribs, $query,
2313 array( 'known', 'noclasses' ) ) . $trail;
2315 wfProfileOut( __METHOD__
);
2320 * Returns the attributes for the tooltip and access key.
2321 * @param string $name
2324 public static function tooltipAndAccesskeyAttribs( $name ) {
2325 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2326 # no attribute" instead of "output '' as value for attribute", this
2327 # would be three lines.
2329 'title' => self
::titleAttrib( $name, 'withaccess' ),
2330 'accesskey' => self
::accesskey( $name )
2332 if ( $attribs['title'] === false ) {
2333 unset( $attribs['title'] );
2335 if ( $attribs['accesskey'] === false ) {
2336 unset( $attribs['accesskey'] );
2342 * Returns raw bits of HTML, use titleAttrib()
2343 * @param string $name
2344 * @param array|null $options
2345 * @return null|string
2347 public static function tooltip( $name, $options = null ) {
2348 # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
2349 # no attribute" instead of "output '' as value for attribute", this
2350 # would be two lines.
2351 $tooltip = self
::titleAttrib( $name, $options );
2352 if ( $tooltip === false ) {
2355 return Xml
::expandAttributes( array(
2367 * Use PHP's magic __call handler to transform instance calls to a dummy instance
2368 * into static calls to the new Linker for backwards compatibility.
2370 * @param string $fname Name of called method
2371 * @param array $args Arguments to the method
2374 public function __call( $fname, $args ) {
2375 return call_user_func_array( array( 'Linker', $fname ), $args );