MediaWiki  1.23.2
ApiQueryORM.php
Go to the documentation of this file.
1 <?php
2 
29 abstract class ApiQueryORM extends ApiQueryBase {
30 
38  abstract protected function getTable();
39 
50  protected function getRowName() {
51  return 'item';
52  }
53 
64  protected function getListName() {
65  return 'items';
66  }
67 
75  protected function getResultPath() {
76  return null;
77  }
78 
85  public function execute() {
86  $params = $this->getParams();
87 
88  if ( !in_array( 'id', $params['props'] ) ) {
89  $params['props'][] = 'id';
90  }
91 
92  $results = $this->getResults( $params, $this->getConditions( $params ) );
93  $this->addResults( $params, $results );
94  }
95 
104  protected function getParams() {
105  return array_filter(
106  $this->extractRequestParams(),
107  function ( $prop ) {
108  return isset( $prop );
109  }
110  );
111  }
112 
124  protected function getConditions( array $params ) {
125  $conditions = array();
126  $fields = $this->getTable()->getFields();
127 
128  foreach ( $params as $name => $value ) {
129  if ( array_key_exists( $name, $fields ) ) {
130  $conditions[$name] = $value;
131  }
132  }
133 
134  return $conditions;
135  }
136 
147  protected function getResults( array $params, array $conditions ) {
148  return $this->getTable()->select(
149  $params['props'],
150  $conditions,
151  array(
152  'LIMIT' => $params['limit'] + 1,
153  'ORDER BY' => $this->getTable()->getPrefixedField( 'id' ) . ' ASC',
154  ),
155  __METHOD__
156  );
157  }
158 
167  protected function addResults( array $params, ORMResult $results ) {
168  $serializedResults = array();
169  $count = 0;
170 
171  foreach ( $results as /* IORMRow */ $result ) {
172  if ( ++$count > $params['limit'] ) {
173  // We've reached the one extra which shows that
174  // there are additional pages to be had. Stop here...
175  $this->setContinueEnumParameter( 'continue', $result->getId() );
176  break;
177  }
178 
179  $serializedResults[] = $this->formatRow( $result, $params );
180  }
181 
182  $this->setIndexedTagNames( $serializedResults );
183  $this->addSerializedResults( $serializedResults );
184  }
185 
196  protected function formatRow( IORMRow $result, array $params ) {
197  return $result->toArray( $params['props'] );
198  }
199 
207  protected function setIndexedTagNames( array &$serializedResults ) {
208  $this->getResult()->setIndexedTagName( $serializedResults, $this->getRowName() );
209  }
210 
218  protected function addSerializedResults( array $serializedResults ) {
219  $this->getResult()->addValue(
220  $this->getResultPath(),
221  $this->getListName(),
222  $serializedResults
223  );
224  }
225 
230  public function getAllowedParams() {
231  $params = array(
232  'props' => array(
233  ApiBase::PARAM_TYPE => $this->getTable()->getFieldNames(),
234  ApiBase::PARAM_ISMULTI => true,
235  ApiBase::PARAM_REQUIRED => true,
236  ),
237  'limit' => array(
238  ApiBase::PARAM_DFLT => 20,
239  ApiBase::PARAM_TYPE => 'limit',
240  ApiBase::PARAM_MIN => 1,
243  ),
244  'continue' => null,
245  );
246 
247  return array_merge( $this->getTable()->getAPIParams(), $params );
248  }
249 
254  public function getParamDescription() {
255  $descriptions = array(
256  'props' => 'Fields to query',
257  'continue' => 'Offset number from where to continue the query',
258  'limit' => 'Max amount of rows to return',
259  );
260 
261  return array_merge( $this->getTable()->getFieldDescriptions(), $descriptions );
262  }
263 }
ApiQueryORM\execute
execute()
Get the parameters, find out what the conditions for the query are, run it, and add the results.
Definition: ApiQueryORM.php:85
ORMResult
Definition: ORMResult.php:32
$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
IORMRow
Definition: IORMRow.php:34
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ApiQueryORM\getParamDescription
getParamDescription()
Definition: ApiQueryORM.php:254
ApiQueryORM\addResults
addResults(array $params, ORMResult $results)
Serialize the results and add them to the result object.
Definition: ApiQueryORM.php:167
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiQueryBase\$fields
$fields
Definition: ApiQueryBase.php:36
ApiQueryORM\getListName
getListName()
Returns the name of the list of rows.
Definition: ApiQueryORM.php:64
$params
$params
Definition: styleTest.css.php:40
ApiQueryORM\getParams
getParams()
Get the request parameters and remove all params set to null (ie those that are not actually provided...
Definition: ApiQueryORM.php:104
ApiQueryORM
Definition: ApiQueryORM.php:29
ApiQueryORM\formatRow
formatRow(IORMRow $result, array $params)
Formats a row to it's desired output format.
Definition: ApiQueryORM.php:196
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:34
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Definition: ApiBase.php:78
ApiQueryORM\addSerializedResults
addSerializedResults(array $serializedResults)
Add the serialized results to the result object.
Definition: ApiQueryORM.php:218
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.
ApiQueryORM\setIndexedTagNames
setIndexedTagNames(array &$serializedResults)
Set the tag names for formats such as XML.
Definition: ApiQueryORM.php:207
ApiQueryORM\getTable
getTable()
Returns an instance of the IORMTable table being queried.
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
ApiQueryORM\getAllowedParams
getAllowedParams()
Definition: ApiQueryORM.php:230
$value
$value
Definition: styleTest.css.php:45
ApiQueryORM\getResults
getResults(array $params, array $conditions)
Get the actual results.
Definition: ApiQueryORM.php:147
$count
$count
Definition: UtfNormalTest2.php:96
ApiQueryORM\getResultPath
getResultPath()
Returns the path to where the items results should be added in the result.
Definition: ApiQueryORM.php:75
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Definition: ApiBase.php:79
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\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
ApiQueryBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
Definition: ApiQueryBase.php:404
ApiQueryORM\getConditions
getConditions(array $params)
Get the conditions for the query.
Definition: ApiQueryORM.php:124
ApiQueryORM\getRowName
getRowName()
Returns the name of the individual rows.
Definition: ApiQueryORM.php:50