ApiDisabled Class Reference
[API]

Created on Sep 25, 2008 API for MediaWiki 1.8+. More...

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 isReadMode ()
 Indicates whether this module requires read rights.
 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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.


Detailed Description

Created on Sep 25, 2008 API for MediaWiki 1.8+.

Copyright © 2008 Roan Kattouw <Firstname>.<Lastname>.nl

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.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. http://www.gnu.org/copyleft/gpl.html API module that dies with an error immediately.

Use this to disable core modules with $wgAPIModules['modulename'] = 'ApiDisabled';

To disable submodules of action=query, use ApiQueryDisabled instead

Definition at line 40 of file ApiDisabled.php.


Constructor & Destructor Documentation

ApiDisabled::__construct ( main,
action 
)

Definition at line 42 of file ApiDisabled.php.

References $action.


Member Function Documentation

ApiDisabled::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 46 of file ApiDisabled.php.

References ApiBase::dieUsage().

ApiDisabled::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

Reimplemented from ApiBase.

Definition at line 54 of file ApiDisabled.php.

ApiDisabled::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 62 of file ApiDisabled.php.

ApiDisabled::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 68 of file ApiDisabled.php.

ApiDisabled::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

Reimplemented from ApiBase.

Definition at line 58 of file ApiDisabled.php.

ApiDisabled::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 72 of file ApiDisabled.php.

ApiDisabled::isReadMode (  ) 

Indicates whether this module requires read rights.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 50 of file ApiDisabled.php.


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

Generated on Sat Apr 30 22:57:30 2011 for MediaWiki by  doxygen 1.5.9