MediaWiki  REL1_20
Public Member Functions | Protected Member Functions
LoggedUpdateMaintenance Class Reference

Class for scripts that perform database maintenance and want to log the update in `updatelog` so we can later skip it. More...

Inheritance diagram for LoggedUpdateMaintenance:
Inheritance graph
[legend]
Collaboration diagram for LoggedUpdateMaintenance:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 Default constructor.
 execute ()
 Do the actual work.

Protected Member Functions

 doDBUpdates ()
 Do the actual work.
 getUpdateKey ()
 Get the update key name to go in the update log table.
 updatelogFailedMessage ()
 Message to show the the update log was unable to log the completion of this update.
 updateSkippedMessage ()
 Message to show that the update was done already and was just skipped.

Detailed Description

Class for scripts that perform database maintenance and want to log the update in `updatelog` so we can later skip it.

Definition at line 1246 of file Maintenance.php.

Constructor & Destructor Documentation

LoggedUpdateMaintenance::__construct ( )

Default constructor.

Children should call this *first* if implementing their own constructors

Reimplemented from Maintenance.

Reimplemented in PopulateLogSearch, PopulateLogUsertext, FixExtLinksProtocolRelative, PopulateParentId, PopulateRevisionSha1, PopulateRevisionLength, and PopulateImageSha1.

Definition at line 1247 of file Maintenance.php.

Member Function Documentation

LoggedUpdateMaintenance::doDBUpdates ( ) [abstract, protected]

Do the actual work.

All child classes will need to implement this. Return true to log the update as done or false (usually on failure).

Returns:
Bool

Reimplemented in PopulateImageSha1, PopulateLogSearch, PopulateLogUsertext, FixExtLinksProtocolRelative, PopulateParentId, PopulateRevisionLength, and PopulateRevisionSha1.

LoggedUpdateMaintenance::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Reimplemented in PopulateImageSha1.

Definition at line 1253 of file Maintenance.php.

LoggedUpdateMaintenance::getUpdateKey ( ) [abstract, protected]

Get the update key name to go in the update log table.

Returns:
String

Reimplemented in PopulateLogSearch, PopulateLogUsertext, PopulateImageSha1, FixExtLinksProtocolRelative, PopulateParentId, PopulateRevisionSha1, and PopulateRevisionLength.

LoggedUpdateMaintenance::updatelogFailedMessage ( ) [protected]

Message to show the the update log was unable to log the completion of this update.

Returns:
String

Definition at line 1291 of file Maintenance.php.

LoggedUpdateMaintenance::updateSkippedMessage ( ) [protected]

Message to show that the update was done already and was just skipped.

Returns:
String

Reimplemented in PopulateLogSearch, PopulateLogUsertext, PopulateImageSha1, FixExtLinksProtocolRelative, PopulateParentId, and PopulateRevisionLength.

Definition at line 1282 of file Maintenance.php.

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