MediaWiki  1.23.2
DumpIterator Class Reference

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

Inheritance diagram for DumpIterator:
Collaboration diagram for DumpIterator:

Public Member Functions

 __construct ()
 Default constructor. More...
 checkOptions ()
 conclusions ()
 execute ()
 Do the actual work. More...
 finalSetup ()
 Handle some last-minute setup here. More...
 handleRevision ( $rev)
 Callback function for each revision, child classes should override processRevision instead. More...
 processRevision ( $rev)
- Public Member Functions inherited from Maintenance
 cleanupChanneled ()
 Clean up channeled output. More...
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 getName ()
 Get the script's name. More...
 globals ()
 Potentially debug globals. More...
 isQuiet ()
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More...
 loadSettings ()
 Generic setup for most installs. More...
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 setDB (&$db)
 Sets database object to be returned by getDB(). More...
 setup ()
 Do some sanity checking and basic setup. More...
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...

Static Public Member Functions

static disableInterwikis ( $prefix, &$data)
- Static Public Member Functions inherited from Maintenance
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
static shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More...

Private Attributes

 $count = 0

Additional Inherited Members

- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type. More...
const DB_STD = 1
const STDIN_ALL = 'all'
- Protected Member Functions inherited from Maintenance
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 addDescription ( $text)
 Set the description text. More...
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false)
 Add a parameter to the script. More...
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 deleteOption ( $name)
 Remove an option. More...
 error ( $err, $die=0)
 Throw an error to the user. More...
 getArg ( $argId=0, $default=null)
 Get an argument. More...
getDB ( $db, $groups=array(), $wiki=false)
 Returns a database to be used by current maintenance script. More...
 getDir ()
 Get the maintenance directory. More...
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 getStdin ( $len=null)
 Return input from stdin. More...
 hasArg ( $argId=0)
 Does a given argument exist? More...
 hasOption ( $name)
 Checks to see if a particular param exists. More...
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 maybeHelp ( $force=false)
 Maybe show the help. More...
 output ( $out, $channel=null)
 Throw some output to the user. More...
 setBatchSize ( $s=0)
 Set the batch size. More...
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
- Protected Attributes inherited from Maintenance
 $mArgList = array()
 $mArgs = array()
int $mBatchSize = null
 Batch size. More...
 $mDescription = ''
 $mInputLoaded = false
 $mOptions = array()
 $mParams = array()
 $mQuiet = false
 $mShortParamsMap = array()

Detailed Description

Base class for interating over a dump.

Definition at line 36 of file dumpIterator.php.

Constructor & Destructor Documentation

◆ __construct()

DumpIterator::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Reimplemented in SearchDump, PreprocessDump, and CompareParsers.

Definition at line 41 of file dumpIterator.php.

References Maintenance\addOption().

Member Function Documentation

◆ checkOptions()

DumpIterator::checkOptions ( )

Reimplemented in CompareParsers, and PreprocessDump.

Definition at line 139 of file dumpIterator.php.

Referenced by execute().

◆ conclusions()

DumpIterator::conclusions ( )

Reimplemented in CompareParsers.

Definition at line 144 of file dumpIterator.php.

Referenced by execute().

◆ disableInterwikis()

static DumpIterator::disableInterwikis (   $prefix,

Definition at line 105 of file dumpIterator.php.

◆ execute()

DumpIterator::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 49 of file dumpIterator.php.

References $source, $startTime, array(), checkOptions(), conclusions(), Maintenance\error(), from, Maintenance\getOption(), Maintenance\getStdin(), handleRevision(), Maintenance\hasOption(), Title\newFromText(), and WikiRevision\setText().

◆ finalSetup()

DumpIterator::finalSetup ( )

Handle some last-minute setup here.

Reimplemented from Maintenance.

Definition at line 94 of file dumpIterator.php.

References $wgHooks, Maintenance\DB_NONE, Maintenance\getDbType(), and global.

◆ handleRevision()

DumpIterator::handleRevision (   $rev)

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


Definition at line 117 of file dumpIterator.php.

References $rev, $title, Maintenance\error(), from, Maintenance\output(), and processRevision().

Referenced by execute().

◆ processRevision()

DumpIterator::processRevision (   $rev)

Reimplemented in SearchDump, CompareParsers, and PreprocessDump.

Referenced by handleRevision().

Member Data Documentation

◆ $count

DumpIterator::$count = 0

Definition at line 38 of file dumpIterator.php.

◆ $startTime


Definition at line 39 of file dumpIterator.php.

Referenced by execute().

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