MediaWiki  1.23.8
ApiOpenSearch.php
Go to the documentation of this file.
1 <?php
28 class ApiOpenSearch extends ApiBase {
29 
36  public function getCustomPrinter() {
37  $params = $this->extractRequestParams();
38  $format = $params['format'];
39  $allowed = array( 'json', 'jsonfm' );
40  if ( in_array( $format, $allowed ) ) {
41  return $this->getMain()->createPrinterByName( $format );
42  }
43 
44  return $this->getMain()->createPrinterByName( $allowed[0] );
45  }
46 
47  public function execute() {
48  global $wgEnableOpenSearchSuggest, $wgSearchSuggestCacheExpiry;
49  $params = $this->extractRequestParams();
50  $search = $params['search'];
51  $limit = $params['limit'];
52  $namespaces = $params['namespace'];
53  $suggest = $params['suggest'];
54 
55  // Some script that was loaded regardless of wgEnableOpenSearchSuggest, likely cached.
56  if ( $suggest && !$wgEnableOpenSearchSuggest ) {
57  $searches = array();
58  } else {
59  // Open search results may be stored for a very long time
60  $this->getMain()->setCacheMaxAge( $wgSearchSuggestCacheExpiry );
61  $this->getMain()->setCacheMode( 'public' );
62 
63  $searcher = new StringPrefixSearch;
64  $searches = $searcher->searchWithVariants( $search, $limit, $namespaces );
65  }
66  // Set top level elements
67  $result = $this->getResult();
68  $result->addValue( null, 0, $search );
69  $result->addValue( null, 1, $searches );
70  }
71 
72  public function getAllowedParams() {
73  global $wgOpenSearchDefaultLimit;
74 
75  return array(
76  'search' => null,
77  'limit' => array(
78  ApiBase::PARAM_DFLT => $wgOpenSearchDefaultLimit,
79  ApiBase::PARAM_TYPE => 'limit',
80  ApiBase::PARAM_MIN => 1,
81  ApiBase::PARAM_MAX => 100,
82  ApiBase::PARAM_MAX2 => 100
83  ),
84  'namespace' => array(
86  ApiBase::PARAM_TYPE => 'namespace',
88  ),
89  'suggest' => false,
90  'format' => array(
91  ApiBase::PARAM_DFLT => 'json',
92  ApiBase::PARAM_TYPE => array( 'json', 'jsonfm' ),
93  )
94  );
95  }
96 
97  public function getParamDescription() {
98  return array(
99  'search' => 'Search string',
100  'limit' => 'Maximum amount of results to return',
101  'namespace' => 'Namespaces to search',
102  'suggest' => 'Do nothing if $wgEnableOpenSearchSuggest is false',
103  'format' => 'The format of the output',
104  );
105  }
106 
107  public function getDescription() {
108  return 'Search the wiki using the OpenSearch protocol.';
109  }
110 
111  public function getExamples() {
112  return array(
113  'api.php?action=opensearch&search=Te'
114  );
115  }
116 
117  public function getHelpUrls() {
118  return 'https://www.mediawiki.org/wiki/API:Opensearch';
119  }
120 }
ApiOpenSearch\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiOpenSearch.php:107
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiOpenSearch\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiOpenSearch.php:97
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiOpenSearch
Definition: ApiOpenSearch.php:28
$params
$params
Definition: styleTest.css.php:40
$limit
if( $sleep) $limit
Definition: importImages.php:99
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
NS_MAIN
const NS_MAIN
Definition: Defines.php:79
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
ApiOpenSearch\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiOpenSearch.php:47
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:52
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
ApiOpenSearch\getCustomPrinter
getCustomPrinter()
Override built-in handling of format parameter.
Definition: ApiOpenSearch.php:36
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
PrefixSearch\searchWithVariants
searchWithVariants( $search, $limit, array $namespaces)
Do a prefix search for all possible variants of the prefix.
Definition: PrefixSearch.php:91
ApiOpenSearch\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiOpenSearch.php:111
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$namespaces
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:815
ApiOpenSearch\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiOpenSearch.php:72
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:188
ApiOpenSearch\getHelpUrls
getHelpUrls()
Definition: ApiOpenSearch.php:117
StringPrefixSearch
Performs prefix search, returning strings.
Definition: PrefixSearch.php:296