MediaWiki  master
ApiQuerySearch.php
Go to the documentation of this file.
1 <?php
29  use SearchApi;
30 
32  private $allowedParams;
33 
34  public function __construct( ApiQuery $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'sr' );
36  }
37 
38  public function execute() {
39  $this->run();
40  }
41 
42  public function executeGenerator( $resultPageSet ) {
43  $this->run( $resultPageSet );
44  }
45 
50  private function run( $resultPageSet = null ) {
51  $params = $this->extractRequestParams();
52 
53  // Extract parameters
54  $query = $params['search'];
55  $what = $params['what'];
56  $interwiki = $params['interwiki'];
57  $searchInfo = array_flip( $params['info'] );
58  $prop = array_flip( $params['prop'] );
59 
60  // Create search engine instance and set options
61  $search = $this->buildSearchEngine( $params );
62  if ( isset( $params['sort'] ) ) {
63  $search->setSort( $params['sort'] );
64  }
65  $search->setFeatureData( 'rewrite', (bool)$params['enablerewrites'] );
66  $search->setFeatureData( 'interwiki', (bool)$interwiki );
67 
68  $nquery = $search->replacePrefixes( $query );
69  if ( $nquery !== $query ) {
70  $query = $nquery;
71  wfDeprecated( 'SearchEngine::replacePrefixes() (overridden by ' .
72  get_class( $search ) . ')', '1.32' );
73  }
74  // Perform the actual search
75  if ( $what == 'text' ) {
76  $matches = $search->searchText( $query );
77  } elseif ( $what == 'title' ) {
78  $matches = $search->searchTitle( $query );
79  } elseif ( $what == 'nearmatch' ) {
80  // near matches must receive the user input as provided, otherwise
81  // the near matches within namespaces are lost.
82  $matches = $search->getNearMatcher( $this->getConfig() )
83  ->getNearMatchResultSet( $params['search'] );
84  } else {
85  // We default to title searches; this is a terrible legacy
86  // of the way we initially set up the MySQL fulltext-based
87  // search engine with separate title and text fields.
88  // In the future, the default should be for a combined index.
89  $what = 'title';
90  $matches = $search->searchTitle( $query );
91 
92  // Not all search engines support a separate title search,
93  // for instance the Lucene-based engine we use on Wikipedia.
94  // In this case, fall back to full-text search (which will
95  // include titles in it!)
96  if ( is_null( $matches ) ) {
97  $what = 'text';
98  $matches = $search->searchText( $query );
99  }
100  }
101 
102  if ( $matches instanceof Status ) {
103  $status = $matches;
104  $matches = $status->getValue();
105  } else {
106  $status = null;
107  }
108 
109  if ( $status ) {
110  if ( $status->isOK() ) {
111  $this->getMain()->getErrorFormatter()->addMessagesFromStatus(
112  $this->getModuleName(),
113  $status
114  );
115  } else {
116  $this->dieStatus( $status );
117  }
118  } elseif ( is_null( $matches ) ) {
119  $this->dieWithError( [ 'apierror-searchdisabled', $what ], "search-{$what}-disabled" );
120  }
121 
122  if ( $resultPageSet === null ) {
123  $apiResult = $this->getResult();
124  // Add search meta data to result
125  if ( isset( $searchInfo['totalhits'] ) ) {
126  $totalhits = $matches->getTotalHits();
127  if ( $totalhits !== null ) {
128  $apiResult->addValue( [ 'query', 'searchinfo' ],
129  'totalhits', $totalhits );
130  }
131  }
132  if ( isset( $searchInfo['suggestion'] ) && $matches->hasSuggestion() ) {
133  $apiResult->addValue( [ 'query', 'searchinfo' ],
134  'suggestion', $matches->getSuggestionQuery() );
135  $apiResult->addValue( [ 'query', 'searchinfo' ],
136  'suggestionsnippet', $matches->getSuggestionSnippet() );
137  }
138  if ( isset( $searchInfo['rewrittenquery'] ) && $matches->hasRewrittenQuery() ) {
139  $apiResult->addValue( [ 'query', 'searchinfo' ],
140  'rewrittenquery', $matches->getQueryAfterRewrite() );
141  $apiResult->addValue( [ 'query', 'searchinfo' ],
142  'rewrittenquerysnippet', $matches->getQueryAfterRewriteSnippet() );
143  }
144  }
145 
146  $titles = [];
147  $count = 0;
148 
149  if ( $matches->hasMoreResults() ) {
150  $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
151  }
152 
153  foreach ( $matches as $result ) {
154  $count++;
155  // Silently skip broken and missing titles
156  if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
157  continue;
158  }
159 
160  if ( $resultPageSet === null ) {
161  $vals = $this->getSearchResultData( $result, $prop );
162  if ( $vals ) {
163  // Add item to results and see whether it fits
164  $fit = $apiResult->addValue( [ 'query', $this->getModuleName() ], null, $vals );
165  if ( !$fit ) {
166  $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
167  break;
168  }
169  }
170  } else {
171  $titles[] = $result->getTitle();
172  }
173  }
174 
175  // Here we assume interwiki results do not count with
176  // regular search results. We may want to reconsider this
177  // if we ever return a lot of interwiki results or want pagination
178  // for them.
179  // Interwiki results inside main result set
180  $canAddInterwiki = (bool)$params['enablerewrites'] && ( $resultPageSet === null );
181  if ( $canAddInterwiki ) {
182  $this->addInterwikiResults( $matches, $apiResult, $prop, 'additional',
184  }
185 
186  // Interwiki results outside main result set
187  if ( $interwiki && $resultPageSet === null ) {
188  $this->addInterwikiResults( $matches, $apiResult, $prop, 'interwiki',
190  }
191 
192  if ( $resultPageSet === null ) {
193  $apiResult->addIndexedTagName( [
194  'query', $this->getModuleName()
195  ], 'p' );
196  } else {
197  $resultPageSet->setRedirectMergePolicy( function ( $current, $new ) {
198  if ( !isset( $current['index'] ) || $new['index'] < $current['index'] ) {
199  $current['index'] = $new['index'];
200  }
201  return $current;
202  } );
203  $resultPageSet->populateFromTitles( $titles );
204  $offset = $params['offset'] + 1;
205  foreach ( $titles as $index => $title ) {
206  $resultPageSet->setGeneratorData( $title, [ 'index' => $index + $offset ] );
207  }
208  }
209  }
210 
217  private function getSearchResultData( SearchResult $result, $prop ) {
218  // Silently skip broken and missing titles
219  if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
220  return null;
221  }
222 
223  $vals = [];
224 
225  $title = $result->getTitle();
227  $vals['pageid'] = $title->getArticleID();
228 
229  if ( isset( $prop['size'] ) ) {
230  $vals['size'] = $result->getByteSize();
231  }
232  if ( isset( $prop['wordcount'] ) ) {
233  $vals['wordcount'] = $result->getWordCount();
234  }
235  if ( isset( $prop['snippet'] ) ) {
236  $vals['snippet'] = $result->getTextSnippet();
237  }
238  if ( isset( $prop['timestamp'] ) ) {
239  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $result->getTimestamp() );
240  }
241  if ( isset( $prop['titlesnippet'] ) ) {
242  $vals['titlesnippet'] = $result->getTitleSnippet();
243  }
244  if ( isset( $prop['categorysnippet'] ) ) {
245  $vals['categorysnippet'] = $result->getCategorySnippet();
246  }
247  if ( !is_null( $result->getRedirectTitle() ) ) {
248  if ( isset( $prop['redirecttitle'] ) ) {
249  $vals['redirecttitle'] = $result->getRedirectTitle()->getPrefixedText();
250  }
251  if ( isset( $prop['redirectsnippet'] ) ) {
252  $vals['redirectsnippet'] = $result->getRedirectSnippet();
253  }
254  }
255  if ( !is_null( $result->getSectionTitle() ) ) {
256  if ( isset( $prop['sectiontitle'] ) ) {
257  $vals['sectiontitle'] = $result->getSectionTitle()->getFragment();
258  }
259  if ( isset( $prop['sectionsnippet'] ) ) {
260  $vals['sectionsnippet'] = $result->getSectionSnippet();
261  }
262  }
263  if ( isset( $prop['isfilematch'] ) ) {
264  $vals['isfilematch'] = $result->isFileMatch();
265  }
266 
267  if ( isset( $prop['extensiondata'] ) ) {
268  $extra = $result->getExtensionData();
269  // Add augmented data to the result. The data would be organized as a map:
270  // augmentorName => data
271  if ( $extra ) {
272  $vals['extensiondata'] = ApiResult::addMetadataToResultVars( $extra );
273  }
274  }
275 
276  return $vals;
277  }
278 
288  private function addInterwikiResults(
289  ISearchResultSet $matches, ApiResult $apiResult, $prop,
290  $section, $type
291  ) {
292  $totalhits = null;
293  if ( $matches->hasInterwikiResults( $type ) ) {
294  foreach ( $matches->getInterwikiResults( $type ) as $interwikiMatches ) {
295  // Include number of results if requested
296  $totalhits += $interwikiMatches->getTotalHits();
297 
298  foreach ( $interwikiMatches as $result ) {
299  $title = $result->getTitle();
300  $vals = $this->getSearchResultData( $result, $prop );
301 
302  $vals['namespace'] = $result->getInterwikiNamespaceText();
303  $vals['title'] = $title->getText();
304  $vals['url'] = $title->getFullURL();
305 
306  // Add item to results and see whether it fits
307  $fit = $apiResult->addValue( [
308  'query',
309  $section . $this->getModuleName(),
310  $result->getInterwikiPrefix()
311  ], null, $vals );
312 
313  if ( !$fit ) {
314  // We hit the limit. We can't really provide any meaningful
315  // pagination info so just bail out
316  break;
317  }
318  }
319  }
320  if ( $totalhits !== null ) {
321  $apiResult->addValue( [ 'query', $section . 'searchinfo' ], 'totalhits', $totalhits );
322  $apiResult->addIndexedTagName( [
323  'query', $section . $this->getModuleName()
324  ], 'p' );
325  }
326  }
327  return $totalhits;
328  }
329 
330  public function getCacheMode( $params ) {
331  return 'public';
332  }
333 
334  public function getAllowedParams() {
335  if ( $this->allowedParams !== null ) {
336  return $this->allowedParams;
337  }
338 
339  $this->allowedParams = $this->buildCommonApiParams() + [
340  'what' => [
342  'title',
343  'text',
344  'nearmatch',
345  ]
346  ],
347  'info' => [
348  ApiBase::PARAM_DFLT => 'totalhits|suggestion|rewrittenquery',
350  'totalhits',
351  'suggestion',
352  'rewrittenquery',
353  ],
354  ApiBase::PARAM_ISMULTI => true,
355  ],
356  'prop' => [
357  ApiBase::PARAM_DFLT => 'size|wordcount|timestamp|snippet',
359  'size',
360  'wordcount',
361  'timestamp',
362  'snippet',
363  'titlesnippet',
364  'redirecttitle',
365  'redirectsnippet',
366  'sectiontitle',
367  'sectionsnippet',
368  'isfilematch',
369  'categorysnippet',
370  'score', // deprecated
371  'hasrelated', // deprecated
372  'extensiondata',
373  ],
374  ApiBase::PARAM_ISMULTI => true,
377  'score' => true,
378  'hasrelated' => true
379  ],
380  ],
381  'interwiki' => false,
382  'enablerewrites' => false,
383  ];
384 
385  // If we have more than one engine the list of available sorts is
386  // difficult to represent. For now don't expose it.
388  $alternatives = $services
389  ->getSearchEngineConfig()
390  ->getSearchTypes();
391  if ( count( $alternatives ) == 1 ) {
392  $this->allowedParams['sort'] = [
393  ApiBase::PARAM_DFLT => 'relevance',
395  ->newSearchEngine()
396  ->getValidSorts(),
397  ];
398  }
399 
400  return $this->allowedParams;
401  }
402 
403  public function getSearchProfileParams() {
404  return [
405  'qiprofile' => [
407  'help-message' => 'apihelp-query+search-param-qiprofile',
408  ],
409  ];
410  }
411 
412  protected function getExamplesMessages() {
413  return [
414  'action=query&list=search&srsearch=meaning'
415  => 'apihelp-query+search-example-simple',
416  'action=query&list=search&srwhat=text&srsearch=meaning'
417  => 'apihelp-query+search-example-text',
418  'action=query&generator=search&gsrsearch=meaning&prop=info'
419  => 'apihelp-query+search-example-generator',
420  ];
421  }
422 
423  public function getHelpUrls() {
424  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Search';
425  }
426 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getInterwikiResults( $type=self::SECONDARY_RESULTS)
Return a result set of hits on other (multiple) wikis associated with this one.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1535
getResult()
Get the result object.
Definition: ApiBase.php:640
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:2080
const INLINE_RESULTS
Identifier for interwiki results that can be displayed even if no existing main wiki results exist...
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
getMain()
Get the main module.
Definition: ApiBase.php:536
trait SearchApi
Traits for API components that use a SearchEngine.
Definition: SearchApi.php:29
buildCommonApiParams( $isScrollable=true)
The set of api parameters that are shared between api calls that call the SearchEngine.
Definition: SearchApi.php:47
getCacheMode( $params)
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
addValue( $path, $name, $value, $flags=0)
Add value to the output data at the given path.
Definition: ApiResult.php:405
static getInstance()
Returns the global default instance of the top level service locator.
getExtensionData()
Get the extension data as: augmentor name => data.
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. '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:1981
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1983
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1250
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
hasInterwikiResults( $type=self::SECONDARY_RESULTS)
Check if there are results on other wikis.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2216
__construct(ApiQuery $query, $moduleName)
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
Definition: ApiResult.php:1150
getTextSnippet( $terms=[])
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
isBrokenTitle()
Check if this is result points to an invalid title.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
This class represents the result of the API operations.
Definition: ApiResult.php:35
This is the main query class.
Definition: ApiQuery.php:36
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
isFileMatch()
Did this match file contents (eg: PDF/DJVU)?
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3050
const FT_QUERY_INDEP_PROFILE_TYPE
Profile type for query independent ranking features.
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
buildSearchEngine(array $params=null)
Build the search engine to use.
Definition: SearchApi.php:151
const SECONDARY_RESULTS
Identifier for interwiki results that are displayed only together with existing main wiki results...
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
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
addIndexedTagName( $path, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:629
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition: ApiBase.php:209
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
run( $resultPageSet=null)
array $allowedParams
list of api allowed params
addInterwikiResults(ISearchResultSet $matches, ApiResult $apiResult, $prop, $section, $type)
Add interwiki results as a section in query results.
getSearchResultData(SearchResult $result, $prop)
Assemble search result data.
executeGenerator( $resultPageSet)
Query module to perform full text search within wiki titles and content.
isMissingRevision()
Check if target page is missing, happens when index is out of date.
$matches