MediaWiki  1.27.2
SearchResultSet.php
Go to the documentation of this file.
1 <?php
28 
36  const SECONDARY_RESULTS = 0;
41  const INLINE_RESULTS = 1;
42 
43  protected $containedSyntax = false;
44 
45  public function __construct( $containedSyntax = false ) {
46  $this->containedSyntax = $containedSyntax;
47  }
48 
56  function termMatches() {
57  return [];
58  }
59 
60  function numRows() {
61  return 0;
62  }
63 
74  function getTotalHits() {
75  return null;
76  }
77 
85  function hasRewrittenQuery() {
86  return false;
87  }
88 
93  function getQueryAfterRewrite() {
94  return null;
95  }
96 
102  return null;
103  }
104 
111  function hasSuggestion() {
112  return false;
113  }
114 
118  function getSuggestionQuery() {
119  return null;
120  }
121 
125  function getSuggestionSnippet() {
126  return '';
127  }
128 
134  function getInterwikiResults( $type = self::SECONDARY_RESULTS ) {
135  return null;
136  }
137 
143  function hasInterwikiResults( $type = self::SECONDARY_RESULTS ) {
144  return false;
145  }
146 
153  function next() {
154  return false;
155  }
156 
160  function rewind() {
161  }
162 
166  function free() {
167  // ...
168  }
169 
176  public function searchContainedSyntax() {
177  return $this->containedSyntax;
178  }
179 }
hasSuggestion()
Some search modes return a suggested alternate term if there are no exact hits.
hasRewrittenQuery()
Some search modes will run an alternative query that it thinks gives a better result than the provide...
getInterwikiResults($type=self::SECONDARY_RESULTS)
Return a result set of hits on other (multiple) wikis associated with this one.
searchContainedSyntax()
Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a...
free()
Frees the result set, if applicable.
next()
Fetches next search result, or false.
getTotalHits()
Some search modes return a total hit count for the query in the entire article database.
hasInterwikiResults($type=self::SECONDARY_RESULTS)
Check if there are results on other wikis.
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
$containedSyntax
Types of interwiki results.
rewind()
Rewind result set back to begining.
__construct($containedSyntax=false)
termMatches()
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2338