Query module to enumerate all create-protected pages. More...

Inheritance diagram for ApiQueryProtectedTitles:

Collaboration diagram for ApiQueryProtectedTitles:

Public Member Functions
	__construct ($query, $moduleName)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	executeGenerator ($resultPageSet)
	Execute this module as a generator.
	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
	run ($resultPageSet=null)

Detailed Description

Query module to enumerate all create-protected pages.

Definition at line 32 of file ApiQueryProtectedTitles.php.

Constructor & Destructor Documentation

ApiQueryProtectedTitles::__construct	(	$	query,
		$	moduleName
	)

Definition at line 34 of file ApiQueryProtectedTitles.php.

Member Function Documentation

ApiQueryProtectedTitles::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 38 of file ApiQueryProtectedTitles.php.

References run().

Here is the call graph for this function:

ApiQueryProtectedTitles::executeGenerator ( $ resultPageSet )

Execute this module as a generator.

Parameters:

$resultPageSet ApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 42 of file ApiQueryProtectedTitles.php.

References run().

Here is the call graph for this function:

ApiQueryProtectedTitles::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.