MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
36  const SECONDARY_RESULTS = 0;
41  const INLINE_RESULTS = 1;
43  protected $containedSyntax = false;
50  private $titles;
57  private $results;
66  protected $extraData = [];
68  public function __construct( $containedSyntax = false ) {
69  $this->containedSyntax = $containedSyntax;
70  }
79  function termMatches() {
80  return [];
81  }
83  function numRows() {
84  return 0;
85  }
97  function getTotalHits() {
98  return null;
99  }
108  function hasRewrittenQuery() {
109  return false;
110  }
116  function getQueryAfterRewrite() {
117  return null;
118  }
125  return null;
126  }
134  function hasSuggestion() {
135  return false;
136  }
141  function getSuggestionQuery() {
142  return null;
143  }
148  function getSuggestionSnippet() {
149  return '';
150  }
157  function getInterwikiResults( $type = self::SECONDARY_RESULTS ) {
158  return null;
159  }
166  function hasInterwikiResults( $type = self::SECONDARY_RESULTS ) {
167  return false;
168  }
176  function next() {
177  return false;
178  }
183  function rewind() {
184  }
189  function free() {
190  // ...
191  }
199  public function searchContainedSyntax() {
200  return $this->containedSyntax;
201  }
207  public function extractResults() {
208  if ( is_null( $this->results ) ) {
209  $this->results = [];
210  if ( $this->numRows() == 0 ) {
211  // Don't bother if we've got empty result
212  return $this->results;
213  }
214  $this->rewind();
215  while ( ( $result = $this->next() ) != false ) {
216  $this->results[] = $result;
217  }
218  $this->rewind();
219  }
220  return $this->results;
221  }
227  public function extractTitles() {
228  if ( is_null( $this->titles ) ) {
229  if ( $this->numRows() == 0 ) {
230  // Don't bother if we've got empty result
231  $this->titles = [];
232  } else {
233  $this->titles = array_map(
234  function ( SearchResult $result ) {
235  return $result->getTitle();
236  },
237  $this->extractResults() );
238  }
239  }
240  return $this->titles;
241  }
248  public function setAugmentedData( $name, $data ) {
249  foreach ( $data as $id => $resultData ) {
250  $this->extraData[$id][$name] = $resultData;
251  }
252  }
259  public function augmentResult( SearchResult $result ) {
260  $id = $result->getTitle()->getArticleID();
261  if ( !$id || !isset( $this->extraData[$id] ) ) {
262  return null;
263  }
264  $result->setExtensionData( $this->extraData[$id] );
265  return $this->extraData[$id];
266  }
267 }
augmentResult(SearchResult $result)
Returns extra data for specific result and store it in SearchResult object.
Definition: SearchResultSet.php:259
Definition: SearchResultSet.php:116
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 '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. '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) '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 '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: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! 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:1954
Rewind result set back to beginning.
Definition: SearchResultSet.php:183
__construct( $containedSyntax=false)
Definition: SearchResultSet.php:68
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
getInterwikiResults( $type=self::SECONDARY_RESULTS)
Return a result set of hits on other (multiple) wikis associated with this one.
Definition: SearchResultSet.php:157
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 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:2536
Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a...
Definition: SearchResultSet.php:199
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:79
Title[] $titles
Cache of titles.
Definition: SearchResultSet.php:50
Definition: SearchResult.php:32
Definition: SearchResultSet.php:83
Definition: SearchResultSet.php:27
setAugmentedData( $name, $data)
Sets augmented data for result set.
Definition: SearchResultSet.php:248
Some search modes return a suggested alternate term if there are no exact hits.
Definition: SearchResultSet.php:134
array[] $extraData
Set of result's extra data, indexed per result id and then per data item name.
Definition: SearchResultSet.php:66
Definition: SearchResultSet.php:148
Extract all the results in the result set as array.
Definition: SearchResultSet.php:207
Some search modes return a total hit count for the query in the entire article database.
Definition: SearchResultSet.php:97
Some search modes will run an alternative query that it thinks gives a better result than the provide...
Definition: SearchResultSet.php:108
Frees the result set, if applicable.
Definition: SearchResultSet.php:189
Represents a title within MediaWiki.
Definition: Title.php:39
Fetches next search result, or false.
Definition: SearchResultSet.php:176
hasInterwikiResults( $type=self::SECONDARY_RESULTS)
Check if there are results on other wikis.
Definition: SearchResultSet.php:166
Definition: SearchResultSet.php:124
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
SearchResult[] $results
Cache of results - serialization of the result iterator as an array.
Definition: SearchResultSet.php:57
Definition: SearchResultSet.php:141
Extract all the titles in the result set.
Definition: SearchResultSet.php:227
Types of interwiki results.
Definition: SearchResultSet.php:43
the array() calling protocol came about after MediaWiki 1.4rc1.