MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
27 class SearchResultSet implements Countable, IteratorAggregate {
35  const SECONDARY_RESULTS = 0;
40  const INLINE_RESULTS = 1;
42  protected $containedSyntax = false;
49  private $titles;
56  protected $results;
65  protected $extraData = [];
70  private $hasMoreResults;
75  private $bcIterator;
83  public function __construct( $containedSyntax = false, $hasMoreResults = false ) {
84  if ( static::class === self::class ) {
85  // This class will eventually be abstract. SearchEngine implementations
86  // already have to extend this class anyways to provide the actual
87  // search results.
88  wfDeprecated( __METHOD__, 1.32 );
89  }
90  $this->containedSyntax = $containedSyntax;
92  }
101  function termMatches() {
102  return [];
103  }
105  function numRows() {
106  return $this->count();
107  }
109  final public function count() {
110  return count( $this->extractResults() );
111  }
123  function getTotalHits() {
124  return null;
125  }
134  function hasRewrittenQuery() {
135  return false;
136  }
142  function getQueryAfterRewrite() {
143  return null;
144  }
151  return null;
152  }
160  function hasSuggestion() {
161  return false;
162  }
167  function getSuggestionQuery() {
168  return null;
169  }
174  function getSuggestionSnippet() {
175  return '';
176  }
184  function getInterwikiResults( $type = self::SECONDARY_RESULTS ) {
185  return null;
186  }
194  function hasInterwikiResults( $type = self::SECONDARY_RESULTS ) {
195  return false;
196  }
203  public function next() {
204  wfDeprecated( __METHOD__, '1.32' );
205  $it = $this->bcIterator();
206  $searchResult = $it->current();
207  $it->next();
208  return $searchResult ?? false;
209  }
215  public function rewind() {
216  wfDeprecated( __METHOD__, '1.32' );
217  $this->bcIterator()->rewind();
218  }
220  private function bcIterator() {
221  if ( $this->bcIterator === null ) {
222  $this->bcIterator = 'RECURSION';
223  $this->bcIterator = $this->getIterator();
224  } elseif ( $this->bcIterator === 'RECURSION' ) {
225  // Either next/rewind or extractResults must be implemented. This
226  // class was potentially instantiated directly. It should be
227  // abstract with abstract methods to enforce this but that's a
228  // breaking change...
229  wfDeprecated( static::class . ' without implementing extractResults', '1.32' );
230  $this->bcIterator = new ArrayIterator( [] );
231  }
232  return $this->bcIterator;
233  }
238  function free() {
239  // ...
240  }
248  public function searchContainedSyntax() {
249  return $this->containedSyntax;
250  }
255  public function hasMoreResults() {
256  return $this->hasMoreResults;
257  }
263  public function shrink( $limit ) {
264  if ( $this->count() > $limit ) {
265  $this->hasMoreResults = true;
266  // shrinking result set for implementations that
267  // have not implemented extractResults and use
268  // the default cache location. Other implementations
269  // must override this as well.
270  if ( is_array( $this->results ) ) {
271  $this->results = array_slice( $this->results, 0, $limit );
272  } else {
273  throw new \UnexpectedValueException(
274  "When overriding result store extending classes must "
275  . " also override " . __METHOD__ );
276  }
277  }
278  }
284  public function extractResults() {
285  if ( is_null( $this->results ) ) {
286  $this->results = [];
287  if ( $this->numRows() == 0 ) {
288  // Don't bother if we've got empty result
289  return $this->results;
290  }
291  $this->rewind();
292  while ( ( $result = $this->next() ) != false ) {
293  $this->results[] = $result;
294  }
295  $this->rewind();
296  }
297  return $this->results;
298  }
304  public function extractTitles() {
305  if ( is_null( $this->titles ) ) {
306  if ( $this->numRows() == 0 ) {
307  // Don't bother if we've got empty result
308  $this->titles = [];
309  } else {
310  $this->titles = array_map(
311  function ( SearchResult $result ) {
312  return $result->getTitle();
313  },
314  $this->extractResults() );
315  }
316  }
317  return $this->titles;
318  }
325  public function setAugmentedData( $name, $data ) {
326  foreach ( $data as $id => $resultData ) {
327  $this->extraData[$id][$name] = $resultData;
328  }
329  }
335  public function augmentResult( SearchResult $result ) {
336  $id = $result->getTitle()->getArticleID();
337  if ( $id === -1 ) {
338  return;
339  }
340  $result->setExtensionData( function () use ( $id ) {
341  return $this->extraData[$id] ?? [];
342  } );
343  }
351  public function getOffset() {
352  return null;
353  }
355  final public function getIterator() {
356  return new ArrayIterator( $this->extractResults() );
357  }
358 }
augmentResult(SearchResult $result)
Returns extra data for specific result and store it in SearchResult object.
Definition: SearchResultSet.php:335
Definition: SearchResultSet.php:109
Definition: SearchResultSet.php:142
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 '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. '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 '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 since 1.28! 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:1983
Rewind result set back to beginning.
Definition: SearchResultSet.php:215
__construct( $containedSyntax=false, $hasMoreResults=false)
Definition: SearchResultSet.php:83
ArrayIterator null $bcIterator
Iterator supporting BC iteration methods.
Definition: SearchResultSet.php:75
getInterwikiResults( $type=self::SECONDARY_RESULTS)
Return a result set of hits on other (multiple) wikis associated with this one.
Definition: SearchResultSet.php:184
Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a...
Definition: SearchResultSet.php:248
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
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine...
Definition: SearchResultSet.php:101
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
Title[] $titles
Cache of titles.
Definition: SearchResultSet.php:49
Definition: SearchResult.php:32
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1078
Definition: SearchResultSet.php:105
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: SearchResultSet.php:27
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("", 2))
setAugmentedData( $name, $data)
Sets augmented data for result set.
Definition: SearchResultSet.php:325
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Some search modes return a suggested alternate term if there are no exact hits.
Definition: SearchResultSet.php:160
Definition: SearchResultSet.php:220
array[] $extraData
Set of result's extra data, indexed per result id and then per data item name.
Definition: SearchResultSet.php:65
Definition: SearchResultSet.php:174
Extract all the results in the result set as array.
Definition: SearchResultSet.php:284
Some search modes return a total hit count for the query in the entire article database.
Definition: SearchResultSet.php:123
Some search modes will run an alternative query that it thinks gives a better result than the provide...
Definition: SearchResultSet.php:134
Frees the result set, if applicable.
Definition: SearchResultSet.php:238
Definition: SearchResultSet.php:355
Represents a title within MediaWiki.
Definition: Title.php:40
Fetches next search result, or false.
Definition: SearchResultSet.php:203
hasInterwikiResults( $type=self::SECONDARY_RESULTS)
Check if there are results on other wikis.
Definition: SearchResultSet.php:194
boolean $hasMoreResults
True when there are more pages of search results available.
Definition: SearchResultSet.php:70
shrink( $limit)
Definition: SearchResultSet.php:263
Definition: SearchResultSet.php:150
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
Definition: SearchResultSet.php:351
SearchResult[] $results
Cache of results - serialization of the result iterator as an array.
Definition: SearchResultSet.php:56
Definition: SearchResultSet.php:255
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Definition: SearchResultSet.php:167
Extract all the titles in the result set.
Definition: SearchResultSet.php:304
Types of interwiki results.
Definition: SearchResultSet.php:42
Definition: testCompression.php:48