MediaWiki  REL1_31
FullSearchResultWidget.php
Go to the documentation of this file.
1 <?php
2 
4 
6 use Hooks;
11 use Title;
12 
22  protected $specialPage;
24  protected $linkRenderer;
25 
27  $this->specialPage = $specialPage;
28  $this->linkRenderer = $linkRenderer;
29  }
30 
37  public function render( SearchResult $result, $terms, $position ) {
38  // If the page doesn't *exist*... our search index is out of date.
39  // The least confusing at this point is to drop the result.
40  // You may get less results, but... on well. :P
41  if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
42  return '';
43  }
44 
45  $link = $this->generateMainLinkHtml( $result, $terms, $position );
46  // If page content is not readable, just return ths title.
47  // This is not quite safe, but better than showing excerpts from
48  // non-readable pages. Note that hiding the entry entirely would
49  // screw up paging (really?).
50  if ( !$result->getTitle()->userCan( 'read', $this->specialPage->getUser() ) ) {
51  return "<li>{$link}</li>";
52  }
53 
54  $redirect = $this->generateRedirectHtml( $result );
55  $section = $this->generateSectionHtml( $result );
56  $category = $this->generateCategoryHtml( $result );
57  $date = $this->specialPage->getLanguage()->userTimeAndDate(
58  $result->getTimestamp(),
59  $this->specialPage->getUser()
60  );
61  list( $file, $desc, $thumb ) = $this->generateFileHtml( $result );
62  $snippet = $result->getTextSnippet( $terms );
63  if ( $snippet ) {
64  $extract = "<div class='searchresult'>$snippet</div>";
65  } else {
66  $extract = '';
67  }
68 
69  if ( $thumb === null ) {
70  // If no thumb, then the description is about size
71  $desc = $this->generateSizeHtml( $result );
72 
73  // Let hooks do their own final construction if desired.
74  // FIXME: Not sure why this is only for results without thumbnails,
75  // but keeping it as-is for now to prevent breaking hook consumers.
76  $html = null;
77  $score = '';
78  $related = '';
79  if ( !Hooks::run( 'ShowSearchHit', [
80  $this->specialPage, $result, $terms,
81  &$link, &$redirect, &$section, &$extract,
82  &$score, &$desc, &$date, &$related, &$html
83  ] ) ) {
84  return $html;
85  }
86  }
87 
88  // All the pieces have been collected. Now generate the final HTML
89  $joined = "{$link} {$redirect} {$category} {$section} {$file}";
90  $meta = $this->buildMeta( $desc, $date );
91 
92  if ( $thumb === null ) {
93  $html =
94  "<div class='mw-search-result-heading'>{$joined}</div>" .
95  "{$extract} {$meta}";
96  } else {
97  $html =
98  "<table class='searchResultImage'>" .
99  "<tr>" .
100  "<td style='width: 120px; text-align: center; vertical-align: top'>" .
101  $thumb .
102  "</td>" .
103  "<td style='vertical-align: top'>" .
104  "{$joined} {$extract} {$meta}" .
105  "</td>" .
106  "</tr>" .
107  "</table>";
108  }
109 
110  return "<li>{$html}</li>";
111  }
112 
124  protected function generateMainLinkHtml( SearchResult $result, $terms, $position ) {
125  $snippet = $result->getTitleSnippet();
126  if ( $snippet === '' ) {
127  $snippet = null;
128  } else {
129  $snippet = new HtmlArmor( $snippet );
130  }
131 
132  // clone to prevent hook from changing the title stored inside $result
133  $title = clone $result->getTitle();
134  $query = [];
135 
136  $attributes = [ 'data-serp-pos' => $position ];
137  Hooks::run( 'ShowSearchHitTitle',
138  [ &$title, &$snippet, $result, $terms, $this->specialPage, &$query, &$attributes ] );
139 
140  $link = $this->linkRenderer->makeLink(
141  $title,
142  $snippet,
143  $attributes,
144  $query
145  );
146 
147  return $link;
148  }
149 
160  protected function generateAltTitleHtml( $msgKey, Title $title = null, $text ) {
161  $inner = $title === null
162  ? $text
163  : $this->linkRenderer->makeLink( $title, $text ? new HtmlArmor( $text ) : null );
164 
165  return "<span class='searchalttitle'>" .
166  $this->specialPage->msg( $msgKey )->rawParams( $inner )->parse()
167  . "</span>";
168  }
169 
174  protected function generateRedirectHtml( SearchResult $result ) {
175  $title = $result->getRedirectTitle();
176  return $title === null
177  ? ''
178  : $this->generateAltTitleHtml( 'search-redirect', $title, $result->getRedirectSnippet() );
179  }
180 
185  protected function generateSectionHtml( SearchResult $result ) {
186  $title = $result->getSectionTitle();
187  return $title === null
188  ? ''
189  : $this->generateAltTitleHtml( 'search-section', $title, $result->getSectionSnippet() );
190  }
191 
196  protected function generateCategoryHtml( SearchResult $result ) {
197  $snippet = $result->getCategorySnippet();
198  return $snippet
199  ? $this->generateAltTitleHtml( 'search-category', null, $snippet )
200  : '';
201  }
202 
207  protected function generateSizeHtml( SearchResult $result ) {
208  $title = $result->getTitle();
209  if ( $title->getNamespace() === NS_CATEGORY ) {
210  $cat = Category::newFromTitle( $title );
211  return $this->specialPage->msg( 'search-result-category-size' )
212  ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
213  ->escaped();
214  // TODO: This is a bit odd...but requires changing the i18n message to fix
215  } elseif ( $result->getByteSize() !== null || $result->getWordCount() > 0 ) {
216  $lang = $this->specialPage->getLanguage();
217  $bytes = $lang->formatSize( $result->getByteSize() );
218  $words = $result->getWordCount();
219 
220  return $this->specialPage->msg( 'search-result-size', $bytes )
221  ->numParams( $words )
222  ->escaped();
223  }
224 
225  return '';
226  }
227 
234  protected function generateFileHtml( SearchResult $result ) {
235  $title = $result->getTitle();
236  if ( $title->getNamespace() !== NS_FILE ) {
237  return [ '', null, null ];
238  }
239 
240  if ( $result->isFileMatch() ) {
241  $html = "<span class='searchalttitle'>" .
242  $this->specialPage->msg( 'search-file-match' )->escaped() .
243  "</span>";
244  } else {
245  $html = '';
246  }
247 
248  $descHtml = null;
249  $thumbHtml = null;
250 
251  $img = $result->getFile() ?: wfFindFile( $title );
252  if ( $img ) {
253  $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
254  if ( $thumb ) {
255  $descHtml = $this->specialPage->msg( 'parentheses' )
256  ->rawParams( $img->getShortDesc() )
257  ->escaped();
258  $thumbHtml = $thumb->toHtml( [ 'desc-link' => true ] );
259  }
260  }
261 
262  return [ $html, $descHtml, $thumbHtml ];
263  }
264 
272  protected function buildMeta( $desc, $date ) {
273  if ( $desc && $date ) {
274  $meta = "{$desc} - {$date}";
275  } elseif ( $desc ) {
276  $meta = $desc;
277  } elseif ( $date ) {
278  $meta = $date;
279  } else {
280  return '';
281  }
282 
283  return "<div class='mw-search-result-data'>{$meta}</div>";
284  }
285 }
MediaWiki\Widget\Search\FullSearchResultWidget\$specialPage
SpecialSearch $specialPage
Definition: FullSearchResultWidget.php:22
MediaWiki\Widget\Search\FullSearchResultWidget\generateMainLinkHtml
generateMainLinkHtml(SearchResult $result, $terms, $position)
Generates HTML for the primary call to action.
Definition: FullSearchResultWidget.php:124
MediaWiki\Widget\Search\FullSearchResultWidget\generateAltTitleHtml
generateAltTitleHtml( $msgKey, Title $title=null, $text)
Generates an alternate title link, such as (redirect from Foo).
Definition: FullSearchResultWidget.php:160
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$html
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:2013
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
MediaWiki\Linker\LinkRenderer
Class that generates HTML links for pages.
Definition: LinkRenderer.php:41
MediaWiki\Widget\Search\FullSearchResultWidget\generateCategoryHtml
generateCategoryHtml(SearchResult $result)
Definition: FullSearchResultWidget.php:196
MediaWiki\Widget\Search
Definition: BasicSearchResultSetWidget.php:3
Category
Category objects are immutable, strictly speaking.
Definition: Category.php:31
NS_FILE
const NS_FILE
Definition: Defines.php:80
SearchResult\getSectionSnippet
getSectionSnippet()
Definition: SearchResult.php:195
$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\FullSearchResultWidget\generateRedirectHtml
generateRedirectHtml(SearchResult $result)
Definition: FullSearchResultWidget.php:174
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
MediaWiki\Widget\Search\FullSearchResultWidget\$linkRenderer
LinkRenderer $linkRenderer
Definition: FullSearchResultWidget.php:24
SearchResult
Definition: SearchResult.php:32
MediaWiki\Widget\Search\FullSearchResultWidget\buildMeta
buildMeta( $desc, $date)
Definition: FullSearchResultWidget.php:272
MediaWiki\Widget\Search\FullSearchResultWidget\__construct
__construct(SpecialSearch $specialPage, LinkRenderer $linkRenderer)
Definition: FullSearchResultWidget.php:26
MediaWiki\Widget\Search\SearchResultWidget
Renders a single search result to HTML.
Definition: SearchResultWidget.php:10
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:88
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
MediaWiki\Widget\Search\FullSearchResultWidget\generateSectionHtml
generateSectionHtml(SearchResult $result)
Definition: FullSearchResultWidget.php:185
Category\newFromTitle
static newFromTitle( $title)
Factory function.
Definition: Category.php:146
SpecialSearch
implements Special:Search - Run text & title search and display the output
Definition: SpecialSearch.php:38
MediaWiki\Widget\Search\FullSearchResultWidget
Renders a 'full' multi-line search result with metadata.
Definition: FullSearchResultWidget.php:20
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2853
SearchResult\getRedirectSnippet
getRedirectSnippet()
Definition: SearchResult.php:181
MediaWiki\Widget\Search\FullSearchResultWidget\generateSizeHtml
generateSizeHtml(SearchResult $result)
Definition: FullSearchResultWidget.php:207
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3022
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1620
MediaWiki\Widget\Search\FullSearchResultWidget\generateFileHtml
generateFileHtml(SearchResult $result)
Definition: FullSearchResultWidget.php:234
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
Hooks
Hooks class.
Definition: Hooks.php:34
MediaWiki\Widget\Search\FullSearchResultWidget\render
render(SearchResult $result, $terms, $position)
Definition: FullSearchResultWidget.php:37