- Generated on Fri Apr 5 2024 23:55:00 for MediaWiki by
1.9.8
|
MediaWiki REL1_38
|
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. | |
| buildProfileApiParam () | |
| Build the profile api param definitions. | |
| buildSearchEngine (array $params=null) | |
| Build the search engine to use. | |
| checkDependenciesSet () | |
| getContext () | |
| getSearchProfileParams () | |
Variables | |
| static | $BACKEND_NULL_PARAM = 'database-backed' |
| When $wgSearchType is null, $wgSearchAlternatives[0] is null. | |
| SearchEngineFactory null | $searchEngineFactory = null |
| trait | SearchApi |
| Traits for API components that use a SearchEngine. | |
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
Definition in file SearchApi.php.
| 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().
| bool | $isScrollable | True if the api offers scrolling |
Definition at line 63 of file SearchApi.php.
References $BACKEND_NULL_PARAM, buildProfileApiParam(), checkDependenciesSet(), and NS_MAIN.
Referenced by ApiOpenSearch\getAllowedParams(), ApiQueryPrefixSearch\getAllowedParams(), and ApiQuerySearch\getAllowedParams().
|
private |
Build the profile api param definitions.
Makes bold assumption only one search engine is available, ensure that is true before calling.
Definition at line 121 of file SearchApi.php.
References checkDependenciesSet(), getContext(), getSearchProfileParams(), and getUser().
Referenced by buildCommonApiParams().
| buildSearchEngine | ( | array | $params = null | ) |
Build the search engine to use.
If $params is provided then the following searchEngine options will be set:
| array | null | $params | API request params (must be sanitized by ApiBase::extractRequestParams() before) |
Definition at line 174 of file SearchApi.php.
References $type, checkDependenciesSet(), and getSearchProfileParams().
Referenced by ApiQueryPrefixSearch\run(), ApiQuerySearch\run(), and ApiOpenSearch\search().
|
private |
Definition at line 35 of file SearchApi.php.
Referenced by buildCommonApiParams(), buildProfileApiParam(), and buildSearchEngine().
|
abstract |
Referenced by WatchAction\__construct(), Article\addHelpLink(), OutputPage\addSubtitle(), Article\adjustDisplayTitle(), UsersPager\buildGroupLink(), Skin\buildNavUrls(), buildProfileApiParam(), CategoryPage\closeShowCategory(), ImagePage\createXmlOptionStringForLanguage(), Article\doDelete(), Article\doOutputFromRenderStatus(), ImagePage\doRenderLangOpt(), ApiOptions\execute(), ApiParse\execute(), ApiMain\executeAction(), ApiMain\executeActionWithErrorHandling(), ContextSource\exportSession(), ApiQueryRevisionsBase\extractDeprecatedContent(), SpecialNewpages\form(), ChangesList\formatCharacterDifference(), PageQueryPage\formatResult(), ContribsPager\formatRow(), DifferenceEngine\generateContentDiffBody(), DifferenceEngine\generateTextDiffBody(), LoginSignupSpecialPage\getAuthForm(), EditPage\getCheckboxesDefinitionForWatchlist(), 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(), SpecialContributions\getPager(), Article\getParserOptions(), DifferenceEngine\getParserOutput(), ApiOptions\getPreferences(), SpecialEditWatchlist\getRawForm(), RawAction\getRawText(), Action\getRequest(), SpecialPage\getRequest(), Article\getRobotPolicy(), Action\getSkin(), ContextSource\getSkin(), DerivativeContext\getSkin(), SpecialPage\getSkin(), SkinTemplate\getSkinNavOverrideableLabel(), DifferenceEngine\getSlotDiffRenderers(), NewFilesPager\getStartBody(), ImagePage\getThumbPrevText(), ImagePage\getThumbSizes(), ContextSource\getTiming(), HTMLForm\getTitle(), BaseTemplate\getTrail(), Skin\getUndeleteLink(), SpecialUpload\getUploadForm(), Action\getUser(), ContextSource\getUser(), DerivativeContext\getUser(), SpecialPage\getUser(), SpecialEditWatchlist\getWatchlistInfo(), RollbackAction\handleRollbackRequest(), OutputPage\headElement(), HistoryPager\historyLine(), ImagePage\imageDupes(), ImagePage\imageHistory(), ImagePage\imageLinks(), EditPage\importFormData(), ChangesList\insertLog(), ChangesList\insertLogEntry(), ChangesList\insertRollback(), Article\isFileCacheable(), LogEventsList\logLine(), ChangesListSpecialPage\makeLegend(), ImagePage\makeMetadataTable(), ApiParse\makeParserOptions(), Action\msg(), ContextSource\msg(), SpecialPage\msg(), McrUndoAction\onSubmit(), UnwatchAction\onSubmit(), WatchAction\onSubmit(), WatchAction\onSuccess(), InfoAction\onView(), RawAction\onView(), ImagePage\openShowImage(), SpecialRecentChanges\outputChangesList(), InfoAction\pageInfo(), OutputPage\parserOptions(), MediaWiki\Actions\FileDeleteAction\prepareMessage(), ImagePage\printSharedImageText(), ChangesList\recentChangesFlags(), Article\render(), ApiOptions\resetPreferences(), OutputPage\setHTMLTitle(), Article\setOldSubtitle(), OutputPage\setPageTitle(), OutputPage\setTitle(), McrUndoAction\show(), SpecialPageAction\show(), LoginSignupSpecialPage\showCreateAccountLink(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiffPage(), Article\showDiffPage(), ImagePage\showError(), Article\showMissingArticle(), Article\showNamespaceHeader(), LogEventsList\showOptions(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), ImagePage\showTOC(), Article\showViewError(), Article\showViewFooter(), SkinTemplate\tabAction(), DeleteAction\tempDelete(), DifferenceEngine\textDiff(), Article\tryFileCache(), ImagePage\uploadLinksBox(), Article\view(), CategoryPage\view(), ImagePage\view(), and Article\viewRedirect().
|
abstract |
Referenced by buildProfileApiParam(), and buildSearchEngine().
|
staticprivate |
When $wgSearchType is null, $wgSearchAlternatives[0] is null.
Null isn't a valid option for an array for PARAM_TYPE, so we'll use a fake name that can't possibly be a class name and describes what the null behavior does
Definition at line 53 of file SearchApi.php.
Referenced by buildCommonApiParams().
|
private |
Definition at line 33 of file SearchApi.php.
Referenced by ApiOpenSearch\__construct(), ApiQueryPrefixSearch\__construct(), MovePageForm\__construct(), SpecialSearch\__construct(), and SpecialPage\prefixSearchString().
1.9.8