MediaWiki master
DumpIterator Class Reference

Base class for iterating over a dump. More...

Inherits Maintenance.

Inherited by CompareParsers, and SearchDump.

Collaboration diagram for DumpIterator:

Public Member Functions

 __construct ()
 
 checkOptions ()
 Stub function for processing additional options.
 
 conclusions ()
 Stub function for giving data about what was computed.
 
 execute ()
 
 finalSetup (SettingsBuilder $settingsBuilder)
 
 handleRevision ( $rev)
 Callback function for each revision, child classes should override processRevision instead.
 
 processRevision (WikiRevision $rev)
 Core function which does whatever the maintenance script is designed to do.
 

Static Public Member Functions

static disableInterwikis ( $prefix, &$data)
 

Detailed Description

Base class for iterating over a dump.

Definition at line 46 of file dumpIterator.php.

Constructor & Destructor Documentation

◆ __construct()

DumpIterator::__construct ( )

Reimplemented in CompareParsers, and SearchDump.

Definition at line 54 of file dumpIterator.php.

Member Function Documentation

◆ checkOptions()

DumpIterator::checkOptions ( )

Stub function for processing additional options.

Reimplemented in CompareParsers.

Definition at line 177 of file dumpIterator.php.

Referenced by execute().

◆ conclusions()

DumpIterator::conclusions ( )

Stub function for giving data about what was computed.

Reimplemented in CompareParsers.

Definition at line 183 of file dumpIterator.php.

Referenced by execute().

◆ disableInterwikis()

static DumpIterator::disableInterwikis ( $prefix,
& $data )
static

Definition at line 140 of file dumpIterator.php.

◆ execute()

DumpIterator::execute ( )

Definition at line 62 of file dumpIterator.php.

References $params, $source, checkOptions(), conclusions(), handleRevision(), and wfMessage().

◆ finalSetup()

DumpIterator::finalSetup ( SettingsBuilder $settingsBuilder)

◆ handleRevision()

DumpIterator::handleRevision ( $rev)

Callback function for each revision, child classes should override processRevision instead.

Parameters
WikiRevision$rev

Definition at line 152 of file dumpIterator.php.

References processRevision().

Referenced by execute().

◆ processRevision()

DumpIterator::processRevision ( WikiRevision $rev)
abstract

Core function which does whatever the maintenance script is designed to do.

Parameters
WikiRevision$rev

Reimplemented in CompareParsers, and SearchDump.

Referenced by handleRevision().


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