MediaWiki  1.23.12
SearchResultSet.php
Go to the documentation of this file.
1 <?php
35  function termMatches() {
36  return array();
37  }
38 
39  function numRows() {
40  return 0;
41  }
42 
49  function hasResults() {
50  return false;
51  }
52 
63  function getTotalHits() {
64  return null;
65  }
66 
73  function hasSuggestion() {
74  return false;
75  }
76 
80  function getSuggestionQuery() {
81  return null;
82  }
83 
87  function getSuggestionSnippet() {
88  return '';
89  }
90 
96  function getInterwikiResults() {
97  return null;
98  }
99 
105  function hasInterwikiResults() {
106  return $this->getInterwikiResults() != null;
107  }
108 
115  function next() {
116  return false;
117  }
118 
122  function free() {
123  // ...
124  }
125 
131  public function searchContainedSyntax() {
132  return false;
133  }
134 }
135 
141 
142  protected $mResultSet;
143 
144  function __construct( $resultSet, $terms ) {
145  $this->mResultSet = $resultSet;
146  $this->mTerms = $terms;
147  }
148 
149  function termMatches() {
150  return $this->mTerms;
151  }
152 
153  function numRows() {
154  if ( $this->mResultSet === false ) {
155  return false;
156  }
157 
158  return $this->mResultSet->numRows();
159  }
160 
161  function next() {
162  if ( $this->mResultSet === false ) {
163  return false;
164  }
165 
166  $row = $this->mResultSet->fetchObject();
167  if ( $row === false ) {
168  return false;
169  }
170 
171  return SearchResult::newFromRow( $row );
172  }
173 
174  function free() {
175  if ( $this->mResultSet === false ) {
176  return false;
177  }
178 
179  $this->mResultSet->free();
180  }
181 }
182 
187  private $fetched = false;
188 
192  public function __construct( $match ) {
193  $this->result = $match;
194  }
195 
196  public function hasResult() {
197  return (bool)$this->result;
198  }
199 
200  public function numRows() {
201  return $this->hasResults() ? 1 : 0;
202  }
203 
204  public function next() {
205  if ( $this->fetched || !$this->result ) {
206  return false;
207  }
208  $this->fetched = true;
209  return SearchResult::newFromTitle( $this->result );
210  }
211 }
SqlSearchResultSet\free
free()
Frees the result set, if applicable.
Definition: SearchResultSet.php:174
$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. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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 '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) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
SearchNearMatchResultSet\numRows
numRows()
Definition: SearchResultSet.php:200
SearchNearMatchResultSet\hasResult
hasResult()
Definition: SearchResultSet.php:196
SearchNearMatchResultSet\next
next()
Fetches next search result, or false.
Definition: SearchResultSet.php:204
SearchResultSet\searchContainedSyntax
searchContainedSyntax()
Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a...
Definition: SearchResultSet.php:131
SearchResultSet\getInterwikiResults
getInterwikiResults()
Return a result set of hits on other (multiple) wikis associated with this one.
Definition: SearchResultSet.php:96
SearchResultSet\termMatches
termMatches()
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine...
Definition: SearchResultSet.php:35
SqlSearchResultSet\__construct
__construct( $resultSet, $terms)
Definition: SearchResultSet.php:144
SearchResultSet\hasResults
hasResults()
Return true if results are included in this result set.
Definition: SearchResultSet.php:49
SearchResultSet\numRows
numRows()
Definition: SearchResultSet.php:39
SqlSearchResultSet\$mResultSet
$mResultSet
Definition: SearchResultSet.php:142
SearchNearMatchResultSet
A SearchResultSet wrapper for SearchEngine::getNearMatch.
Definition: SearchResultSet.php:186
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
SearchResultSet
Definition: SearchResultSet.php:27
SqlSearchResultSet
This class is used for different SQL-based search engines shipped with MediaWiki.
Definition: SearchResultSet.php:140
SearchResultSet\hasSuggestion
hasSuggestion()
Some search modes return a suggested alternate term if there are no exact hits.
Definition: SearchResultSet.php:73
SearchResultSet\getSuggestionSnippet
getSuggestionSnippet()
Definition: SearchResultSet.php:87
SearchResultSet\getTotalHits
getTotalHits()
Some search modes return a total hit count for the query in the entire article database.
Definition: SearchResultSet.php:63
SqlSearchResultSet\termMatches
termMatches()
Fetch an array of regular expression fragments for matching the search terms as parsed by this engine...
Definition: SearchResultSet.php:149
SearchResultSet\free
free()
Frees the result set, if applicable.
Definition: SearchResultSet.php:122
SearchResultSet\hasInterwikiResults
hasInterwikiResults()
Check if there are results on other wikis.
Definition: SearchResultSet.php:105
SqlSearchResultSet\numRows
numRows()
Definition: SearchResultSet.php:153
SearchNearMatchResultSet\__construct
__construct( $match)
Definition: SearchResultSet.php:192
SearchResultSet\next
next()
Fetches next search result, or false.
Definition: SearchResultSet.php:115
SearchResult\newFromRow
static newFromRow( $row)
Return a new SearchResult and initializes it with a row.
Definition: SearchResult.php:66
SqlSearchResultSet\next
next()
Fetches next search result, or false.
Definition: SearchResultSet.php:161
SearchResultSet\getSuggestionQuery
getSuggestionQuery()
Definition: SearchResultSet.php:80
SearchResult\newFromTitle
static newFromTitle( $title)
Return a new SearchResult and initializes it with a title.
Definition: SearchResult.php:54
SearchNearMatchResultSet\$fetched
$fetched
Definition: SearchResultSet.php:187