wikimedia /
mediawiki
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Linker often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Linker, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 33 | class Linker { |
||
| 34 | /** |
||
| 35 | * Flags for userToolLinks() |
||
| 36 | */ |
||
| 37 | const TOOL_LINKS_NOBLOCK = 1; |
||
| 38 | const TOOL_LINKS_EMAIL = 2; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Get the appropriate HTML attributes to add to the "a" element of an interwiki link. |
||
| 42 | * |
||
| 43 | * @since 1.16.3 |
||
| 44 | * @deprecated since 1.25 |
||
| 45 | * |
||
| 46 | * @param string $title The title text for the link, URL-encoded (???) but |
||
| 47 | * not HTML-escaped |
||
| 48 | * @param string $unused Unused |
||
| 49 | * @param string $class The contents of the class attribute; if an empty |
||
| 50 | * string is passed, which is the default value, defaults to 'external'. |
||
| 51 | * @return string |
||
| 52 | */ |
||
| 53 | static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) { |
||
| 66 | |||
| 67 | /** |
||
| 68 | * Get the appropriate HTML attributes to add to the "a" element of an internal link. |
||
| 69 | * |
||
| 70 | * @since 1.16.3 |
||
| 71 | * @deprecated since 1.25 |
||
| 72 | * |
||
| 73 | * @param string $title The title text for the link, URL-encoded (???) but |
||
| 74 | * not HTML-escaped |
||
| 75 | * @param string $unused Unused |
||
| 76 | * @param string $class The contents of the class attribute, default none |
||
| 77 | * @return string |
||
| 78 | */ |
||
| 79 | static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) { |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Get the appropriate HTML attributes to add to the "a" element of an internal |
||
| 89 | * link, given the Title object for the page we want to link to. |
||
| 90 | * |
||
| 91 | * @since 1.16.3 |
||
| 92 | * @deprecated since 1.25 |
||
| 93 | * |
||
| 94 | * @param Title $nt |
||
| 95 | * @param string $unused Unused |
||
| 96 | * @param string $class The contents of the class attribute, default none |
||
| 97 | * @param string|bool $title Optional (unescaped) string to use in the title |
||
| 98 | * attribute; if false, default to the name of the page we're linking to |
||
| 99 | * @return string |
||
| 100 | */ |
||
| 101 | static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) { |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Common code for getLinkAttributesX functions |
||
| 112 | * |
||
| 113 | * @since 1.16.3 |
||
| 114 | * @deprecated since 1.25 |
||
| 115 | * |
||
| 116 | * @param string $title |
||
| 117 | * @param string $class |
||
| 118 | * |
||
| 119 | * @return string |
||
| 120 | */ |
||
| 121 | private static function getLinkAttributesInternal( $title, $class ) { |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Return the CSS colour of a known link |
||
| 138 | * |
||
| 139 | * @since 1.16.3 |
||
| 140 | * @param Title $t |
||
| 141 | * @param int $threshold User defined threshold |
||
| 142 | * @return string CSS class |
||
| 143 | */ |
||
| 144 | public static function getLinkColour( $t, $threshold ) { |
||
| 157 | |||
| 158 | /** |
||
| 159 | * This function returns an HTML link to the given target. It serves a few |
||
| 160 | * purposes: |
||
| 161 | * 1) If $target is a Title, the correct URL to link to will be figured |
||
| 162 | * out automatically. |
||
| 163 | * 2) It automatically adds the usual classes for various types of link |
||
| 164 | * targets: "new" for red links, "stub" for short articles, etc. |
||
| 165 | * 3) It escapes all attribute values safely so there's no risk of XSS. |
||
| 166 | * 4) It provides a default tooltip if the target is a Title (the page |
||
| 167 | * name of the target). |
||
| 168 | * link() replaces the old functions in the makeLink() family. |
||
| 169 | * |
||
| 170 | * @since 1.18 Method exists since 1.16 as non-static, made static in 1.18. |
||
| 171 | * |
||
| 172 | * @param Title $target Can currently only be a Title, but this may |
||
| 173 | * change to support Images, literal URLs, etc. |
||
| 174 | * @param string $html The HTML contents of the <a> element, i.e., |
||
| 175 | * the link text. This is raw HTML and will not be escaped. If null, |
||
| 176 | * defaults to the prefixed text of the Title; or if the Title is just a |
||
| 177 | * fragment, the contents of the fragment. |
||
| 178 | * @param array $customAttribs A key => value array of extra HTML attributes, |
||
| 179 | * such as title and class. (href is ignored.) Classes will be |
||
| 180 | * merged with the default classes, while other attributes will replace |
||
| 181 | * default attributes. All passed attribute values will be HTML-escaped. |
||
| 182 | * A false attribute value means to suppress that attribute. |
||
| 183 | * @param array $query The query string to append to the URL |
||
| 184 | * you're linking to, in key => value array form. Query keys and values |
||
| 185 | * will be URL-encoded. |
||
| 186 | * @param string|array $options String or array of strings: |
||
| 187 | * 'known': Page is known to exist, so don't check if it does. |
||
| 188 | * 'broken': Page is known not to exist, so don't check if it does. |
||
| 189 | * 'noclasses': Don't add any classes automatically (includes "new", |
||
| 190 | * "stub", "mw-redirect", "extiw"). Only use the class attribute |
||
| 191 | * provided, if any, so you get a simple blue link with no funny i- |
||
| 192 | * cons. |
||
| 193 | * 'forcearticlepath': Use the article path always, even with a querystring. |
||
| 194 | * Has compatibility issues on some setups, so avoid wherever possible. |
||
| 195 | * 'http': Force a full URL with http:// as the scheme. |
||
| 196 | * 'https': Force a full URL with https:// as the scheme. |
||
| 197 | * 'stubThreshold' => (int): Stub threshold to use when determining link classes. |
||
| 198 | * @return string HTML <a> attribute |
||
| 199 | */ |
||
| 200 | public static function link( |
||
| 263 | |||
| 264 | /** |
||
| 265 | * Identical to link(), except $options defaults to 'known'. |
||
| 266 | * @since 1.16.3 |
||
| 267 | * @see Linker::link |
||
| 268 | * @return string |
||
| 269 | */ |
||
| 270 | public static function linkKnown( |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Returns the Url used to link to a Title |
||
| 279 | * |
||
| 280 | * @param LinkTarget $target |
||
| 281 | * @param array $query Query parameters |
||
| 282 | * @param array $options |
||
| 283 | * @return string |
||
| 284 | */ |
||
| 285 | private static function linkUrl( LinkTarget $target, $query, $options ) { |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Returns the array of attributes used when linking to the Title $target |
||
| 316 | * |
||
| 317 | * @param Title $target |
||
| 318 | * @param array $attribs |
||
| 319 | * @param array $options |
||
| 320 | * |
||
| 321 | * @return array |
||
| 322 | */ |
||
| 323 | private static function linkAttribs( $target, $attribs, $options ) { |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Default text of the links to the Title $target |
||
| 382 | * |
||
| 383 | * @param Title $target |
||
| 384 | * |
||
| 385 | * @return string |
||
| 386 | */ |
||
| 387 | private static function linkText( $target ) { |
||
| 400 | |||
| 401 | /** |
||
| 402 | * Make appropriate markup for a link to the current article. This is |
||
| 403 | * currently rendered as the bold link text. The calling sequence is the |
||
| 404 | * same as the other make*LinkObj static functions, despite $query not |
||
| 405 | * being used. |
||
| 406 | * |
||
| 407 | * @since 1.16.3 |
||
| 408 | * @param Title $nt |
||
| 409 | * @param string $html [optional] |
||
| 410 | * @param string $query [optional] |
||
| 411 | * @param string $trail [optional] |
||
| 412 | * @param string $prefix [optional] |
||
| 413 | * |
||
| 414 | * @return string |
||
| 415 | */ |
||
| 416 | public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) { |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Get a message saying that an invalid title was encountered. |
||
| 431 | * This should be called after a method like Title::makeTitleSafe() returned |
||
| 432 | * a value indicating that the title object is invalid. |
||
| 433 | * |
||
| 434 | * @param IContextSource $context Context to use to get the messages |
||
| 435 | * @param int $namespace Namespace number |
||
| 436 | * @param string $title Text of the title, without the namespace part |
||
| 437 | * @return string |
||
| 438 | */ |
||
| 439 | public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) { |
||
| 440 | global $wgContLang; |
||
| 441 | |||
| 442 | // First we check whether the namespace exists or not. |
||
| 443 | if ( MWNamespace::exists( $namespace ) ) { |
||
| 444 | if ( $namespace == NS_MAIN ) { |
||
| 445 | $name = $context->msg( 'blanknamespace' )->text(); |
||
| 446 | } else { |
||
| 447 | $name = $wgContLang->getFormattedNsText( $namespace ); |
||
| 448 | } |
||
| 449 | return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text(); |
||
| 450 | } else { |
||
| 451 | return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text(); |
||
| 452 | } |
||
| 453 | } |
||
| 454 | |||
| 455 | /** |
||
| 456 | * @since 1.16.3 |
||
| 457 | * @param LinkTarget $target |
||
| 458 | * @return LinkTarget|Title You will get back the same type you passed in, or a Title object |
||
| 459 | */ |
||
| 460 | public static function normaliseSpecialPage( LinkTarget $target ) { |
||
| 461 | if ( $target->getNamespace() == NS_SPECIAL ) { |
||
| 462 | list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $target->getDBkey() ); |
||
| 463 | if ( !$name ) { |
||
| 464 | return $target; |
||
| 465 | } |
||
| 466 | $ret = SpecialPage::getTitleFor( $name, $subpage, $target->getFragment() ); |
||
| 467 | return $ret; |
||
| 468 | } else { |
||
| 469 | return $target; |
||
| 470 | } |
||
| 471 | } |
||
| 472 | |||
| 473 | /** |
||
| 474 | * Returns the filename part of an url. |
||
| 475 | * Used as alternative text for external images. |
||
| 476 | * |
||
| 477 | * @param string $url |
||
| 478 | * |
||
| 479 | * @return string |
||
| 480 | */ |
||
| 481 | private static function fnamePart( $url ) { |
||
| 490 | |||
| 491 | /** |
||
| 492 | * Return the code for images which were added via external links, |
||
| 493 | * via Parser::maybeMakeExternalImage(). |
||
| 494 | * |
||
| 495 | * @since 1.16.3 |
||
| 496 | * @param string $url |
||
| 497 | * @param string $alt |
||
| 498 | * |
||
| 499 | * @return string |
||
| 500 | */ |
||
| 501 | public static function makeExternalImage( $url, $alt = '' ) { |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Given parameters derived from [[Image:Foo|options...]], generate the |
||
| 520 | * HTML that that syntax inserts in the page. |
||
| 521 | * |
||
| 522 | * @param Parser $parser |
||
| 523 | * @param Title $title Title object of the file (not the currently viewed page) |
||
| 524 | * @param File $file File object, or false if it doesn't exist |
||
| 525 | * @param array $frameParams Associative array of parameters external to the media handler. |
||
| 526 | * Boolean parameters are indicated by presence or absence, the value is arbitrary and |
||
| 527 | * will often be false. |
||
| 528 | * thumbnail If present, downscale and frame |
||
| 529 | * manualthumb Image name to use as a thumbnail, instead of automatic scaling |
||
| 530 | * framed Shows image in original size in a frame |
||
| 531 | * frameless Downscale but don't frame |
||
| 532 | * upright If present, tweak default sizes for portrait orientation |
||
| 533 | * upright_factor Fudge factor for "upright" tweak (default 0.75) |
||
| 534 | * border If present, show a border around the image |
||
| 535 | * align Horizontal alignment (left, right, center, none) |
||
| 536 | * valign Vertical alignment (baseline, sub, super, top, text-top, middle, |
||
| 537 | * bottom, text-bottom) |
||
| 538 | * alt Alternate text for image (i.e. alt attribute). Plain text. |
||
| 539 | * class HTML for image classes. Plain text. |
||
| 540 | * caption HTML for image caption. |
||
| 541 | * link-url URL to link to |
||
| 542 | * link-title Title object to link to |
||
| 543 | * link-target Value for the target attribute, only with link-url |
||
| 544 | * no-link Boolean, suppress description link |
||
| 545 | * |
||
| 546 | * @param array $handlerParams Associative array of media handler parameters, to be passed |
||
| 547 | * to transform(). Typical keys are "width" and "page". |
||
| 548 | * @param string|bool $time Timestamp of the file, set as false for current |
||
| 549 | * @param string $query Query params for desc url |
||
| 550 | * @param int|null $widthOption Used by the parser to remember the user preference thumbnailsize |
||
| 551 | * @since 1.20 |
||
| 552 | * @return string HTML for an image, with links, wrappers, etc. |
||
| 553 | */ |
||
| 554 | public static function makeImageLink( Parser $parser, Title $title, |
||
| 689 | |||
| 690 | /** |
||
| 691 | * Get the link parameters for MediaTransformOutput::toHtml() from given |
||
| 692 | * frame parameters supplied by the Parser. |
||
| 693 | * @param array $frameParams The frame parameters |
||
| 694 | * @param string $query An optional query string to add to description page links |
||
| 695 | * @param Parser|null $parser |
||
| 696 | * @return array |
||
| 697 | */ |
||
| 698 | private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) { |
||
| 722 | |||
| 723 | /** |
||
| 724 | * Make HTML for a thumbnail including image, border and caption |
||
| 725 | * @param Title $title |
||
| 726 | * @param File|bool $file File object or false if it doesn't exist |
||
| 727 | * @param string $label |
||
| 728 | * @param string $alt |
||
| 729 | * @param string $align |
||
| 730 | * @param array $params |
||
| 731 | * @param bool $framed |
||
| 732 | * @param string $manualthumb |
||
| 733 | * @return string |
||
| 734 | */ |
||
| 735 | public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt, |
||
| 751 | |||
| 752 | /** |
||
| 753 | * @param Title $title |
||
| 754 | * @param File $file |
||
| 755 | * @param array $frameParams |
||
| 756 | * @param array $handlerParams |
||
| 757 | * @param bool $time |
||
| 758 | * @param string $query |
||
| 759 | * @return string |
||
| 760 | */ |
||
| 761 | public static function makeThumbLink2( Title $title, $file, $frameParams = [], |
||
| 878 | |||
| 879 | /** |
||
| 880 | * Process responsive images: add 1.5x and 2x subimages to the thumbnail, where |
||
| 881 | * applicable. |
||
| 882 | * |
||
| 883 | * @param File $file |
||
| 884 | * @param MediaTransformOutput $thumb |
||
| 885 | * @param array $hp Image parameters |
||
| 886 | */ |
||
| 887 | public static function processResponsiveImages( $file, $thumb, $hp ) { |
||
| 909 | |||
| 910 | /** |
||
| 911 | * Make a "broken" link to an image |
||
| 912 | * |
||
| 913 | * @since 1.16.3 |
||
| 914 | * @param Title $title |
||
| 915 | * @param string $label Link label (plain text) |
||
| 916 | * @param string $query Query string |
||
| 917 | * @param string $unused1 Unused parameter kept for b/c |
||
| 918 | * @param string $unused2 Unused parameter kept for b/c |
||
| 919 | * @param bool $time A file of a certain timestamp was requested |
||
| 920 | * @return string |
||
| 921 | */ |
||
| 922 | public static function makeBrokenImageLinkObj( $title, $label = '', |
||
| 955 | |||
| 956 | /** |
||
| 957 | * Get the URL to upload a certain file |
||
| 958 | * |
||
| 959 | * @since 1.16.3 |
||
| 960 | * @param Title $destFile Title object of the file to upload |
||
| 961 | * @param string $query Urlencoded query string to prepend |
||
| 962 | * @return string Urlencoded URL |
||
| 963 | */ |
||
| 964 | protected static function getUploadUrl( $destFile, $query = '' ) { |
||
| 980 | |||
| 981 | /** |
||
| 982 | * Create a direct link to a given uploaded file. |
||
| 983 | * |
||
| 984 | * @since 1.16.3 |
||
| 985 | * @param Title $title |
||
| 986 | * @param string $html Pre-sanitized HTML |
||
| 987 | * @param string $time MW timestamp of file creation time |
||
| 988 | * @return string HTML |
||
| 989 | */ |
||
| 990 | public static function makeMediaLinkObj( $title, $html = '', $time = false ) { |
||
| 994 | |||
| 995 | /** |
||
| 996 | * Create a direct link to a given uploaded file. |
||
| 997 | * This will make a broken link if $file is false. |
||
| 998 | * |
||
| 999 | * @since 1.16.3 |
||
| 1000 | * @param Title $title |
||
| 1001 | * @param File|bool $file File object or false |
||
| 1002 | * @param string $html Pre-sanitized HTML |
||
| 1003 | * @return string HTML |
||
| 1004 | * |
||
| 1005 | * @todo Handle invalid or missing images better. |
||
| 1006 | */ |
||
| 1007 | public static function makeMediaLinkFile( Title $title, $file, $html = '' ) { |
||
| 1037 | |||
| 1038 | /** |
||
| 1039 | * Make a link to a special page given its name and, optionally, |
||
| 1040 | * a message key from the link text. |
||
| 1041 | * Usage example: Linker::specialLink( 'Recentchanges' ) |
||
| 1042 | * |
||
| 1043 | * @since 1.16.3 |
||
| 1044 | * @param string $name |
||
| 1045 | * @param string $key |
||
| 1046 | * @return string |
||
| 1047 | */ |
||
| 1048 | public static function specialLink( $name, $key = '' ) { |
||
| 1055 | |||
| 1056 | /** |
||
| 1057 | * Make an external link |
||
| 1058 | * @since 1.16.3. $title added in 1.21 |
||
| 1059 | * @param string $url URL to link to |
||
| 1060 | * @param string $text Text of link |
||
| 1061 | * @param bool $escape Do we escape the link text? |
||
| 1062 | * @param string $linktype Type of external link. Gets added to the classes |
||
| 1063 | * @param array $attribs Array of extra attributes to <a> |
||
| 1064 | * @param Title|null $title Title object used for title specific link attributes |
||
| 1065 | * @return string |
||
| 1066 | */ |
||
| 1067 | public static function makeExternalLink( $url, $text, $escape = true, |
||
| 1108 | |||
| 1109 | /** |
||
| 1110 | * Make user link (or user contributions for unregistered users) |
||
| 1111 | * @param int $userId User id in database. |
||
| 1112 | * @param string $userName User name in database. |
||
| 1113 | * @param string $altUserName Text to display instead of the user name (optional) |
||
| 1114 | * @return string HTML fragment |
||
| 1115 | * @since 1.16.3. $altUserName was added in 1.19. |
||
| 1116 | */ |
||
| 1117 | public static function userLink( $userId, $userName, $altUserName = false ) { |
||
| 1135 | |||
| 1136 | /** |
||
| 1137 | * Generate standard user tool links (talk, contributions, block link, etc.) |
||
| 1138 | * |
||
| 1139 | * @since 1.16.3 |
||
| 1140 | * @param int $userId User identifier |
||
| 1141 | * @param string $userText User name or IP address |
||
| 1142 | * @param bool $redContribsWhenNoEdits Should the contributions link be |
||
| 1143 | * red if the user has no edits? |
||
| 1144 | * @param int $flags Customisation flags (e.g. Linker::TOOL_LINKS_NOBLOCK |
||
| 1145 | * and Linker::TOOL_LINKS_EMAIL). |
||
| 1146 | * @param int $edits User edit count (optional, for performance) |
||
| 1147 | * @return string HTML fragment |
||
| 1148 | */ |
||
| 1149 | public static function userToolLinks( |
||
| 1196 | |||
| 1197 | /** |
||
| 1198 | * Alias for userToolLinks( $userId, $userText, true ); |
||
| 1199 | * @since 1.16.3 |
||
| 1200 | * @param int $userId User identifier |
||
| 1201 | * @param string $userText User name or IP address |
||
| 1202 | * @param int $edits User edit count (optional, for performance) |
||
| 1203 | * @return string |
||
| 1204 | */ |
||
| 1205 | public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) { |
||
| 1208 | |||
| 1209 | /** |
||
| 1210 | * @since 1.16.3 |
||
| 1211 | * @param int $userId User id in database. |
||
| 1212 | * @param string $userText User name in database. |
||
| 1213 | * @return string HTML fragment with user talk link |
||
| 1214 | */ |
||
| 1215 | public static function userTalkLink( $userId, $userText ) { |
||
| 1220 | |||
| 1221 | /** |
||
| 1222 | * @since 1.16.3 |
||
| 1223 | * @param int $userId Userid |
||
| 1224 | * @param string $userText User name in database. |
||
| 1225 | * @return string HTML fragment with block link |
||
| 1226 | */ |
||
| 1227 | public static function blockLink( $userId, $userText ) { |
||
| 1232 | |||
| 1233 | /** |
||
| 1234 | * @param int $userId Userid |
||
| 1235 | * @param string $userText User name in database. |
||
| 1236 | * @return string HTML fragment with e-mail user link |
||
| 1237 | */ |
||
| 1238 | public static function emailLink( $userId, $userText ) { |
||
| 1243 | |||
| 1244 | /** |
||
| 1245 | * Generate a user link if the current user is allowed to view it |
||
| 1246 | * @since 1.16.3 |
||
| 1247 | * @param Revision $rev |
||
| 1248 | * @param bool $isPublic Show only if all users can see it |
||
| 1249 | * @return string HTML fragment |
||
| 1250 | */ |
||
| 1251 | public static function revUserLink( $rev, $isPublic = false ) { |
||
| 1265 | |||
| 1266 | /** |
||
| 1267 | * Generate a user tool link cluster if the current user is allowed to view it |
||
| 1268 | * @since 1.16.3 |
||
| 1269 | * @param Revision $rev |
||
| 1270 | * @param bool $isPublic Show only if all users can see it |
||
| 1271 | * @return string HTML |
||
| 1272 | */ |
||
| 1273 | public static function revUserTools( $rev, $isPublic = false ) { |
||
| 1289 | |||
| 1290 | /** |
||
| 1291 | * This function is called by all recent changes variants, by the page history, |
||
| 1292 | * and by the user contributions list. It is responsible for formatting edit |
||
| 1293 | * summaries. It escapes any HTML in the summary, but adds some CSS to format |
||
| 1294 | * auto-generated comments (from section editing) and formats [[wikilinks]]. |
||
| 1295 | * |
||
| 1296 | * @author Erik Moeller <[email protected]> |
||
| 1297 | * @since 1.16.3. $wikiId added in 1.26 |
||
| 1298 | * |
||
| 1299 | * Note: there's not always a title to pass to this function. |
||
| 1300 | * Since you can't set a default parameter for a reference, I've turned it |
||
| 1301 | * temporarily to a value pass. Should be adjusted further. --brion |
||
| 1302 | * |
||
| 1303 | * @param string $comment |
||
| 1304 | * @param Title|null $title Title object (to generate link to the section in autocomment) |
||
| 1305 | * or null |
||
| 1306 | * @param bool $local Whether section links should refer to local page |
||
| 1307 | * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to. |
||
| 1308 | * For use with external changes. |
||
| 1309 | * |
||
| 1310 | * @return mixed|string |
||
| 1311 | */ |
||
| 1312 | public static function formatComment( |
||
| 1326 | |||
| 1327 | /** |
||
| 1328 | * Converts autogenerated comments in edit summaries into section links. |
||
| 1329 | * |
||
| 1330 | * The pattern for autogen comments is / * foo * /, which makes for |
||
| 1331 | * some nasty regex. |
||
| 1332 | * We look for all comments, match any text before and after the comment, |
||
| 1333 | * add a separator where needed and format the comment itself with CSS |
||
| 1334 | * Called by Linker::formatComment. |
||
| 1335 | * |
||
| 1336 | * @param string $comment Comment text |
||
| 1337 | * @param Title|null $title An optional title object used to links to sections |
||
| 1338 | * @param bool $local Whether section links should refer to local page |
||
| 1339 | * @param string|null $wikiId Id of the wiki to link to (if not the local wiki), |
||
| 1340 | * as used by WikiMap. |
||
| 1341 | * |
||
| 1342 | * @return string Formatted comment (wikitext) |
||
| 1343 | */ |
||
| 1344 | private static function formatAutocomments( |
||
| 1418 | |||
| 1419 | /** |
||
| 1420 | * Formats wiki links and media links in text; all other wiki formatting |
||
| 1421 | * is ignored |
||
| 1422 | * |
||
| 1423 | * @since 1.16.3. $wikiId added in 1.26 |
||
| 1424 | * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser |
||
| 1425 | * |
||
| 1426 | * @param string $comment Text to format links in. WARNING! Since the output of this |
||
| 1427 | * function is html, $comment must be sanitized for use as html. You probably want |
||
| 1428 | * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling |
||
| 1429 | * this function. |
||
| 1430 | * @param Title|null $title An optional title object used to links to sections |
||
| 1431 | * @param bool $local Whether section links should refer to local page |
||
| 1432 | * @param string|null $wikiId Id of the wiki to link to (if not the local wiki), |
||
| 1433 | * as used by WikiMap. |
||
| 1434 | * |
||
| 1435 | * @return string |
||
| 1436 | */ |
||
| 1437 | public static function formatLinksInComment( |
||
| 1531 | |||
| 1532 | /** |
||
| 1533 | * Generates a link to the given Title |
||
| 1534 | * |
||
| 1535 | * @note This is only public for technical reasons. It's not intended for use outside Linker. |
||
| 1536 | * |
||
| 1537 | * @param Title $title |
||
| 1538 | * @param string $text |
||
| 1539 | * @param string|null $wikiId Id of the wiki to link to (if not the local wiki), |
||
| 1540 | * as used by WikiMap. |
||
| 1541 | * @param string|string[] $options See the $options parameter in Linker::link. |
||
| 1542 | * |
||
| 1543 | * @return string HTML link |
||
| 1544 | */ |
||
| 1545 | public static function makeCommentLink( |
||
| 1564 | |||
| 1565 | /** |
||
| 1566 | * @param Title $contextTitle |
||
| 1567 | * @param string $target |
||
| 1568 | * @param string $text |
||
| 1569 | * @return string |
||
| 1570 | */ |
||
| 1571 | public static function normalizeSubpageLink( $contextTitle, $target, &$text ) { |
||
| 1643 | |||
| 1644 | /** |
||
| 1645 | * Wrap a comment in standard punctuation and formatting if |
||
| 1646 | * it's non-empty, otherwise return empty string. |
||
| 1647 | * |
||
| 1648 | * @since 1.16.3. $wikiId added in 1.26 |
||
| 1649 | * @param string $comment |
||
| 1650 | * @param Title|null $title Title object (to generate link to section in autocomment) or null |
||
| 1651 | * @param bool $local Whether section links should refer to local page |
||
| 1652 | * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to. |
||
| 1653 | * For use with external changes. |
||
| 1654 | * |
||
| 1655 | * @return string |
||
| 1656 | */ |
||
| 1657 | public static function commentBlock( |
||
| 1671 | |||
| 1672 | /** |
||
| 1673 | * Wrap and format the given revision's comment block, if the current |
||
| 1674 | * user is allowed to view it. |
||
| 1675 | * |
||
| 1676 | * @since 1.16.3 |
||
| 1677 | * @param Revision $rev |
||
| 1678 | * @param bool $local Whether section links should refer to local page |
||
| 1679 | * @param bool $isPublic Show only if all users can see it |
||
| 1680 | * @return string HTML fragment |
||
| 1681 | */ |
||
| 1682 | public static function revComment( Revision $rev, $local = false, $isPublic = false ) { |
||
| 1699 | |||
| 1700 | /** |
||
| 1701 | * @since 1.16.3 |
||
| 1702 | * @param int $size |
||
| 1703 | * @return string |
||
| 1704 | */ |
||
| 1705 | public static function formatRevisionSize( $size ) { |
||
| 1714 | |||
| 1715 | /** |
||
| 1716 | * Add another level to the Table of Contents |
||
| 1717 | * |
||
| 1718 | * @since 1.16.3 |
||
| 1719 | * @return string |
||
| 1720 | */ |
||
| 1721 | public static function tocIndent() { |
||
| 1724 | |||
| 1725 | /** |
||
| 1726 | * Finish one or more sublevels on the Table of Contents |
||
| 1727 | * |
||
| 1728 | * @since 1.16.3 |
||
| 1729 | * @param int $level |
||
| 1730 | * @return string |
||
| 1731 | */ |
||
| 1732 | public static function tocUnindent( $level ) { |
||
| 1735 | |||
| 1736 | /** |
||
| 1737 | * parameter level defines if we are on an indentation level |
||
| 1738 | * |
||
| 1739 | * @since 1.16.3 |
||
| 1740 | * @param string $anchor |
||
| 1741 | * @param string $tocline |
||
| 1742 | * @param string $tocnumber |
||
| 1743 | * @param string $level |
||
| 1744 | * @param string|bool $sectionIndex |
||
| 1745 | * @return string |
||
| 1746 | */ |
||
| 1747 | public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) { |
||
| 1757 | |||
| 1758 | /** |
||
| 1759 | * End a Table Of Contents line. |
||
| 1760 | * tocUnindent() will be used instead if we're ending a line below |
||
| 1761 | * the new level. |
||
| 1762 | * @since 1.16.3 |
||
| 1763 | * @return string |
||
| 1764 | */ |
||
| 1765 | public static function tocLineEnd() { |
||
| 1768 | |||
| 1769 | /** |
||
| 1770 | * Wraps the TOC in a table and provides the hide/collapse javascript. |
||
| 1771 | * |
||
| 1772 | * @since 1.16.3 |
||
| 1773 | * @param string $toc Html of the Table Of Contents |
||
| 1774 | * @param string|Language|bool $lang Language for the toc title, defaults to user language |
||
| 1775 | * @return string Full html of the TOC |
||
| 1776 | */ |
||
| 1777 | public static function tocList( $toc, $lang = false ) { |
||
| 1786 | |||
| 1787 | /** |
||
| 1788 | * Generate a table of contents from a section tree. |
||
| 1789 | * |
||
| 1790 | * @since 1.16.3. $lang added in 1.17 |
||
| 1791 | * @param array $tree Return value of ParserOutput::getSections() |
||
| 1792 | * @param string|Language|bool $lang Language for the toc title, defaults to user language |
||
| 1793 | * @return string HTML fragment |
||
| 1794 | */ |
||
| 1795 | public static function generateTOC( $tree, $lang = false ) { |
||
| 1816 | |||
| 1817 | /** |
||
| 1818 | * Create a headline for content |
||
| 1819 | * |
||
| 1820 | * @since 1.16.3 |
||
| 1821 | * @param int $level The level of the headline (1-6) |
||
| 1822 | * @param string $attribs Any attributes for the headline, starting with |
||
| 1823 | * a space and ending with '>' |
||
| 1824 | * This *must* be at least '>' for no attribs |
||
| 1825 | * @param string $anchor The anchor to give the headline (the bit after the #) |
||
| 1826 | * @param string $html Html for the text of the header |
||
| 1827 | * @param string $link HTML to add for the section edit link |
||
| 1828 | * @param bool|string $legacyAnchor A second, optional anchor to give for |
||
| 1829 | * backward compatibility (false to omit) |
||
| 1830 | * |
||
| 1831 | * @return string HTML headline |
||
| 1832 | */ |
||
| 1833 | public static function makeHeadline( $level, $attribs, $anchor, $html, |
||
| 1845 | |||
| 1846 | /** |
||
| 1847 | * Split a link trail, return the "inside" portion and the remainder of the trail |
||
| 1848 | * as a two-element array |
||
| 1849 | * @param string $trail |
||
| 1850 | * @return array |
||
| 1851 | */ |
||
| 1852 | static function splitTrail( $trail ) { |
||
| 1865 | |||
| 1866 | /** |
||
| 1867 | * Generate a rollback link for a given revision. Currently it's the |
||
| 1868 | * caller's responsibility to ensure that the revision is the top one. If |
||
| 1869 | * it's not, of course, the user will get an error message. |
||
| 1870 | * |
||
| 1871 | * If the calling page is called with the parameter &bot=1, all rollback |
||
| 1872 | * links also get that parameter. It causes the edit itself and the rollback |
||
| 1873 | * to be marked as "bot" edits. Bot edits are hidden by default from recent |
||
| 1874 | * changes, so this allows sysops to combat a busy vandal without bothering |
||
| 1875 | * other users. |
||
| 1876 | * |
||
| 1877 | * If the option verify is set this function will return the link only in case the |
||
| 1878 | * revision can be reverted. Please note that due to performance limitations |
||
| 1879 | * it might be assumed that a user isn't the only contributor of a page while |
||
| 1880 | * (s)he is, which will lead to useless rollback links. Furthermore this wont |
||
| 1881 | * work if $wgShowRollbackEditCount is disabled, so this can only function |
||
| 1882 | * as an additional check. |
||
| 1883 | * |
||
| 1884 | * If the option noBrackets is set the rollback link wont be enclosed in [] |
||
| 1885 | * |
||
| 1886 | * @since 1.16.3. $context added in 1.20. $options added in 1.21 |
||
| 1887 | * |
||
| 1888 | * @param Revision $rev |
||
| 1889 | * @param IContextSource $context Context to use or null for the main context. |
||
| 1890 | * @param array $options |
||
| 1891 | * @return string |
||
| 1892 | */ |
||
| 1893 | public static function generateRollback( $rev, IContextSource $context = null, |
||
| 1916 | |||
| 1917 | /** |
||
| 1918 | * This function will return the number of revisions which a rollback |
||
| 1919 | * would revert and, if $verify is set it will verify that a revision |
||
| 1920 | * can be reverted (that the user isn't the only contributor and the |
||
| 1921 | * revision we might rollback to isn't deleted). These checks can only |
||
| 1922 | * function as an additional check as this function only checks against |
||
| 1923 | * the last $wgShowRollbackEditCount edits. |
||
| 1924 | * |
||
| 1925 | * Returns null if $wgShowRollbackEditCount is disabled or false if $verify |
||
| 1926 | * is set and the user is the only contributor of the page. |
||
| 1927 | * |
||
| 1928 | * @param Revision $rev |
||
| 1929 | * @param bool $verify Try to verify that this revision can really be rolled back |
||
| 1930 | * @return int|bool|null |
||
| 1931 | */ |
||
| 1932 | public static function getRollbackEditCount( $rev, $verify ) { |
||
| 1982 | |||
| 1983 | /** |
||
| 1984 | * Build a raw rollback link, useful for collections of "tool" links |
||
| 1985 | * |
||
| 1986 | * @since 1.16.3. $context added in 1.20. $editCount added in 1.21 |
||
| 1987 | * @param Revision $rev |
||
| 1988 | * @param IContextSource|null $context Context to use or null for the main context. |
||
| 1989 | * @param int $editCount Number of edits that would be reverted |
||
| 1990 | * @return string HTML fragment |
||
| 1991 | */ |
||
| 1992 | public static function buildRollbackLink( $rev, IContextSource $context = null, |
||
| 2060 | |||
| 2061 | /** |
||
| 2062 | * Returns HTML for the "templates used on this page" list. |
||
| 2063 | * |
||
| 2064 | * Make an HTML list of templates, and then add a "More..." link at |
||
| 2065 | * the bottom. If $more is null, do not add a "More..." link. If $more |
||
| 2066 | * is a Title, make a link to that title and use it. If $more is a string, |
||
| 2067 | * directly paste it in as the link (escaping needs to be done manually). |
||
| 2068 | * Finally, if $more is a Message, call toString(). |
||
| 2069 | * |
||
| 2070 | * @since 1.16.3. $more added in 1.21 |
||
| 2071 | * @param Title[] $templates Array of templates |
||
| 2072 | * @param bool $preview Whether this is for a preview |
||
| 2073 | * @param bool $section Whether this is for a section edit |
||
| 2074 | * @param Title|Message|string|null $more An escaped link for "More..." of the templates |
||
| 2075 | * @return string HTML output |
||
| 2076 | */ |
||
| 2077 | public static function formatTemplates( $templates, $preview = false, |
||
| 2162 | |||
| 2163 | /** |
||
| 2164 | * Returns HTML for the "hidden categories on this page" list. |
||
| 2165 | * |
||
| 2166 | * @since 1.16.3 |
||
| 2167 | * @param array $hiddencats Array of hidden categories from Article::getHiddenCategories |
||
| 2168 | * or similar |
||
| 2169 | * @return string HTML output |
||
| 2170 | */ |
||
| 2171 | public static function formatHiddenCategories( $hiddencats ) { |
||
| 2190 | |||
| 2191 | /** |
||
| 2192 | * Format a size in bytes for output, using an appropriate |
||
| 2193 | * unit (B, KB, MB or GB) according to the magnitude in question |
||
| 2194 | * |
||
| 2195 | * @since 1.16.3 |
||
| 2196 | * @param int $size Size to format |
||
| 2197 | * @return string |
||
| 2198 | */ |
||
| 2199 | public static function formatSize( $size ) { |
||
| 2203 | |||
| 2204 | /** |
||
| 2205 | * Given the id of an interface element, constructs the appropriate title |
||
| 2206 | * attribute from the system messages. (Note, this is usually the id but |
||
| 2207 | * isn't always, because sometimes the accesskey needs to go on a different |
||
| 2208 | * element than the id, for reverse-compatibility, etc.) |
||
| 2209 | * |
||
| 2210 | * @since 1.16.3 $msgParams added in 1.27 |
||
| 2211 | * @param string $name Id of the element, minus prefixes. |
||
| 2212 | * @param string|null $options Null or the string 'withaccess' to add an access- |
||
| 2213 | * key hint |
||
| 2214 | * @param array $msgParams Parameters to pass to the message |
||
| 2215 | * |
||
| 2216 | * @return string Contents of the title attribute (which you must HTML- |
||
| 2217 | * escape), or false for no title attribute |
||
| 2218 | */ |
||
| 2219 | public static function titleAttrib( $name, $options = null, array $msgParams = [] ) { |
||
| 2248 | |||
| 2249 | public static $accesskeycache; |
||
| 2250 | |||
| 2251 | /** |
||
| 2252 | * Given the id of an interface element, constructs the appropriate |
||
| 2253 | * accesskey attribute from the system messages. (Note, this is usually |
||
| 2254 | * the id but isn't always, because sometimes the accesskey needs to go on |
||
| 2255 | * a different element than the id, for reverse-compatibility, etc.) |
||
| 2256 | * |
||
| 2257 | * @since 1.16.3 |
||
| 2258 | * @param string $name Id of the element, minus prefixes. |
||
| 2259 | * @return string Contents of the accesskey attribute (which you must HTML- |
||
| 2260 | * escape), or false for no accesskey attribute |
||
| 2261 | */ |
||
| 2262 | public static function accesskey( $name ) { |
||
| 2284 | |||
| 2285 | /** |
||
| 2286 | * Get a revision-deletion link, or disabled link, or nothing, depending |
||
| 2287 | * on user permissions & the settings on the revision. |
||
| 2288 | * |
||
| 2289 | * Will use forward-compatible revision ID in the Special:RevDelete link |
||
| 2290 | * if possible, otherwise the timestamp-based ID which may break after |
||
| 2291 | * undeletion. |
||
| 2292 | * |
||
| 2293 | * @param User $user |
||
| 2294 | * @param Revision $rev |
||
| 2295 | * @param Title $title |
||
| 2296 | * @return string HTML fragment |
||
| 2297 | */ |
||
| 2298 | public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) { |
||
| 2328 | |||
| 2329 | /** |
||
| 2330 | * Creates a (show/hide) link for deleting revisions/log entries |
||
| 2331 | * |
||
| 2332 | * @param array $query Query parameters to be passed to link() |
||
| 2333 | * @param bool $restricted Set to true to use a "<strong>" instead of a "<span>" |
||
| 2334 | * @param bool $delete Set to true to use (show/hide) rather than (show) |
||
| 2335 | * |
||
| 2336 | * @return string HTML "<a>" link to Special:Revisiondelete, wrapped in a |
||
| 2337 | * span to allow for customization of appearance with CSS |
||
| 2338 | */ |
||
| 2339 | public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) { |
||
| 2351 | |||
| 2352 | /** |
||
| 2353 | * Creates a dead (show/hide) link for deleting revisions/log entries |
||
| 2354 | * |
||
| 2355 | * @since 1.16.3 |
||
| 2356 | * @param bool $delete Set to true to use (show/hide) rather than (show) |
||
| 2357 | * |
||
| 2358 | * @return string HTML text wrapped in a span to allow for customization |
||
| 2359 | * of appearance with CSS |
||
| 2360 | */ |
||
| 2361 | public static function revDeleteLinkDisabled( $delete = true ) { |
||
| 2367 | |||
| 2368 | /* Deprecated methods */ |
||
| 2369 | |||
| 2370 | /** |
||
| 2371 | * Returns the attributes for the tooltip and access key. |
||
| 2372 | * |
||
| 2373 | * @since 1.16.3. $msgParams introduced in 1.27 |
||
| 2374 | * @param string $name |
||
| 2375 | * @param array $msgParams Params for constructing the message |
||
| 2376 | * |
||
| 2377 | * @return array |
||
| 2378 | */ |
||
| 2379 | public static function tooltipAndAccesskeyAttribs( $name, array $msgParams = [] ) { |
||
| 2395 | |||
| 2396 | /** |
||
| 2397 | * Returns raw bits of HTML, use titleAttrib() |
||
| 2398 | * @since 1.16.3 |
||
| 2399 | * @param string $name |
||
| 2400 | * @param array|null $options |
||
| 2401 | * @return null|string |
||
| 2402 | */ |
||
| 2403 | public static function tooltip( $name, $options = null ) { |
||
| 2415 | |||
| 2416 | } |
||
| 2417 | |||
| 2418 |
Loading history...
This method has been deprecated. The supplier of the class has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.