MediaWiki  REL1_22
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
TableCleanup Class Reference
Maintenance

Generic class to cleanup a database table. More...

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

List of all members.

Public Member Functions

 __construct ()
 execute ()
 runTable ($params)

Public Attributes

 $batchSize = 100
 $count
 $reportInterval = 100
 $startTime
 $table
 $updated

Protected Member Functions

 hexChar ($matches)
 init ($count, $table)
 progress ($updated)

Protected Attributes

 $defaultParams
 $dryrun = false
 $maxLag = 10
 $processed

Detailed Description

Generic class to cleanup a database table.

Already subclasses Maintenance.

Definition at line 31 of file cleanupTable.inc.

Constructor & Destructor Documentation

TableCleanup::__construct ( )

Reimplemented from Maintenance.

Reimplemented in ImageCleanup, WatchlistCleanup, CapsCleanup, and TitleCleanup.

Definition at line 46 of file cleanupTable.inc.

References Maintenance\addOption().

Member Function Documentation

TableCleanup::execute ( )

Reimplemented from Maintenance.

Reimplemented in WatchlistCleanup, and CapsCleanup.

Definition at line 51 of file cleanupTable.inc.

References $wgUser, global, Maintenance\hasOption(), User\newFromName(), Maintenance\output(), and runTable().

TableCleanup::hexChar ( $  matches) [protected]
Parameters:
array$matches
Returns:
string

Definition at line 171 of file cleanupTable.inc.

References $matches.

TableCleanup::init ( $  count,
$  table 
) [protected]

Definition at line 63 of file cleanupTable.inc.

References $count, $table, and table.

Referenced by runTable().

TableCleanup::progress ( $  updated) [protected]
Parameters:
int$updated

Definition at line 74 of file cleanupTable.inc.

References $updated, Maintenance\output(), table, wfTimestamp(), and wfWikiID().

Referenced by TitleCleanup\processRow(), ImageCleanup\processRow(), WatchlistCleanup\processRow(), CapsCleanup\processRow(), and TableCleanupTest\processRow().

TableCleanup::runTable ( $  params)
Parameters:
array$params
Exceptions:
MWException

Definition at line 108 of file cleanupTable.inc.

References $count, $dbr, $options, $params, $res, $table, array(), as, init(), Maintenance\output(), and wfGetDB().

Referenced by CapsCleanup\execute(), and execute().

Member Data Documentation

TableCleanup::$batchSize = 100

Definition at line 41 of file cleanupTable.inc.

TableCleanup::$count

Definition at line 44 of file cleanupTable.inc.

Referenced by init(), and runTable().

TableCleanup::$defaultParams [protected]
Initial value:
 array(
        'table' => 'page',
        'conds' => array(),
        'index' => 'page_id',
        'callback' => 'processRow',
    )

Reimplemented in ImageCleanup, and WatchlistCleanup.

Definition at line 32 of file cleanupTable.inc.

TableCleanup::$dryrun = false [protected]

Definition at line 39 of file cleanupTable.inc.

TableCleanup::$maxLag = 10 [protected]

Definition at line 40 of file cleanupTable.inc.

TableCleanup::$processed [protected]

Definition at line 44 of file cleanupTable.inc.

TableCleanup::$reportInterval = 100

Definition at line 42 of file cleanupTable.inc.

TableCleanup::$startTime

Definition at line 44 of file cleanupTable.inc.

TableCleanup::$table

Definition at line 44 of file cleanupTable.inc.

Referenced by init(), and runTable().

TableCleanup::$updated

Definition at line 44 of file cleanupTable.inc.

Referenced by WatchlistCleanup\processRow(), and progress().

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