MediaWiki  master
SearchApi.php File Reference

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Go to the source code of this file.

Functions

 buildCommonApiParams ( $isScrollable=true)
 The set of api parameters that are shared between api calls that call the SearchEngine. More...
 
 buildSearchEngine (array $params=null)
 Build the search engine to use. More...
 
 getContext ()
 
 getSearchProfileParams ()
 

Variables

trait SearchApi
 Traits for API components that use a SearchEngine. More...
 

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Since
1.28

Definition in file SearchApi.php.

Function Documentation

◆ buildCommonApiParams()

buildCommonApiParams (   $isScrollable = true)

The set of api parameters that are shared between api calls that call the SearchEngine.

Primarily this defines parameters that are utilized by self::buildSearchEngine().

Parameters
bool$isScrollableTrue if the api offers scrolling
Returns
array

Definition at line 66 of file SearchApi.php.

Referenced by ApiOpenSearch\getAllowedParams(), ApiQueryPrefixSearch\getAllowedParams(), and ApiQuerySearch\getAllowedParams().

◆ buildSearchEngine()

buildSearchEngine ( array  $params = null)

Build the search engine to use.

If $params is provided then the following searchEngine options will be set:

  • backend: which search backend to use
  • limit: mandatory
  • offset: optional
  • namespace: mandatory
  • search engine profiles defined by SearchApi::getSearchProfileParams()
    Parameters
    array | null$paramsAPI request params (must be sanitized by ApiBase::extractRequestParams() before)
    Returns
    SearchEngine

Definition at line 177 of file SearchApi.php.

◆ getContext()

getContext ( )
abstract
Returns
IContextSource

Referenced by Article\addHelpLink(), OutputPage\addSubtitle(), Article\adjustDisplayTitle(), Skin\buildNavUrls(), Article\doDelete(), ApiParse\execute(), ApiMain\executeAction(), ApiMain\executeActionWithErrorHandling(), ContextSource\exportSession(), PageQueryPage\formatResult(), ContribsPager\formatRow(), DerivativeContext\getActionName(), LoginSignupSpecialPage\getAuthForm(), SpecialEditWatchlist\getClearForm(), SpecialPage\getConfig(), EditPage\getCopywarn(), SpecialRecentChanges\getExtraOptions(), ApiBase\getFinalDescription(), ApiBase\getFinalParamDescription(), ApiBase\getFinalSummary(), ImageListPager\getForm(), SpecialContributions\getForm(), SpecialPage\getFullTitle(), OutputPage\getHeadLinksArray(), OutputPage\getJSVars(), Action\getLanguage(), ContextSource\getLanguage(), DerivativeContext\getLanguage(), SpecialPage\getLanguage(), SpecialEditWatchlist\getNormalForm(), Action\getOutput(), ContextSource\getOutput(), DerivativeContext\getOutput(), SpecialPage\getOutput(), Article\getParserOptions(), SpecialEditWatchlist\getRawForm(), Action\getRequest(), SpecialPage\getRequest(), Article\getRobotPolicy(), Action\getSkin(), ContextSource\getSkin(), DerivativeContext\getSkin(), SpecialPage\getSkin(), Skin\getTemplateData(), ContextSource\getTiming(), HTMLForm\getTitle(), Skin\getUndeleteLink(), Action\getUser(), ContextSource\getUser(), DerivativeContext\getUser(), SpecialPage\getUser(), SpecialEditWatchlist\getWatchlistInfo(), OutputPage\headElement(), ChangesList\insertLogEntry(), ChangesList\insertRollback(), Article\isDiffOnlyView(), Article\isFileCacheable(), Action\msg(), ContextSource\msg(), SpecialPage\msg(), WatchAction\onSuccess(), SpecialRecentChanges\outputChangesList(), OutputPage\parserOptions(), Article\render(), OutputPage\setHTMLTitle(), Article\setOldSubtitle(), OutputPage\setPageTitle(), OutputPage\setTitle(), Article\showDeletedRevisionHeader(), Article\showDiffPage(), Article\showMissingArticle(), Article\showNamespaceHeader(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), Article\showViewFooter(), SkinTemplate\tabAction(), Article\tryFileCache(), Article\viewRedirect(), and Skin\wrapHTML().

◆ getSearchProfileParams()

getSearchProfileParams ( )
abstract
Returns
array[] array of arrays mapping from parameter name to a two value map containing 'help-message' and 'profile-type' keys.