MediaWiki REL1_39
Functions | Variables
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.
 
 buildSearchEngine (array $params=null)
 Build the search engine to use.
 
 getContext ()
 
 getSearchProfileParams ()
 

Variables

trait SearchApi
 Traits for API components that use a SearchEngine.
 

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.

References NS_MAIN.

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.

References $type, and getSearchProfileParams().

◆ getContext()

getContext ( )
abstract
Returns
IContextSource

Referenced by WatchAction\__construct(), Article\addHelpLink(), OutputPage\addSubtitle(), Article\adjustDisplayTitle(), UsersPager\buildGroupLink(), Skin\buildNavUrls(), CategoryPage\closeShowCategory(), Article\doDelete(), ImagePage\doRenderLangOpt(), ApiOptions\execute(), ApiParse\execute(), ApiMain\executeAction(), ApiMain\executeActionWithErrorHandling(), ContextSource\exportSession(), SpecialNewpages\form(), ChangesList\formatCharacterDifference(), PageQueryPage\formatResult(), ContribsPager\formatRow(), DifferenceEngine\generateContentDiffBody(), DifferenceEngine\generateTextDiffBody(), LoginSignupSpecialPage\getAuthForm(), SpecialEditWatchlist\getClearForm(), SpecialPage\getConfig(), EditPage\getCopywarn(), SpecialUpload\getDupeWarning(), SpecialRecentChanges\getExtraOptions(), ApiBase\getFinalDescription(), ApiBase\getFinalParamDescription(), ApiBase\getFinalSummary(), ImageListPager\getForm(), SpecialContributions\getForm(), WatchAction\getFormFields(), SpecialPage\getFullTitle(), OutputPage\getHeadLinksArray(), OutputPage\getJSVars(), Action\getLanguage(), ContextSource\getLanguage(), DerivativeContext\getLanguage(), SpecialPage\getLanguage(), SpecialEditWatchlist\getNormalForm(), Article\getOldIDFromRequest(), Action\getOutput(), ContextSource\getOutput(), DerivativeContext\getOutput(), SpecialPage\getOutput(), UsersPager\getPageHeader(), Article\getParserOptions(), DifferenceEngine\getParserOutput(), ApiOptions\getPreferences(), SpecialEditWatchlist\getRawForm(), RawAction\getRawText(), Action\getRequest(), SpecialPage\getRequest(), Article\getRobotPolicy(), Action\getSkin(), ContextSource\getSkin(), DerivativeContext\getSkin(), SpecialPage\getSkin(), DifferenceEngine\getSlotDiffRenderers(), NewFilesPager\getStartBody(), Skin\getTemplateData(), ImagePage\getThumbPrevText(), ImagePage\getThumbSizes(), ContextSource\getTiming(), HTMLForm\getTitle(), Skin\getUndeleteLink(), SpecialUpload\getUploadForm(), Action\getUser(), ContextSource\getUser(), DerivativeContext\getUser(), SpecialPage\getUser(), SpecialEditWatchlist\getWatchlistInfo(), RollbackAction\handleRollbackRequest(), OutputPage\headElement(), ImagePage\imageDupes(), ImagePage\imageHistory(), ImagePage\imageLinks(), ChangesList\insertLog(), ChangesList\insertLogEntry(), ChangesList\insertRollback(), Article\isDiffOnlyView(), Article\isFileCacheable(), LogEventsList\logLine(), ChangesListSpecialPage\makeLegend(), ImagePage\makeMetadataTable(), Action\msg(), ContextSource\msg(), SpecialPage\msg(), McrUndoAction\onSubmit(), WatchAction\onSuccess(), InfoAction\onView(), ImagePage\openShowImage(), SpecialRecentChanges\outputChangesList(), InfoAction\pageInfo(), OutputPage\parserOptions(), ImagePage\printSharedImageText(), ChangesList\recentChangesFlags(), Article\render(), ApiOptions\resetPreferences(), OutputPage\setHTMLTitle(), Article\setOldSubtitle(), OutputPage\setPageTitle(), OutputPage\setTitle(), McrUndoAction\show(), SpecialPageAction\show(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiffPage(), Article\showDiffPage(), ImagePage\showError(), Article\showMissingArticle(), Article\showNamespaceHeader(), LogEventsList\showOptions(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), ImagePage\showTOC(), Article\showViewFooter(), SkinTemplate\tabAction(), DeleteAction\tempDelete(), DifferenceEngine\textDiff(), Article\tryFileCache(), ImagePage\uploadLinksBox(), Article\view(), CategoryPage\view(), ImagePage\view(), 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.

Referenced by buildSearchEngine().