Inheritance diagram for BackupDumper:

Collaboration diagram for BackupDumper:

Public Member Functions
	__construct ($args)
	__destruct ()
	backupDb ()
	backupServer ()
	dump ($history, $text=WikiExporter::TEXT)
	fatalError ($msg)
	initProgress ($history=WikiExporter::FULL)
	Initialise starting time and maximum revision count.
	loadPlugin ($class, $file)
	Load a plugin and register it.
	processArgs ($args)
	processOption ($opt, $val, $param)
	progress ($string)
	registerFilter ($name, $class)
	registerOutput ($name, $class)
	report ($final=false)
	reportPage ()
	revCount ()
	setDb (DatabaseBase $db=null)
	Force the dump to use the provided database connection for database operations, wherever possible.
	showReport ()
Public Attributes
	$dumpUploadFileContents = false
	$dumpUploads = false
	$endId = 0
	$filterTypes = array()
	$ID = 0
	$lastTime = 0
	$outputTypes = array()
	$pageCount = 0
	$pageCountLast = 0
	$pages = null
	$reporting = true
	$reportingInterval = 100
	$revCount = 0
	$revCountLast = 0
	$revEndId = 0
	$revStartId = 0
	$server = null
	$sink = null
	$skipFooter = false
	$skipHeader = false
	$startId = 0
	$stubText = false
Protected Attributes
DatabaseBase null	$forcedDb = null
	The dependency-injected database to use.
LoadBalancer	$lb

Detailed Description

Definition at line 39 of file backup.inc.

Constructor & Destructor Documentation

BackupDumper::__construct ( $ args )

Definition at line 75 of file backup.inc.

References processArgs(), registerFilter(), and registerOutput().

BackupDumper::__destruct ( )

Definition at line 298 of file backup.inc.

Member Function Documentation

BackupDumper::backupDb ( )

Todo:: Fixme: the --server parameter is currently not respected, as it doesn't seem terribly easy to ask the load balancer for a particular connection by name.

Returns:: DatabaseBase

Definition at line 271 of file backup.inc.

BackupDumper::backupServer ( )

Definition at line 304 of file backup.inc.

BackupDumper::dump	(	$	history,
		$	text = `WikiExporter::TEXT`
	)

Reimplemented in TextPassDumper.

Definition at line 197 of file backup.inc.

BackupDumper::fatalError ( $ msg )

Definition at line 364 of file backup.inc.

BackupDumper::initProgress ( $ history = WikiExporter::FULL )

Initialise starting time and maximum revision count.

We'll make ETA calculations based an progress, assuming relatively constant per-revision rate.

Parameters:

$history Integer: WikiExporter::CURRENT or WikiExporter::FULL

Reimplemented in TextPassDumper.

Definition at line 251 of file backup.inc.

BackupDumper::loadPlugin	(	$	class,
		$	file
	)

Load a plugin and register it.

Parameters:

$class	String: name of plugin class; must have a static 'register' method that takes a BackupDumper as a parameter.
$file	String: full or relative path to the PHP file to load, or empty

Definition at line 115 of file backup.inc.

BackupDumper::processArgs ( $ args )

Parameters:

$args Array

Returns:: Array

Definition at line 127 of file backup.inc.

Referenced by __construct().

BackupDumper::processOption	(	$	opt,
		$	val,
		$	param
	)

Reimplemented in TextPassDumper.

Definition at line 193 of file backup.inc.

BackupDumper::progress ( $ string )

Definition at line 360 of file backup.inc.

BackupDumper::registerFilter	(	$	name,
		$	class
	)

Parameters:

$name	String
$class	String: name of filter plugin class

Definition at line 104 of file backup.inc.

Referenced by __construct().

BackupDumper::registerOutput	(	$	name,
		$	class
	)

Parameters:

$name	String
$class	String: name of output filter plugin class

Definition at line 96 of file backup.inc.

Referenced by __construct().

BackupDumper::report ( $ final = false )

Definition at line 320 of file backup.inc.

BackupDumper::reportPage ( )

Definition at line 311 of file backup.inc.

BackupDumper::revCount ( )

Definition at line 315 of file backup.inc.

BackupDumper::setDb ( DatabaseBase $ db = null )

Force the dump to use the provided database connection for database operations, wherever possible.

Parameters:

$db	DatabaseBase\|null: (Optional) the database connection to use. If null, resort to use the globally provided ways to get database connections.

Definition at line 294 of file backup.inc.

BackupDumper::showReport ( )

Reimplemented in TextPassDumper.

Definition at line 326 of file backup.inc.

Member Data Documentation

BackupDumper::$dumpUploadFileContents = false

Definition at line 55 of file backup.inc.

BackupDumper::$dumpUploads = false

Definition at line 54 of file backup.inc.

BackupDumper::$endId = 0

Definition at line 49 of file backup.inc.

BackupDumper::$filterTypes = array()

Definition at line 61 of file backup.inc.

DatabaseBase null BackupDumper::$forcedDb = null [protected]

The dependency-injected database to use.

See also:: self::setDb

Definition at line 69 of file backup.inc.

BackupDumper::$ID = 0

Definition at line 59 of file backup.inc.

BackupDumper::$lastTime = 0

Definition at line 56 of file backup.inc.

LoadBalancer BackupDumper::$lb [protected]

Definition at line 73 of file backup.inc.

BackupDumper::$outputTypes = array()

Definition at line 61 of file backup.inc.

BackupDumper::$pageCount = 0

Definition at line 42 of file backup.inc.

BackupDumper::$pageCountLast = 0

Definition at line 57 of file backup.inc.

BackupDumper::$pages = null

Definition at line 45 of file backup.inc.

BackupDumper::$reporting = true

Definition at line 41 of file backup.inc.

BackupDumper::$reportingInterval = 100

Definition at line 40 of file backup.inc.

BackupDumper::$revCount = 0

Definition at line 43 of file backup.inc.

BackupDumper::$revCountLast = 0

Definition at line 58 of file backup.inc.

BackupDumper::$revEndId = 0

Definition at line 51 of file backup.inc.

BackupDumper::$revStartId = 0

Definition at line 50 of file backup.inc.

BackupDumper::$server = null

Definition at line 44 of file backup.inc.

BackupDumper::$sink = null

Definition at line 52 of file backup.inc.

BackupDumper::$skipFooter = false

Definition at line 47 of file backup.inc.

BackupDumper::$skipHeader = false

Definition at line 46 of file backup.inc.

BackupDumper::$startId = 0

Definition at line 48 of file backup.inc.

BackupDumper::$stubText = false

Definition at line 53 of file backup.inc.

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

maintenance/backup.inc

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation