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...

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.

	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 $isScrollable True if the api offers scrolling

Returns: array

Definition at line 46 of file SearchApi.php.

References $params, buildProfileApiParam(), MediaWiki\MediaWikiServices\getSearchEngineConfig(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, NS_MAIN, ApiBase\PARAM_DFLT, ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

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

◆ buildProfileApiParam()

buildProfileApiParam ( )

private

Build the profile api param definitions.

Makes bold assumption only one search engine is available, ensure that is true before calling.

Returns: array array containing available additional api param definitions. Empty if profiles are not supported by the searchEngine implementation.

Definition at line 102 of file SearchApi.php.

References $params, as, getContext(), getSearchProfileParams(), ApiBase\PARAM_DFLT, ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_HELP_MSG_PER_VALUE, and ApiBase\PARAM_TYPE.

Referenced by buildCommonApiParams().

◆ 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, if set limit will be incremented by one ( to support the continue parameter )
namespace: mandatory
search engine profiles defined by SearchApi::getSearchProfileParams()
Parameters

string[]|null API request params (must be sanitized by ApiBase::extractRequestParams() before)

Returns
SearchEngine the search engine