A query module to show basic page information. More...

Inheritance diagram for ApiQueryPageProps:

Collaboration diagram for ApiQueryPageProps:

Public Member Functions
	__construct ($query, $moduleName)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Private Member Functions
	addPageProps ($result, $page, $props)
	Add page properties to an ApiResult, adding a continue parameter if it doesn't fit.
Private Attributes
	$params

Detailed Description

A query module to show basic page information.

Definition at line 32 of file ApiQueryPageProps.php.

Constructor & Destructor Documentation

ApiQueryPageProps::__construct	(	$	query,
		$	moduleName
	)

Definition at line 36 of file ApiQueryPageProps.php.

Member Function Documentation

ApiQueryPageProps::addPageProps	(	$	result,
		$	page,
		$	props
	)		`[private]`

Add page properties to an ApiResult, adding a continue parameter if it doesn't fit.

Parameters:

$result	ApiResult
$page	int
$props	array

Returns:: bool True if it fits in the result

Definition at line 109 of file ApiQueryPageProps.php.

References $page, $result, and ApiQueryBase\setContinueEnumParameter().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQueryPageProps::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 40 of file ApiQueryPageProps.php.

References $res, $result, ApiQueryBase\addFields(), ApiQueryBase\addOption(), addPageProps(), ApiQueryBase\addTables(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiBase\extractRequestParams(), ApiQueryBase\getPageSet(), ApiBase\getResult(), and ApiQueryBase\select().

Here is the call graph for this function:

ApiQueryPageProps::getAllowedParams ( )

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Returns:: array or false

Reimplemented from ApiBase.

Definition at line 122 of file ApiQueryPageProps.php.

ApiQueryPageProps::getCacheMode ( $ params )

Get the cache mode for the data generated by this module.

Override this in the module subclass. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

$params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 118 of file ApiQueryPageProps.php.

ApiQueryPageProps::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 136 of file ApiQueryPageProps.php.

ApiQueryPageProps::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 140 of file ApiQueryPageProps.php.

ApiQueryPageProps::getHelpUrls ( )

Returns:: false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 146 of file ApiQueryPageProps.php.

ApiQueryPageProps::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:: array or false

Reimplemented from ApiBase.

Definition at line 129 of file ApiQueryPageProps.php.

ApiQueryPageProps::getVersion ( )

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:: string

Reimplemented from ApiBase.

Definition at line 150 of file ApiQueryPageProps.php.

Member Data Documentation

ApiQueryPageProps::$params [private]

Definition at line 34 of file ApiQueryPageProps.php.

The documentation for this class was generated from the following file:

includes/api/ApiQueryPageProps.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation