MediaWiki  master
SearchSuggestionSet.php
Go to the documentation of this file.
1 <?php
2 
30  private $suggestions = [];
31 
36  private $pageMap = [];
37 
41  private $hasMoreResults;
42 
55  public function __construct( array $suggestions, $hasMoreResults = false ) {
57  foreach ( $suggestions as $suggestion ) {
58  $pageID = $suggestion->getSuggestedTitleID();
59  if ( $pageID && empty( $this->pageMap[$pageID] ) ) {
60  $this->pageMap[$pageID] = true;
61  }
62  $this->suggestions[] = $suggestion;
63  }
64  }
65 
69  public function hasMoreResults() {
70  return $this->hasMoreResults;
71  }
72 
77  public function getSuggestions() {
78  return $this->suggestions;
79  }
80 
86  public function map( $callback ) {
87  return array_map( $callback, $this->suggestions );
88  }
89 
96  public function filter( $callback ) {
97  $before = count( $this->suggestions );
98  $this->suggestions = array_values( array_filter( $this->suggestions, $callback ) );
99  return $before - count( $this->suggestions );
100  }
101 
109  public function append( SearchSuggestion $suggestion ) {
110  $pageID = $suggestion->getSuggestedTitleID();
111  if ( $pageID && isset( $this->pageMap[$pageID] ) ) {
112  return;
113  }
114  if ( $this->getSize() > 0 && $suggestion->getScore() >= $this->getWorstScore() ) {
115  $suggestion->setScore( $this->getWorstScore() - 1 );
116  }
117  $this->suggestions[] = $suggestion;
118  if ( $pageID ) {
119  $this->pageMap[$pageID] = true;
120  }
121  }
122 
127  public function appendAll( SearchSuggestionSet $set ) {
128  foreach ( $set->getSuggestions() as $sugg ) {
129  $this->append( $sugg );
130  }
131  }
132 
137  public function rescore( $key ) {
138  $removed = array_splice( $this->suggestions, $key, 1 );
139  unset( $this->pageMap[$removed[0]->getSuggestedTitleID()] );
140  $this->prepend( $removed[0] );
141  }
142 
148  public function prepend( SearchSuggestion $suggestion ) {
149  $pageID = $suggestion->getSuggestedTitleID();
150  if ( $pageID && isset( $this->pageMap[$pageID] ) ) {
151  return;
152  }
153  if ( $this->getSize() > 0 && $suggestion->getScore() <= $this->getBestScore() ) {
154  $suggestion->setScore( $this->getBestScore() + 1 );
155  }
156  array_unshift( $this->suggestions, $suggestion );
157  if ( $pageID ) {
158  $this->pageMap[$pageID] = true;
159  }
160  }
161 
165  public function getBestScore() {
166  if ( empty( $this->suggestions ) ) {
167  return 0;
168  }
169  return $this->suggestions[0]->getScore();
170  }
171 
175  public function getWorstScore() {
176  if ( empty( $this->suggestions ) ) {
177  return 0;
178  }
179  return end( $this->suggestions )->getScore();
180  }
181 
185  public function getSize() {
186  return count( $this->suggestions );
187  }
188 
193  public function shrink( $limit ) {
194  if ( count( $this->suggestions ) > $limit ) {
195  $this->suggestions = array_slice( $this->suggestions, 0, $limit );
196  $this->hasMoreResults = true;
197  }
198  }
199 
210  public static function fromTitles( array $titles, $hasMoreResults = false ) {
211  $score = count( $titles );
212  $suggestions = array_map( function ( $title ) use ( &$score ) {
213  return SearchSuggestion::fromTitle( $score--, $title );
214  }, $titles );
216  }
217 
227  public static function fromStrings( array $titles, $hasMoreResults = false ) {
228  $score = count( $titles );
229  $suggestions = array_map( function ( $title ) use ( &$score ) {
230  return SearchSuggestion::fromText( $score--, $title );
231  }, $titles );
233  }
234 
238  public static function emptySuggestionSet() {
239  return new SearchSuggestionSet( [] );
240  }
241 }
Search suggestion.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getScore()
Suggestion score.
static fromStrings(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a string array.
prepend(SearchSuggestion $suggestion)
Add a new suggestion at the top.
append(SearchSuggestion $suggestion)
Add a new suggestion at the end.
static fromText( $score, $text)
Create suggestion from text Will also create a title if text if not empty.
bool $hasMoreResults
Are more results available?
__construct(array $suggestions, $hasMoreResults=false)
Builds a new set of suggestions.
filter( $callback)
Filter the suggestions array.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
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
rescore( $key)
Move the suggestion at index $key to the first position.
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
setScore( $score)
Set the suggestion score.
static fromTitle( $score, Title $title)
Create suggestion from Title.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
getSuggestions()
Get the list of suggestions.
SearchSuggestion [] $suggestions
static fromTitles(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a title array.
Search suggestion sets.
getSuggestedTitleID()
Title ID in the case this suggestion is based on a title.
map( $callback)
Call array_map on the suggestions array.
shrink( $limit)
Remove any extra elements in the suggestions set.
appendAll(SearchSuggestionSet $set)
Add suggestion set to the end of the current one.