[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/api/ -> ApiQueryORM.php (summary)

Base query module for querying results from ORMTables. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Author: Jeroen De Dauw < [email protected] >
License: GNU GPL v2+
File Size: 263 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 13 functions

  getRowName()
  getListName()
  getResultPath()
  execute()
  getParams()
  getConditions()
  getResults()
  addResults()
  formatRow()
  setIndexedTagNames()
  addSerializedResults()
  getAllowedParams()
  getParamDescription()

Functions
Functions that are not part of a class:

getRowName()   X-Ref
Returns the name of the individual rows.
For example: page, user, contest, campaign, etc.
This is used to appropriately name elements in XML.
Deriving classes typically override this method.

return: string

getListName()   X-Ref
Returns the name of the list of rows.
For example: pages, users, contests, campaigns, etc.
This is used to appropriately name nodes in the output.
Deriving classes typically override this method.

return: string

getResultPath()   X-Ref
Returns the path to where the items results should be added in the result.

return: null|string|array

execute()   X-Ref
Get the parameters, find out what the conditions for the query are,
run it, and add the results.


getParams()   X-Ref
Get the request parameters and remove all params set
to null (ie those that are not actually provided).

return: array

getConditions( array $params )   X-Ref
No description

getResults( array $params, array $conditions )   X-Ref
Get the actual results.

param: array $params
param: array $conditions
return: ORMResult

addResults( array $params, ORMResult $results )   X-Ref
Serialize the results and add them to the result object.

param: array $params
param: ORMResult $results

formatRow( IORMRow $result, array $params )   X-Ref
Formats a row to it's desired output format.

param: IORMRow $result
param: array $params
return: mixed

setIndexedTagNames( array &$serializedResults )   X-Ref
Set the tag names for formats such as XML.

param: array $serializedResults

addSerializedResults( array $serializedResults )   X-Ref
Add the serialized results to the result object.

param: array $serializedResults

getAllowedParams()   X-Ref

return: array

getParamDescription()   X-Ref

return: array



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1