MediaWiki REL1_33
SearchApi.php
Go to the documentation of this file.
1<?php
3
28trait SearchApi {
29
36 private static $BACKEND_NULL_PARAM = 'database-backed';
37
46 public function buildCommonApiParams( $isScrollable = true ) {
47 $params = [
48 'search' => [
49 ApiBase::PARAM_TYPE => 'string',
51 ],
52 'namespace' => [
54 ApiBase::PARAM_TYPE => 'namespace',
56 ],
57 'limit' => [
59 ApiBase::PARAM_TYPE => 'limit',
63 ],
64 ];
65 if ( $isScrollable ) {
66 $params['offset'] = [
68 ApiBase::PARAM_TYPE => 'integer',
69 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
70 ];
71 }
72
73 $searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
74 $alternatives = $searchConfig->getSearchTypes();
75 if ( count( $alternatives ) > 1 ) {
76 if ( $alternatives[0] === null ) {
77 $alternatives[0] = self::$BACKEND_NULL_PARAM;
78 }
79 $params['backend'] = [
80 ApiBase::PARAM_DFLT => $searchConfig->getSearchType(),
81 ApiBase::PARAM_TYPE => $alternatives,
82 ];
83 // @todo: support profile selection when multiple
84 // backends are available. The solution could be to
85 // merge all possible profiles and let ApiBase
86 // subclasses do the check. Making ApiHelp and ApiSandbox
87 // comprehensive might be more difficult.
88 } else {
89 $params += $this->buildProfileApiParam();
90 }
91
92 return $params;
93 }
94
102 private function buildProfileApiParam() {
103 $configs = $this->getSearchProfileParams();
104 $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
105 $params = [];
106 foreach ( $configs as $paramName => $paramConfig ) {
107 $profiles = $searchEngine->getProfiles( $paramConfig['profile-type'],
108 $this->getContext()->getUser() );
109 if ( !$profiles ) {
110 continue;
111 }
112
113 $types = [];
114 $helpMessages = [];
115 $defaultProfile = null;
116 foreach ( $profiles as $profile ) {
117 $types[] = $profile['name'];
118 if ( isset( $profile['desc-message'] ) ) {
119 $helpMessages[$profile['name']] = $profile['desc-message'];
120 }
121 if ( !empty( $profile['default'] ) ) {
122 $defaultProfile = $profile['name'];
123 }
124 }
125
126 $params[$paramName] = [
127 ApiBase::PARAM_TYPE => $types,
128 ApiBase::PARAM_HELP_MSG => $paramConfig['help-message'],
129 ApiBase::PARAM_HELP_MSG_PER_VALUE => $helpMessages,
130 ApiBase::PARAM_DFLT => $defaultProfile,
131 ];
132 }
133
134 return $params;
135 }
136
150 public function buildSearchEngine( array $params = null ) {
151 if ( $params != null ) {
152 $type = $params['backend'] ?? null;
153 if ( $type === self::$BACKEND_NULL_PARAM ) {
154 $type = null;
155 }
156 $searchEngine = MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $type );
157 $limit = $params['limit'];
158 $searchEngine->setNamespaces( $params['namespace'] );
159 $offset = $params['offset'] ?? null;
160 $searchEngine->setLimitOffset( $limit, $offset );
161
162 // Initialize requested search profiles.
163 $configs = $this->getSearchProfileParams();
164 foreach ( $configs as $paramName => $paramConfig ) {
165 if ( isset( $params[$paramName] ) ) {
166 $searchEngine->setFeatureData(
167 $paramConfig['profile-type'],
168 $params[$paramName]
169 );
170 }
171 }
172 } else {
173 $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
174 }
175 return $searchEngine;
176 }
177
182 abstract public function getSearchProfileParams();
183
187 abstract public function getContext();
188}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getSearchProfileParams()
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.
Definition SearchApi.php:46
getContext()
buildProfileApiParam()
Build the profile api param definitions.
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition ApiBase.php:111
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:96
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:90
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:157
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:99
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:252
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:124
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:254
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
MediaWikiServices is the service locator for the application scope of MediaWiki.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
trait SearchApi
Traits for API components that use a SearchEngine.
Definition SearchApi.php:28
const NS_MAIN
Definition Defines.php:73
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$params