MediaWiki master
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 65 of file SearchApi.php.

References $params, and 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 175 of file SearchApi.php.

References $params, and getSearchProfileParams().

◆ getContext()

getContext ( )
abstract
Returns
IContextSource

Referenced by UploadForm\__construct(), WatchAction\__construct(), Article\addHelpLink(), MediaWiki\Output\OutputPage\addSubtitle(), Article\adjustDisplayTitle(), Skin\buildNavUrls(), MediaWiki\Actions\FileDeleteAction\checkCanExecute(), CategoryPage\closeShowCategory(), ApiBase\dieBlocked(), Skin\doEditSectionLink(), ImagePage\doRenderLangOpt(), MediaWiki\Actions\ActionEntryPoint\execute(), MediaWiki\Api\ApiEntryPoint\execute(), ApiHelp\execute(), ApiOptions\execute(), ApiParse\execute(), ApiMain\executeAction(), ApiMain\executeActionWithErrorHandling(), MediaWiki\Context\ContextSource\exportSession(), ChangesList\formatCharacterDifference(), MediaWiki\SpecialPage\PageQueryPage\formatResult(), MediaWiki\Pager\ContribsPager\formatRow(), DifferenceEngine\generateContentDiffBody(), DifferenceEngine\generateTextDiffBody(), MediaWiki\Context\DerivativeContext\getActionName(), MediaWiki\SpecialPage\LoginSignupSpecialPage\getAuthForm(), MediaWiki\Specials\SpecialEditWatchlist\getClearForm(), MediaWiki\SpecialPage\SpecialPage\getConfig(), HistoryAction\getDescription(), MediaWiki\Specials\SpecialUpload\getDupeWarning(), FormatMetadata\getExtendedMetadataFromHook(), MediaWiki\Specials\SpecialRecentChanges\getExtraOptions(), ApiBase\getFinalDescription(), ApiBase\getFinalParamDescription(), ApiBase\getFinalSummary(), MediaWiki\Pager\ImageListPager\getForm(), MediaWiki\Pager\UploadStashPager\getForm(), MediaWiki\Specials\SpecialContributions\getForm(), WatchAction\getFormFields(), MediaWiki\SpecialPage\SpecialPage\getFullTitle(), MediaWiki\Output\OutputPage\getJSVars(), Action\getLanguage(), MediaWiki\Context\ContextSource\getLanguage(), MediaWiki\Context\DerivativeContext\getLanguage(), MediaWiki\SpecialPage\SpecialPage\getLanguage(), EditWatchlistNormalHTMLForm\getLegend(), MediaWiki\Specials\SpecialEditWatchlist\getNormalForm(), Article\getOldIDFromRequest(), Action\getOutput(), MediaWiki\Context\ContextSource\getOutput(), MediaWiki\Context\DerivativeContext\getOutput(), MediaWiki\SpecialPage\SpecialPage\getOutput(), Article\getParserOptions(), ApiOptions\getPreferences(), MediaWiki\Specials\SpecialEditWatchlist\getRawForm(), RawAction\getRawText(), Action\getRequest(), MediaWiki\SpecialPage\SpecialPage\getRequest(), Article\getRobotPolicy(), Action\getSkin(), MediaWiki\Context\ContextSource\getSkin(), MediaWiki\Context\DerivativeContext\getSkin(), MediaWiki\SpecialPage\SpecialPage\getSkin(), DifferenceEngine\getSlotDiffRenderers(), Skin\getTemplateData(), DifferenceEngine\getTextDiffer(), ImagePage\getThumbPrevText(), ImagePage\getThumbSizes(), MediaWiki\Context\ContextSource\getTiming(), MediaWiki\Actions\ActionEntryPoint\getTitle(), MediaWiki\HTMLForm\HTMLForm\getTitle(), Skin\getUndeleteLink(), Action\getUser(), MediaWiki\Context\ContextSource\getUser(), MediaWiki\Context\DerivativeContext\getUser(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\Specials\SpecialEditWatchlist\getWatchlistInfo(), RollbackAction\handleRollbackRequest(), MediaWiki\Actions\ActionEntryPoint\handleTopLevelError(), MediaWiki\Output\OutputPage\headElement(), ImagePage\imageDupes(), ImagePage\imageHistory(), ImagePage\imageLinks(), MediaWiki\Actions\ActionEntryPoint\initializeArticle(), ChangesList\insertLog(), ChangesList\insertLogEntry(), Article\isDiffOnlyView(), Article\isFileCacheable(), LogEventsList\logLine(), MediaWiki\SpecialPage\ChangesListSpecialPage\makeLegend(), Skin\makeLink(), Skin\makeListItem(), ImagePage\makeMetadataTable(), MediaWiki\Actions\ActionEntryPoint\maybeDoHttpsRedirect(), Action\msg(), MediaWiki\Context\ContextSource\msg(), MediaWiki\SpecialPage\SpecialPage\msg(), McrUndoAction\onSubmit(), WatchAction\onSuccess(), HistoryAction\onView(), InfoAction\onView(), ImagePage\openShowImage(), MediaWiki\Specials\SpecialRecentChanges\outputChangesList(), MediaWiki\Output\OutputPage\parseAsContent(), MediaWiki\Output\OutputPage\parseAsInterface(), MediaWiki\Output\OutputPage\parserOptions(), MediaWiki\Actions\ActionEntryPoint\performAction(), MediaWiki\Actions\ActionEntryPoint\performRequest(), ApiUpload\performUpload(), ImagePage\printSharedImageText(), ChangesList\recentChangesFlags(), Article\render(), DifferenceEngine\renderNewRevision(), ApiOptions\resetPreferences(), MediaWiki\EditPage\EditPage\setHeaders(), MediaWiki\Output\OutputPage\setHTMLTitle(), Article\setOldSubtitle(), MediaWiki\Output\OutputPage\setPageTitle(), MediaWiki\Output\OutputPage\setTitle(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiffPage(), Article\showDiffPage(), ImagePage\showError(), Article\showMissingArticle(), Article\showNamespaceHeader(), LogEventsList\showOptions(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), MediaWiki\EditPage\EditPage\showStandardInputs(), ImagePage\showTOC(), Article\showViewFooter(), SkinTemplate\tabAction(), DeleteAction\tempDelete(), Article\tryFileCache(), ImagePage\uploadLinksBox(), Article\view(), CategoryPage\view(), and ImagePage\view().

◆ 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().