MediaWiki  REL1_19
Public Member Functions | Static Public Member Functions | Private Member Functions
ApiQueryExtLinksUsage Class Reference
API
Inheritance diagram for ApiQueryExtLinksUsage:
Inheritance graph
[legend]
Collaboration diagram for ApiQueryExtLinksUsage:
Collaboration graph
[legend]

List of all members.

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.
 getPossibleErrors ()
 getVersion ()
 Returns a string that identifies the version of the extending class.

Static Public Member Functions

static getProtocolPrefix ($protocol)
static prepareProtocols ()

Private Member Functions

 run ($resultPageSet=null)

Detailed Description

Definition at line 30 of file ApiQueryExtLinksUsage.php.

Constructor & Destructor Documentation

ApiQueryExtLinksUsage::__construct ( $  query,
$  moduleName 
)

Definition at line 32 of file ApiQueryExtLinksUsage.php.

Member Function Documentation

ApiQueryExtLinksUsage::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 36 of file ApiQueryExtLinksUsage.php.

References run().

Here is the call graph for this function:

ApiQueryExtLinksUsage::executeGenerator ( $  resultPageSet)

Execute this module as a generator.

Parameters:
$resultPageSetApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 44 of file ApiQueryExtLinksUsage.php.

References run().

Here is the call graph for this function:

ApiQueryExtLinksUsage::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 143 of file ApiQueryExtLinksUsage.php.

References ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.

ApiQueryExtLinksUsage::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 40 of file ApiQueryExtLinksUsage.php.

ApiQueryExtLinksUsage::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 235 of file ApiQueryExtLinksUsage.php.

ApiQueryExtLinksUsage::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 245 of file ApiQueryExtLinksUsage.php.

ApiQueryExtLinksUsage::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 251 of file ApiQueryExtLinksUsage.php.

ApiQueryExtLinksUsage::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 204 of file ApiQueryExtLinksUsage.php.

References $wgMiserMode, and ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQueryExtLinksUsage::getPossibleErrors ( )
Returns:
array

Reimplemented from ApiQueryBase.

Definition at line 239 of file ApiQueryExtLinksUsage.php.

static ApiQueryExtLinksUsage::getProtocolPrefix ( $  protocol) [static]

Definition at line 187 of file ApiQueryExtLinksUsage.php.

References $wgUrlProtocols.

Referenced by ApiQueryExternalLinks\execute(), and run().

Here is the caller graph for this function:

ApiQueryExtLinksUsage::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 255 of file ApiQueryExtLinksUsage.php.

static ApiQueryExtLinksUsage::prepareProtocols ( ) [static]

Definition at line 176 of file ApiQueryExtLinksUsage.php.

References $wgUrlProtocols.

Referenced by ApiQueryExternalLinks\getAllowedParams().

Here is the caller graph for this function:

ApiQueryExtLinksUsage::run ( $  resultPageSet = null) [private]
Parameters:
$resultPageSetApiPageSet
Returns:
void

Definition at line 52 of file ApiQueryExtLinksUsage.php.

References $count, $limit, $res, $result, $title, $wgMiserMode, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), getProtocolPrefix(), ApiBase\getResult(), Title\makeTitle(), ApiQueryBase\prepareUrlQuerySearchString(), ApiQueryBase\select(), and ApiQueryBase\setContinueEnumParameter().

Referenced by execute(), and executeGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

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