MediaWiki  master
DidYouMeanWidget.php
Go to the documentation of this file.
1 <?php
2 
4 
8 
15  protected $specialSearch;
16 
18  $this->specialSearch = $specialSearch;
19  }
20 
26  public function render( $term, ISearchResultSet $resultSet ) {
27  if ( $resultSet->hasRewrittenQuery() ) {
28  $html = $this->rewrittenHtml( $term, $resultSet );
29  } elseif ( $resultSet->hasSuggestion() ) {
30  $html = $this->suggestionHtml( $resultSet );
31  } else {
32  return '';
33  }
34 
35  return "<div class='searchdidyoumean'>$html</div>";
36  }
37 
47  protected function rewrittenHtml( $term, ISearchResultSet $resultSet ) {
48  $params = [
49  'search' => $resultSet->getQueryAfterRewrite(),
50  // Don't magic this link into a 'go' link, it should always
51  // show search results.
52  'fulltext' => 1,
53  ];
54  $stParams = array_merge( $params, $this->specialSearch->powerSearchOptions() );
55 
56  $linkRenderer = $this->specialSearch->getLinkRenderer();
57  $snippet = $resultSet->getQueryAfterRewriteSnippet();
58  $rewritten = $linkRenderer->makeKnownLink(
59  $this->specialSearch->getPageTitle(),
60  $snippet ? new HtmlArmor( $snippet ) : null,
61  [ 'id' => 'mw-search-DYM-rewritten' ],
62  $stParams
63  );
64 
65  $stParams['search'] = $term;
66  $stParams['runsuggestion'] = 0;
67  $original = $linkRenderer->makeKnownLink(
68  $this->specialSearch->getPageTitle(),
69  $term,
70  [ 'id' => 'mw-search-DYM-original' ],
71  $stParams
72  );
73 
74  return $this->specialSearch->msg( 'search-rewritten' )
75  ->rawParams( $rewritten, $original )
76  ->escaped();
77  }
78 
87  protected function suggestionHtml( ISearchResultSet $resultSet ) {
88  $params = [
89  'search' => $resultSet->getSuggestionQuery(),
90  'fulltext' => 1,
91  ];
92  $stParams = array_merge( $params, $this->specialSearch->powerSearchOptions() );
93 
94  $snippet = $resultSet->getSuggestionSnippet();
95  $suggest = $this->specialSearch->getLinkRenderer()->makeKnownLink(
96  $this->specialSearch->getPageTitle(),
97  $snippet ? new HtmlArmor( $snippet ) : null,
98  [ 'id' => 'mw-search-DYM-suggestion' ],
99  $stParams
100  );
101 
102  return $this->specialSearch->msg( 'search-suggest' )
103  ->rawParams( $suggest )->parse();
104  }
105 }
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:1972
whereas SearchGetNearMatch runs after $term
Definition: hooks.txt:2863
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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 after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:1972
__construct(SpecialSearch $specialSearch)
hasRewrittenQuery()
Some search modes will run an alternative query that it thinks gives a better result than the provide...
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
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
suggestionHtml(ISearchResultSet $resultSet)
Generates HTML shown to the user when we have a suggestion about a query that might give more/better ...
render( $term, ISearchResultSet $resultSet)
hasSuggestion()
Some search modes return a suggested alternate term if there are no exact hits.
Renders a suggested search for the user, or tells the user a suggested search was run instead of the ...
rewrittenHtml( $term, ISearchResultSet $resultSet)
Generates HTML shown to user when their query has been internally rewritten, and the results of the r...