MediaWiki  REL1_31
BasicSearchResultSetWidget.php
Go to the documentation of this file.
1 <?php
2 
4 
8 use Status;
9 
16  protected $specialPage;
18  protected $resultWidget;
20  protected $sidebarWidget;
21 
22  public function __construct(
26  ) {
27  $this->specialPage = $specialPage;
28  $this->resultWidget = $resultWidget;
29  $this->sidebarWidget = $sidebarWidget;
30  }
31 
39  public function render(
40  $term,
41  $offset,
42  SearchResultSet $titleResultSet = null,
43  SearchResultSet $textResultSet = null
44  ) {
46 
47  $hasTitle = $titleResultSet ? $titleResultSet->numRows() > 0 : false;
48  $hasText = $textResultSet ? $textResultSet->numRows() > 0 : false;
49  $hasSecondary = $textResultSet
50  ? $textResultSet->hasInterwikiResults( SearchResultSet::SECONDARY_RESULTS )
51  : false;
52  $hasSecondaryInline = $textResultSet
53  ? $textResultSet->hasInterwikiResults( SearchResultSet::INLINE_RESULTS )
54  : false;
55 
56  if ( !$hasTitle && !$hasText && !$hasSecondary && !$hasSecondaryInline ) {
57  return '';
58  }
59 
60  $out = '';
61  if ( $hasTitle ) {
62  $out .= $this->header( $this->specialPage->msg( 'titlematches' ) )
63  . $this->renderResultSet( $titleResultSet, $offset );
64  }
65 
66  if ( $hasText ) {
67  if ( $hasTitle ) {
68  $out .= "<div class='mw-search-visualclear'></div>" .
69  $this->header( $this->specialPage->msg( 'textmatches' ) );
70  }
71  $out .= $this->renderResultSet( $textResultSet, $offset );
72  }
73 
74  if ( $hasSecondaryInline ) {
75  $iwResults = $textResultSet->getInterwikiResults( SearchResultSet::INLINE_RESULTS );
76  foreach ( $iwResults as $interwiki => $results ) {
77  if ( $results instanceof Status || $results->numRows() === 0 ) {
78  // ignore bad interwikis for now
79  continue;
80  }
81  $out .=
82  "<h2 class='mw-search-interwiki-header mw-search-visualclear'>" .
83  $this->specialPage->msg( "search-interwiki-results-{$interwiki}" )->parse() .
84  "</h2>";
85  $out .= $this->renderResultSet( $results, $offset );
86  }
87  }
88 
89  if ( $hasSecondary ) {
90  $out .= $this->sidebarWidget->render(
91  $term,
92  $textResultSet->getInterwikiResults( SearchResultSet::SECONDARY_RESULTS )
93  );
94  }
95 
96  // Convert the whole thing to desired language variant
97  // TODO: Move this up to Special:Search?
98  return $wgContLang->convert( $out );
99  }
100 
109  protected function header( Message $msg ) {
110  return "<h2>" .
111  "<span class='mw-headline'>" . $msg->escaped() . "</span>" .
112  "</h2>";
113  }
114 
120  protected function renderResultSet( SearchResultSet $resultSet, $offset ) {
122 
123  $terms = $wgContLang->convertForSearchResult( $resultSet->termMatches() );
124 
125  $hits = [];
126  $result = $resultSet->next();
127  while ( $result ) {
128  $hits[] .= $this->resultWidget->render( $result, $terms, $offset++ );
129  $result = $resultSet->next();
130  }
131 
132  return "<ul class='mw-search-results'>" . implode( '', $hits ) . "</ul>";
133  }
134 }
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\Widget\Search
Definition: BasicSearchResultSetWidget.php:3
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
MediaWiki\Widget\Search\BasicSearchResultSetWidget\$sidebarWidget
InterwikiSearchResultSetWidget $sidebarWidget
Definition: BasicSearchResultSetWidget.php:20
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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:1993
MediaWiki\Widget\Search\InterwikiSearchResultSetWidget
Renders one or more SearchResultSets into a sidebar grouped by interwiki prefix.
Definition: InterwikiSearchResultSetWidget.php:18
MediaWiki\Widget\Search\BasicSearchResultSetWidget
Renders the search result area.
Definition: BasicSearchResultSetWidget.php:14
php
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:37
SearchResultSet\termMatches
termMatches()
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine...
Definition: SearchResultSet.php:79
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
MediaWiki\Widget\Search\SearchResultSetWidget
Renders a set of search results to HTML.
Definition: SearchResultSetWidget.php:10
$term
For QUnit the mediawiki tests qunit testrunner dependency will be added to any module whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2845
MediaWiki\Widget\Search\BasicSearchResultSetWidget\__construct
__construct(SpecialSearch $specialPage, SearchResultWidget $resultWidget, SearchResultSetWidget $sidebarWidget)
Definition: BasicSearchResultSetWidget.php:22
MediaWiki\Widget\Search\SearchResultWidget
Renders a single search result to HTML.
Definition: SearchResultWidget.php:10
MediaWiki\Widget\Search\BasicSearchResultSetWidget\$specialPage
SpecialSearch $specialPage
Definition: BasicSearchResultSetWidget.php:16
MediaWiki\Widget\Search\BasicSearchResultSetWidget\header
header(Message $msg)
Generate a headline for a section of the search results.
Definition: BasicSearchResultSetWidget.php:109
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
SearchResultSet
Definition: SearchResultSet.php:27
MediaWiki\Widget\Search\BasicSearchResultSetWidget\render
render( $term, $offset, SearchResultSet $titleResultSet=null, SearchResultSet $textResultSet=null)
Definition: BasicSearchResultSetWidget.php:39
MediaWiki\Widget\Search\BasicSearchResultSetWidget\renderResultSet
renderResultSet(SearchResultSet $resultSet, $offset)
Definition: BasicSearchResultSetWidget.php:120
SpecialSearch
implements Special:Search - Run text & title search and display the output
Definition: SpecialSearch.php:38
Message\escaped
escaped()
Returns the message text.
Definition: Message.php:969
SearchResultSet\next
next()
Fetches next search result, or false.
Definition: SearchResultSet.php:178
MediaWiki\Widget\Search\BasicSearchResultSetWidget\$resultWidget
SearchResultWidget $resultWidget
Definition: BasicSearchResultSetWidget.php:18
as
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:22
Message
The Message class provides methods which fulfil two basic services:
Definition: Message.php:159
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57