CommandLineInc Class Reference

Backwards-compatibility wrapper for old-style maintenance scripts. More...

Inherits Maintenance.

List of all members.

Public Member Functions

 __construct ()
 Default constructor.
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 execute ()
 Do the actual work.

Protected Member Functions

 maybeHelp ($force=false)
 No help, it would just be misleading since it misses custom options.


Detailed Description

Backwards-compatibility wrapper for old-style maintenance scripts.

Definition at line 12 of file commandLine.inc.


Constructor & Destructor Documentation

CommandLineInc::__construct (  ) 

Default constructor.

Children should call this if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 13 of file commandLine.inc.

References $name, $optionsWithArgs, and Maintenance::addOption().


Member Function Documentation

CommandLineInc::execute (  ) 

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 37 of file commandLine.inc.

References $options.

CommandLineInc::getDbType (  ) 

Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Returns:
int

Reimplemented from Maintenance.

Definition at line 21 of file commandLine.inc.

References $wgUseNormalUser, Maintenance::DB_ADMIN, and Maintenance::DB_STD.

CommandLineInc::maybeHelp ( force = false  )  [protected]

No help, it would just be misleading since it misses custom options.

Reimplemented from Maintenance.

Definition at line 31 of file commandLine.inc.


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

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