MediaWiki  1.29.1
ApiQuerySearch.php
Go to the documentation of this file.
1 <?php
33  use SearchApi;
34 
36  private $allowedParams;
37 
38  public function __construct( ApiQuery $query, $moduleName ) {
39  parent::__construct( $query, $moduleName, 'sr' );
40  }
41 
42  public function execute() {
43  $this->run();
44  }
45 
46  public function executeGenerator( $resultPageSet ) {
47  $this->run( $resultPageSet );
48  }
49 
54  private function run( $resultPageSet = null ) {
56  $params = $this->extractRequestParams();
57 
58  // Extract parameters
59  $query = $params['search'];
60  $what = $params['what'];
61  $interwiki = $params['interwiki'];
62  $searchInfo = array_flip( $params['info'] );
63  $prop = array_flip( $params['prop'] );
64 
65  // Deprecated parameters
66  if ( isset( $prop['hasrelated'] ) ) {
67  $this->addDeprecation(
68  [ 'apiwarn-deprecation-parameter', 'srprop=hasrelated' ], 'action=search&srprop=hasrelated'
69  );
70  }
71  if ( isset( $prop['score'] ) ) {
72  $this->addDeprecation(
73  [ 'apiwarn-deprecation-parameter', 'srprop=score' ], 'action=search&srprop=score'
74  );
75  }
76 
77  // Create search engine instance and set options
78  $search = $this->buildSearchEngine( $params );
79  $search->setFeatureData( 'rewrite', (bool)$params['enablerewrites'] );
80  $search->setFeatureData( 'interwiki', (bool)$interwiki );
81 
82  $query = $search->transformSearchTerm( $query );
83  $query = $search->replacePrefixes( $query );
84 
85  // Perform the actual search
86  if ( $what == 'text' ) {
87  $matches = $search->searchText( $query );
88  } elseif ( $what == 'title' ) {
89  $matches = $search->searchTitle( $query );
90  } elseif ( $what == 'nearmatch' ) {
91  // near matches must receive the user input as provided, otherwise
92  // the near matches within namespaces are lost.
93  $matches = $search->getNearMatcher( $this->getConfig() )
94  ->getNearMatchResultSet( $params['search'] );
95  } else {
96  // We default to title searches; this is a terrible legacy
97  // of the way we initially set up the MySQL fulltext-based
98  // search engine with separate title and text fields.
99  // In the future, the default should be for a combined index.
100  $what = 'title';
101  $matches = $search->searchTitle( $query );
102 
103  // Not all search engines support a separate title search,
104  // for instance the Lucene-based engine we use on Wikipedia.
105  // In this case, fall back to full-text search (which will
106  // include titles in it!)
107  if ( is_null( $matches ) ) {
108  $what = 'text';
109  $matches = $search->searchText( $query );
110  }
111  }
112 
113  if ( $matches instanceof Status ) {
114  $status = $matches;
115  $matches = $status->getValue();
116  } else {
117  $status = null;
118  }
119 
120  if ( $status ) {
121  if ( $status->isOK() ) {
122  $this->getMain()->getErrorFormatter()->addMessagesFromStatus(
123  $this->getModuleName(),
124  $status
125  );
126  } else {
127  $this->dieStatus( $status );
128  }
129  } elseif ( is_null( $matches ) ) {
130  $this->dieWithError( [ 'apierror-searchdisabled', $what ], "search-{$what}-disabled" );
131  }
132 
133  if ( $resultPageSet === null ) {
134  $apiResult = $this->getResult();
135  // Add search meta data to result
136  if ( isset( $searchInfo['totalhits'] ) ) {
137  $totalhits = $matches->getTotalHits();
138  if ( $totalhits !== null ) {
139  $apiResult->addValue( [ 'query', 'searchinfo' ],
140  'totalhits', $totalhits );
141  }
142  }
143  if ( isset( $searchInfo['suggestion'] ) && $matches->hasSuggestion() ) {
144  $apiResult->addValue( [ 'query', 'searchinfo' ],
145  'suggestion', $matches->getSuggestionQuery() );
146  $apiResult->addValue( [ 'query', 'searchinfo' ],
147  'suggestionsnippet', $matches->getSuggestionSnippet() );
148  }
149  if ( isset( $searchInfo['rewrittenquery'] ) && $matches->hasRewrittenQuery() ) {
150  $apiResult->addValue( [ 'query', 'searchinfo' ],
151  'rewrittenquery', $matches->getQueryAfterRewrite() );
152  $apiResult->addValue( [ 'query', 'searchinfo' ],
153  'rewrittenquerysnippet', $matches->getQueryAfterRewriteSnippet() );
154  }
155  }
156 
157  // Add the search results to the result
158  $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
159  $titles = [];
160  $count = 0;
161  $result = $matches->next();
162  $limit = $params['limit'];
163 
164  while ( $result ) {
165  if ( ++$count > $limit ) {
166  // We've reached the one extra which shows that there are
167  // additional items to be had. Stop here...
168  $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
169  break;
170  }
171 
172  // Silently skip broken and missing titles
173  if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
174  $result = $matches->next();
175  continue;
176  }
177 
178  if ( $resultPageSet === null ) {
179  $vals = $this->getSearchResultData( $result, $prop, $terms );
180  if ( $vals ) {
181  // Add item to results and see whether it fits
182  $fit = $apiResult->addValue( [ 'query', $this->getModuleName() ], null, $vals );
183  if ( !$fit ) {
184  $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
185  break;
186  }
187  }
188  } else {
189  $titles[] = $result->getTitle();
190  }
191 
192  $result = $matches->next();
193  }
194 
195  // Here we assume interwiki results do not count with
196  // regular search results. We may want to reconsider this
197  // if we ever return a lot of interwiki results or want pagination
198  // for them.
199  // Interwiki results inside main result set
200  $canAddInterwiki = (bool)$params['enablerewrites'] && ( $resultPageSet === null );
201  if ( $canAddInterwiki ) {
202  $this->addInterwikiResults( $matches, $apiResult, $prop, $terms, 'additional',
203  SearchResultSet::INLINE_RESULTS );
204  }
205 
206  // Interwiki results outside main result set
207  if ( $interwiki && $resultPageSet === null ) {
208  $this->addInterwikiResults( $matches, $apiResult, $prop, $terms, 'interwiki',
209  SearchResultSet::SECONDARY_RESULTS );
210  }
211 
212  if ( $resultPageSet === null ) {
213  $apiResult->addIndexedTagName( [
214  'query', $this->getModuleName()
215  ], 'p' );
216  } else {
217  $resultPageSet->setRedirectMergePolicy( function ( $current, $new ) {
218  if ( !isset( $current['index'] ) || $new['index'] < $current['index'] ) {
219  $current['index'] = $new['index'];
220  }
221  return $current;
222  } );
223  $resultPageSet->populateFromTitles( $titles );
224  $offset = $params['offset'] + 1;
225  foreach ( $titles as $index => $title ) {
226  $resultPageSet->setGeneratorData( $title, [ 'index' => $index + $offset ] );
227  }
228  }
229  }
230 
238  private function getSearchResultData( SearchResult $result, $prop, $terms ) {
239  // Silently skip broken and missing titles
240  if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
241  return null;
242  }
243 
244  $vals = [];
245 
246  $title = $result->getTitle();
248 
249  if ( isset( $prop['size'] ) ) {
250  $vals['size'] = $result->getByteSize();
251  }
252  if ( isset( $prop['wordcount'] ) ) {
253  $vals['wordcount'] = $result->getWordCount();
254  }
255  if ( isset( $prop['snippet'] ) ) {
256  $vals['snippet'] = $result->getTextSnippet( $terms );
257  }
258  if ( isset( $prop['timestamp'] ) ) {
259  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $result->getTimestamp() );
260  }
261  if ( isset( $prop['titlesnippet'] ) ) {
262  $vals['titlesnippet'] = $result->getTitleSnippet();
263  }
264  if ( isset( $prop['categorysnippet'] ) ) {
265  $vals['categorysnippet'] = $result->getCategorySnippet();
266  }
267  if ( !is_null( $result->getRedirectTitle() ) ) {
268  if ( isset( $prop['redirecttitle'] ) ) {
269  $vals['redirecttitle'] = $result->getRedirectTitle()->getPrefixedText();
270  }
271  if ( isset( $prop['redirectsnippet'] ) ) {
272  $vals['redirectsnippet'] = $result->getRedirectSnippet();
273  }
274  }
275  if ( !is_null( $result->getSectionTitle() ) ) {
276  if ( isset( $prop['sectiontitle'] ) ) {
277  $vals['sectiontitle'] = $result->getSectionTitle()->getFragment();
278  }
279  if ( isset( $prop['sectionsnippet'] ) ) {
280  $vals['sectionsnippet'] = $result->getSectionSnippet();
281  }
282  }
283  if ( isset( $prop['isfilematch'] ) ) {
284  $vals['isfilematch'] = $result->isFileMatch();
285  }
286  return $vals;
287  }
288 
299  private function addInterwikiResults(
300  SearchResultSet $matches, ApiResult $apiResult, $prop,
301  $terms, $section, $type
302  ) {
303  $totalhits = null;
304  if ( $matches->hasInterwikiResults( $type ) ) {
305  foreach ( $matches->getInterwikiResults( $type ) as $interwikiMatches ) {
306  // Include number of results if requested
307  $totalhits += $interwikiMatches->getTotalHits();
308 
309  $result = $interwikiMatches->next();
310  while ( $result ) {
311  $title = $result->getTitle();
312  $vals = $this->getSearchResultData( $result, $prop, $terms );
313 
314  $vals['namespace'] = $result->getInterwikiNamespaceText();
315  $vals['title'] = $title->getText();
316  $vals['url'] = $title->getFullURL();
317 
318  // Add item to results and see whether it fits
319  $fit = $apiResult->addValue( [
320  'query',
321  $section . $this->getModuleName(),
322  $result->getInterwikiPrefix()
323  ], null, $vals );
324 
325  if ( !$fit ) {
326  // We hit the limit. We can't really provide any meaningful
327  // pagination info so just bail out
328  break;
329  }
330 
331  $result = $interwikiMatches->next();
332  }
333  }
334  if ( $totalhits !== null ) {
335  $apiResult->addValue( [ 'query', $section . 'searchinfo' ], 'totalhits', $totalhits );
336  $apiResult->addIndexedTagName( [
337  'query', $section . $this->getModuleName()
338  ], 'p' );
339  }
340  }
341  return $totalhits;
342  }
343 
344  public function getCacheMode( $params ) {
345  return 'public';
346  }
347 
348  public function getAllowedParams() {
349  if ( $this->allowedParams !== null ) {
350  return $this->allowedParams;
351  }
352 
353  $this->allowedParams = $this->buildCommonApiParams() + [
354  'what' => [
356  'title',
357  'text',
358  'nearmatch',
359  ]
360  ],
361  'info' => [
362  ApiBase::PARAM_DFLT => 'totalhits|suggestion|rewrittenquery',
364  'totalhits',
365  'suggestion',
366  'rewrittenquery',
367  ],
368  ApiBase::PARAM_ISMULTI => true,
369  ],
370  'prop' => [
371  ApiBase::PARAM_DFLT => 'size|wordcount|timestamp|snippet',
373  'size',
374  'wordcount',
375  'timestamp',
376  'snippet',
377  'titlesnippet',
378  'redirecttitle',
379  'redirectsnippet',
380  'sectiontitle',
381  'sectionsnippet',
382  'isfilematch',
383  'categorysnippet',
384  'score', // deprecated
385  'hasrelated', // deprecated
386  ],
387  ApiBase::PARAM_ISMULTI => true,
389  ],
390  'interwiki' => false,
391  'enablerewrites' => false,
392  ];
393 
394  return $this->allowedParams;
395  }
396 
397  public function getSearchProfileParams() {
398  return [
399  'qiprofile' => [
401  'help-message' => 'apihelp-query+search-param-qiprofile',
402  ],
403  ];
404  }
405 
406  protected function getExamplesMessages() {
407  return [
408  'action=query&list=search&srsearch=meaning'
409  => 'apihelp-query+search-example-simple',
410  'action=query&list=search&srwhat=text&srsearch=meaning'
411  => 'apihelp-query+search-example-text',
412  'action=query&generator=search&gsrsearch=meaning&prop=info'
413  => 'apihelp-query+search-example-generator',
414  ];
415  }
416 
417  public function getHelpUrls() {
418  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Search';
419  }
420 }
ApiQuerySearch\run
run( $resultPageSet=null)
Definition: ApiQuerySearch.php:54
ContextSource\getConfig
getConfig()
Get the Config object.
Definition: ContextSource.php:68
ApiResult\addIndexedTagName
addIndexedTagName( $path, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:629
ApiQuery
This is the main query class.
Definition: ApiQuery.php:40
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
$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. 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
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1994
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:610
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
use
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
$params
$params
Definition: styleTest.css.php:40
SearchEngine\FT_QUERY_INDEP_PROFILE_TYPE
const FT_QUERY_INDEP_PROFILE_TYPE
@const string profile type for query independent ranking features
Definition: SearchEngine.php:61
ApiQuerySearch\$allowedParams
array $allowedParams
list of api allowed params
Definition: ApiQuerySearch.php:36
$type
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
php
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
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
ApiQuerySearch\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQuerySearch.php:46
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:88
$query
null for the 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:1572
ApiQuerySearch\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQuerySearch.php:348
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
SearchResult
Definition: SearchResult.php:32
$titles
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
ApiResult
This class represents the result of the API operations.
Definition: ApiResult.php:33
$matches
$matches
Definition: NoLocalSettings.php:24
buildSearchEngine
buildSearchEngine(array $params=null)
Build the search engine to use.
Definition: SearchApi.php:151
$limit
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired 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 inclusive $limit
Definition: hooks.txt:1049
ApiQuerySearch\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQuerySearch.php:42
ApiQuerySearch\getSearchProfileParams
getSearchProfileParams()
Definition: ApiQuerySearch.php:397
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
SearchResultSet
Definition: SearchResultSet.php:27
ApiResult\addValue
addValue( $path, $name, $value, $flags=0)
Add value to the output data at the given path.
Definition: ApiResult.php:405
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:718
ApiBase\addDeprecation
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition: ApiBase.php:1734
ApiQuerySearch\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQuerySearch.php:344
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:30
ApiQuerySearch
Query module to perform full text search within wiki titles and content.
Definition: ApiQuerySearch.php:32
ApiQuerySearch\getSearchResultData
getSearchResultData(SearchResult $result, $prop, $terms)
Assemble search result data.
Definition: ApiQuerySearch.php:238
$section
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:2929
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
as
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
ApiBase\dieStatus
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:1861
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:490
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiQuerySearch\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQuerySearch.php:38
ApiQuerySearch\addInterwikiResults
addInterwikiResults(SearchResultSet $matches, ApiResult $apiResult, $prop, $terms, $section, $type)
Add interwiki results as a section in query results.
Definition: ApiQuerySearch.php:299
ApiQuerySearch\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQuerySearch.php:406
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:506
ApiBase\PARAM_HELP_MSG_PER_VALUE
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:160
ApiQuerySearch\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQuerySearch.php:417
SearchApi
trait SearchApi
Traits for API components that use a SearchEngine.
Definition: SearchApi.php:28
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:486
array
the array() calling protocol came about after MediaWiki 1.4rc1.
buildCommonApiParams
buildCommonApiParams( $isScrollable=true)
The set of api parameters that are shared between api calls that call the SearchEngine.
Definition: SearchApi.php:46
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56