37 private static $BACKEND_NULL_PARAM =
'database-backed';
66 if ( $isScrollable ) {
75 $alternatives = $searchConfig->getSearchTypes();
76 if ( count( $alternatives ) > 1 ) {
77 if ( $alternatives[0] ===
null ) {
78 $alternatives[0] = self::$BACKEND_NULL_PARAM;
80 $params[
'backend'] = [
106 $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
108 foreach ( $configs as $paramName => $paramConfig ) {
109 $profiles = $searchEngine->getProfiles( $paramConfig[
'profile-type'],
117 $defaultProfile =
null;
118 foreach ( $profiles as $profile ) {
119 $types[] = $profile[
'name'];
120 if ( isset( $profile[
'desc-message'] ) ) {
121 $helpMessages[$profile[
'name']] = $profile[
'desc-message'];
124 if ( !empty( $profile[
'default'] ) ) {
125 $defaultProfile = $profile[
'name'];
129 $params[$paramName] = [
154 if ( $params !=
null ) {
155 $type = $params[
'backend'] ??
null;
156 if (
$type === self::$BACKEND_NULL_PARAM ) {
159 $searchEngine = MediaWikiServices::getInstance()->getSearchEngineFactory()->create(
$type );
160 $limit = $params[
'limit'];
161 $searchEngine->setNamespaces( $params[
'namespace'] );
162 $offset = $params[
'offset'] ??
null;
163 $searchEngine->setLimitOffset( $limit, $offset );
167 foreach ( $configs as $paramName => $paramConfig ) {
168 if ( isset( $params[$paramName] ) ) {
169 $searchEngine->setFeatureData(
170 $paramConfig[
'profile-type'],
176 $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
178 return $searchEngine;
buildSearchEngine(array $params=null)
Build the search engine to use.
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.
const PARAM_REQUIRED
(boolean) Is the parameter required?
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
const LIMIT_BIG1
Fast query, standard limit.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
const LIMIT_BIG2
Fast query, apihighlimits limit.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
trait SearchApi
Traits for API components that use a SearchEngine.