MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
9 use Title;
10 use Html;
19  protected $specialSearch;
21  protected $resultWidget;
23  protected $customCaptions;
25  protected $linkRenderer;
27  protected $iwLookup;
29  protected $output;
33  public function __construct(
38  ) {
39  $this->specialSearch = $specialSearch;
40  $this->resultWidget = $resultWidget;
41  $this->linkRenderer = $linkRenderer;
42  $this->iwLookup = $iwLookup;
43  $this->output = $specialSearch->getOutput();
44  $this->iwPrefixDisplayTypes = $specialSearch->getConfig()->get(
45  'InterwikiPrefixDisplayTypes'
46  );
47  }
54  public function render( $term, $resultSets ) {
55  if ( !is_array( $resultSets ) ) {
56  $resultSets = [ $resultSets ];
57  }
59  $this->loadCustomCaptions();
61  $this->output->addModules( '' );
62  $this->output->addModuleStyles( '' );
64  $iwResults = [];
65  foreach ( $resultSets as $resultSet ) {
66  $result = $resultSet->next();
67  while ( $result ) {
68  if ( !$result->isBrokenTitle() ) {
69  $iwResults[$result->getTitle()->getInterwiki()][] = $result;
70  }
71  $result = $resultSet->next();
72  }
73  }
75  $iwResultSetPos = 1;
76  $iwResultListOutput = '';
78  foreach ( $iwResults as $iwPrefix => $results ) {
79  // TODO: Assumes interwiki results are never paginated
80  $position = 0;
81  $iwResultItemOutput = '';
83  $iwDisplayType = isset( $this->iwPrefixDisplayTypes[$iwPrefix] )
84  ? $this->iwPrefixDisplayTypes[$iwPrefix]
85  : "";
87  foreach ( $results as $result ) {
88  $iwResultItemOutput .= $this->resultWidget->render( $result, $term, $position++ );
89  }
91  $headerHtml = $this->headerHtml( $term, $iwPrefix );
92  $footerHtml = $this->footerHtml( $term, $iwPrefix );
93  $iwResultListOutput .= Html::rawElement( 'li',
94  [
95  'class' => 'iw-resultset iw-resultset--' . $iwDisplayType,
96  'data-iw-resultset-pos' => $iwResultSetPos
97  ],
98  $headerHtml .
99  $iwResultItemOutput .
100  $footerHtml
101  );
103  $iwResultSetPos++;
104  }
106  return Html::rawElement(
107  'div',
108  [ 'id' => 'mw-interwiki-results' ],
110  'p',
111  [ 'class' => 'iw-headline' ],
112  $this->specialSearch->msg( 'search-interwiki-caption' )->parse()
113  ) .
115  'ul', [ 'class' => 'iw-results', ], $iwResultListOutput
116  )
117  );
118  }
127  protected function headerHtml( $term, $iwPrefix ) {
129  $iwDisplayType = isset( $this->iwPrefixDisplayTypes[$iwPrefix] )
130  ? $this->iwPrefixDisplayTypes[$iwPrefix]
131  : "";
133  if ( isset( $this->customCaptions[$iwPrefix] ) ) {
134  /* customCaptions composed by loadCustomCaptions() with pre-escaped content. */
135  $caption = $this->customCaptions[$iwPrefix];
136  } else {
137  $interwiki = $this->iwLookup->fetch( $iwPrefix );
138  $parsed = wfParseUrl( wfExpandUrl( $interwiki ? $interwiki->getURL() : '/' ) );
139  $caption = $this->specialSearch->msg( 'search-interwiki-default', $parsed['host'] )->escaped();
140  }
142  return Html::rawElement( 'div', [ 'class' => 'iw-result__header' ],
143  Html::rawElement( 'span', [ 'class' => 'iw-result__icon iw-result__icon--' . $iwDisplayType ] )
144  . $caption
145  );
146  }
155  protected function footerHtml( $term, $iwPrefix ) {
157  $href = Title::makeTitle( NS_SPECIAL, 'Search', null, $iwPrefix )->getLocalURL(
158  [ 'search' => $term, 'fulltext' => 1 ]
159  );
161  $searchLink = Html::rawElement(
162  'a',
163  [ 'href' => $href ],
164  $this->specialSearch->msg( 'search-interwiki-more-results' )->escaped()
165  );
167  return Html::rawElement( 'div', [ 'class' => 'iw-result__footer' ], $searchLink );
168  }
170  protected function loadCustomCaptions() {
171  if ( $this->customCaptions !== null ) {
172  return;
173  }
175  $this->customCaptions = [];
176  $customLines = explode( "\n", $this->specialSearch->msg( 'search-interwiki-custom' )->escaped() );
177  foreach ( $customLines as $line ) {
178  $parts = explode( ':', $line, 2 );
179  if ( count( $parts ) === 2 ) {
180  $this->customCaptions[$parts[0]] = $parts[1];
181  }
182  }
183  }
184 }
headerHtml( $term, $iwPrefix)
Generates an appropriate HTML header for the given interwiki prefix.
Definition: InterwikiSearchResultSetWidget.php:127
$iwPrefixDisplayTypes $iwPrefixDisplayTypes
Definition: InterwikiSearchResultSetWidget.php:31
SearchResultWidget $resultWidget
Definition: InterwikiSearchResultSetWidget.php:21
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
addModuleStyles( $modules)
Add only CSS of one or more modules recognized by ResourceLoader.
Definition: OutputPage.php:642
Class that generates HTML links for pages.
Definition: LinkRenderer.php:42
Definition: BasicSearchResultSetWidget.php:3
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1954
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Definition: InterwikiSearchResultSetWidget.php:170
LinkRenderer $linkRenderer
Definition: InterwikiSearchResultSetWidget.php:25
external whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2759
string[] null $customCaptions
Definition: InterwikiSearchResultSetWidget.php:23
Renders one or more SearchResultSets into a sidebar grouped by interwiki prefix.
Definition: InterwikiSearchResultSetWidget.php:17
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Renders a set of search results to HTML.
Definition: SearchResultSetWidget.php:10
Definition: Defines.php:51
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:818
render( $term, $resultSets)
Definition: InterwikiSearchResultSetWidget.php:54
Shortcut to get main config object.
Definition: SpecialPage.php:714
SpecialSearch $specialSearch
Definition: InterwikiSearchResultSetWidget.php:19
Service interface for looking up Interwiki records.
Definition: InterwikiLookup.php:31
$output $output
Definition: InterwikiSearchResultSetWidget.php:29
Renders a single search result to HTML.
Definition: SearchResultWidget.php:10
addModules( $modules)
Add one or more modules recognized by ResourceLoader.
Definition: OutputPage.php:592
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:514
Definition: SearchResultSet.php:27
__construct(SpecialSearch $specialSearch, SearchResultWidget $resultWidget, LinkRenderer $linkRenderer, InterwikiLookup $iwLookup)
Definition: InterwikiSearchResultSetWidget.php:33
Definition: cdb.php:58
implements Special:Search - Run text & title search and display the output
Definition: SpecialSearch.php:38
Represents a title within MediaWiki.
Definition: Title.php:39
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
footerHtml( $term, $iwPrefix)
Generates an HTML footer for the given interwiki prefix.
Definition: InterwikiSearchResultSetWidget.php:155
InterwikiLookup $iwLookup
Definition: InterwikiSearchResultSetWidget.php:27
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:552
This class is a collection of static functions that serve two purposes:
Definition: Html.php:48