MediaWiki  1.23.2
ApiQueryPrefixSearch.php
Go to the documentation of this file.
1 <?php
26  public function __construct( $query, $moduleName ) {
27  parent::__construct( $query, $moduleName, 'ps' );
28  }
29 
30  public function execute() {
31  $this->run();
32  }
33 
34  public function executeGenerator( $resultPageSet ) {
35  $this->run( $resultPageSet );
36  }
37 
41  private function run( $resultPageSet = null ) {
42  $params = $this->extractRequestParams();
43  $search = $params['search'];
44  $limit = $params['limit'];
45  $namespaces = $params['namespace'];
46 
47  $searcher = new TitlePrefixSearch;
48  $titles = $searcher->searchWithVariants( $search, $limit, $namespaces );
49  if ( $resultPageSet ) {
50  $resultPageSet->populateFromTitles( $titles );
51  } else {
52  $result = $this->getResult();
53  foreach ( $titles as $title ) {
54  if ( !$limit-- ) {
55  break;
56  }
57  $vals = array(
58  'ns' => intval( $title->getNamespace() ),
59  'title' => $title->getPrefixedText(),
60  );
61  if ( $title->isSpecialPage() ) {
62  $vals['special'] = '';
63  } else {
64  $vals['pageid'] = intval( $title->getArticleId() );
65  }
66  $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
67  if ( !$fit ) {
68  break;
69  }
70  }
71  $result->setIndexedTagName_internal(
72  array( 'query', $this->getModuleName() ), $this->getModulePrefix()
73  );
74  }
75  }
76 
77  public function getCacheMode( $params ) {
78  return 'public';
79  }
80 
81  public function getAllowedParams() {
82  return array(
83  'search' => array(
84  ApiBase::PARAM_TYPE => 'string',
86  ),
87  'namespace' => array(
89  ApiBase::PARAM_TYPE => 'namespace',
90  ApiBase::PARAM_ISMULTI => true,
91  ),
92  'limit' => array(
93  ApiBase::PARAM_DFLT => 10,
94  ApiBase::PARAM_TYPE => 'limit',
95  ApiBase::PARAM_MIN => 1,
96  ApiBase::PARAM_MAX => 100, // Non-standard value for compatibility
97  // with action=opensearch
98  ApiBase::PARAM_MAX2 => 200,
99  ),
100  );
101  }
102 
103  public function getParamDescription() {
104  return array(
105  'search' => 'Search string',
106  'limit' => 'Maximum amount of results to return',
107  'namespace' => 'Namespaces to search',
108  );
109  }
110 
111  public function getDescription() {
112  return 'Perform a prefix search for page titles';
113  }
114 
115  public function getExamples() {
116  return array(
117  'api.php?action=query&list=prefixsearch&pssearch=meaning',
118  );
119  }
120 
121  public function getHelpUrls() {
122  return 'https://www.mediawiki.org/wiki/API:Prefixsearch';
123  }
124 }
$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
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ApiQueryPrefixSearch\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryPrefixSearch.php:77
TitlePrefixSearch
Performs prefix search, returning Title objects.
Definition: PrefixSearch.php:277
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
$params
$params
Definition: styleTest.css.php:40
$limit
if( $sleep) $limit
Definition: importImages.php:99
ApiQueryPrefixSearch\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryPrefixSearch.php:81
NS_MAIN
const NS_MAIN
Definition: Defines.php:79
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
$titles
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
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.
ApiQueryPrefixSearch\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryPrefixSearch.php:34
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:165
ApiQueryPrefixSearch\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryPrefixSearch.php:30
ApiQueryPrefixSearch
Definition: ApiQueryPrefixSearch.php:25
ApiQueryPrefixSearch\getHelpUrls
getHelpUrls()
Definition: ApiQueryPrefixSearch.php:121
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
ApiQueryPrefixSearch\__construct
__construct( $query, $moduleName)
Definition: ApiQueryPrefixSearch.php:26
ApiQueryPrefixSearch\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiQueryPrefixSearch.php:103
ApiQueryPrefixSearch\run
run( $resultPageSet=null)
Definition: ApiQueryPrefixSearch.php:41
ApiQueryPrefixSearch\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiQueryPrefixSearch.php:111
ApiQueryGeneratorBase
Definition: ApiQueryBase.php:626
ApiQueryPrefixSearch\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiQueryPrefixSearch.php:115
$namespaces
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:815
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
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\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105