MediaWiki  1.29.2
SearchApi.php
Go to the documentation of this file.
1 <?php
2 use MediaWiki\MediaWikiServices;
3 
28 trait 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',
50  ApiBase::PARAM_REQUIRED => true,
51  ],
52  'namespace' => [
53  ApiBase::PARAM_DFLT => NS_MAIN,
54  ApiBase::PARAM_TYPE => 'namespace',
55  ApiBase::PARAM_ISMULTI => true,
56  ],
57  'limit' => [
58  ApiBase::PARAM_DFLT => 10,
59  ApiBase::PARAM_TYPE => 'limit',
60  ApiBase::PARAM_MIN => 1,
61  ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
62  ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2,
63  ],
64  ];
65  if ( $isScrollable ) {
66  $params['offset'] = [
67  ApiBase::PARAM_DFLT => 0,
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  $this->allowedParams['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 
151  public function buildSearchEngine( array $params = null ) {
152  if ( $params != null ) {
153  $type = isset( $params['backend'] ) ? $params['backend'] : null;
154  if ( $type === self::$BACKEND_NULL_PARAM ) {
155  $type = null;
156  }
157  $searchEngine = MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $type );
158  $limit = $params['limit'];
159  $searchEngine->setNamespaces( $params['namespace'] );
160  $offset = null;
161  if ( isset( $params['offset'] ) ) {
162  // If the API supports offset then it probably
163  // wants to fetch limit+1 so it can check if
164  // more results are available to properly set
165  // the continue param
166  $offset = $params['offset'];
167  $limit += 1;
168  }
169  $searchEngine->setLimitOffset( $limit, $offset );
170 
171  // Initialize requested search profiles.
172  $configs = $this->getSearchProfileParams();
173  foreach ( $configs as $paramName => $paramConfig ) {
174  if ( isset( $params[$paramName] ) ) {
175  $searchEngine->setFeatureData(
176  $paramConfig['profile-type'],
177  $params[$paramName]
178  );
179  }
180  }
181  } else {
182  $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
183  }
184  return $searchEngine;
185  }
186 
191  abstract public function getSearchProfileParams();
192 
196  abstract public function getContext();
197 }
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:115
captcha-old.count
count
Definition: captcha-old.py:225
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$params
$params
Definition: styleTest.css.php:40
$type
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2536
getContext
getContext()
php
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:35
NS_MAIN
const NS_MAIN
Definition: Defines.php:62
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:103
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:203
buildSearchEngine
buildSearchEngine(array $params=null)
Build the search engine to use.
Definition: SearchApi.php:151
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:94
$limit
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1049
buildProfileApiParam
buildProfileApiParam()
Build the profile api param definitions.
Definition: SearchApi.php:102
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:205
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
as
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
Definition: distributors.txt:9
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:100
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:23
ApiBase\PARAM_HELP_MSG_PER_VALUE
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:160
SearchApi
trait SearchApi
Traits for API components that use a SearchEngine.
Definition: SearchApi.php:28
getSearchProfileParams
getSearchProfileParams()
array
the array() calling protocol came about after MediaWiki 1.4rc1.
buildCommonApiParams
buildCommonApiParams( $isScrollable=true)
The set of api parameters that are shared between api calls that call the SearchEngine.
Definition: SearchApi.php:46