MediaWiki master
DumpBackup Class Reference

Inherits BackupDumper.

Collaboration diagram for DumpBackup:

Public Member Functions

 __construct ( $args=null)
 execute ()
 Do the actual work.
- Public Member Functions inherited from BackupDumper
 __destruct ()
 dump ( $history, $text=WikiExporter::TEXT)
 finalSetup (SettingsBuilder $settingsBuilder)
 Handle some last-minute setup here.
 initProgress ( $history=WikiExporter::FULL)
 Initialise starting time and maximum revision count.
 loadPlugin ( $class, $file)
 Load a plugin and register it.
 registerFilter ( $name, $class)
 registerOutput ( $name, $class)
 report ( $final=false)
 reportPage ()
 revCount ()
 setDB (IMaintainableDatabase $db)
 Force the dump to use the provided database connection for database operations, wherever possible.
 showReport ()
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor.
 canExecuteWithoutLocalSettings ()
 Whether this script can run without LocalSettings.php.
 checkRequiredExtensions ()
 Verify that the required extensions are installed.
 cleanupChanneled ()
 Clean up channeled output.
 clearParamsAndArgs ()
 Clear all params and arguments.
 getConfig ()
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 getName ()
 Get the script's name.
 getParameters ()
 isQuiet ()
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments when running as a child script.
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments.
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts.
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support.
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records.
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script.
 setArg ( $argId, $value)
 Programmatically set the value of the given argument.
 setConfig (Config $config)
 setDBProvider (IConnectionProvider $dbProvider)
 setName (string $name)
 setOption (string $name, $value)
 Programmatically set the value of the given option.
 setup ()
 Provides subclasses with an opportunity to perform initial checks.
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.

Protected Member Functions

 processOptions ()
 Processes arguments and sets $this->$sink accordingly.
- Protected Member Functions inherited from BackupDumper
 backupDb ()
 backupServer ()
 progress ( $string)
- Protected Member Functions inherited from Maintenance
 addArg ( $arg, $description, $required=true, $multi=false)
 Add some args that are needed.
 addDefaultParams ()
 Add the default parameters to the scripts.
 addDescription ( $text)
 Set the description text.
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script.
 afterFinalSetup ()
 Override to perform any required operation at the end of initialisation.
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transaction on a DB.
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transaction on a DB handle and wait for replica DBs to catch up.
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.
 deleteOption ( $name)
 Remove an option.
 error ( $err, $die=0)
 Throw an error to the user.
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script.
 getArg ( $argId=0, $default=null)
 Get an argument.
 getArgs ( $offset=0)
 Get arguments.
 getBatchSize ()
 Returns batch size.
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script.
 getDir ()
 Get the maintenance directory.
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 getHookRunner ()
 Get a HookRunner for running core hooks.
 getOption ( $name, $default=null)
 Get an option, or return the default.
 getPrimaryDB ()
 getReplicaDB ()
 getServiceContainer ()
 Returns the main service container.
 getStdin ( $len=null)
 Return input from stdin.
 hasArg ( $argId=0)
 Does a given argument exist?
 hasOption ( $name)
 Checks to see if a particular option was set.
 loadSpecialVars ()
 Handle the special variables that are global to all scripts.
 maybeHelp ( $force=false)
 Maybe show the help.
 output ( $out, $channel=null)
 Throw some output to the user.
 parseIntList ( $text)
 Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run.
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transaction on a DB handle.
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.
 setBatchSize ( $s=0)
 showHelp ()
 Definitely show the help.
 supportsOption ( $name)
 Checks to see if a particular option in supported.
 validateUserOption ( $errorMsg)
 waitForReplication ()
 Wait for replica DBs to catch up.

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static getTermSize ()
 Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).
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.
static readconsole ( $prompt='> ')
 Prompt the console for input.
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory.
- Public Attributes inherited from BackupDumper
bool $dumpUploadFileContents = false
bool $dumpUploads = false
int $endId = 0
array null $limitNamespaces = []
bool $orderRevs = false
string[] null $pages = null
 null means all pages
bool $reporting = true
int $revEndId = 0
int $revStartId = 0
bool $skipFooter = false
 don't output </mediawiki>
bool $skipHeader = false
 don't output <mediawiki> and <siteinfo>
int $startId = 0
resource false $stderr
- Public Attributes inherited from Maintenance
resource null $fileHandle
 Used when creating separate schema files.
array $orderedOptions = []
 Used to read the options in the order they were passed.
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type.
const DB_STD = 1
const GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'
const SCRIPT_DEPENDENT_PARAMETERS = 'Common options'
const STDIN_ALL = -1
- Protected Attributes inherited from BackupDumper
bool $atStart
string $buffer
ExportProgressFilter $egress
string[] $filterTypes = []
IMaintainableDatabase null $forcedDb = null
 The dependency-injected database to use.
int $ID = 0
string $lastName
float $lastTime = 0
LoadBalancer $lb
int $maxCount
array false $openElement
string[] $outputTypes = []
int $pageCount = 0
int $pageCountLast = 0
int $pageCountPart
int $reportingInterval = 100
int $revCount = 0
int $revCountLast = 0
int $revCountPart
string null $schemaVersion = null
 null means use default
string null $server = null
 null means use default
DumpMultiWriter DumpOutput null $sink = null
 Output filters.
float $startTime
string $state
string null $thisRevFormat
string null $thisRevModel
float $timeOfCheckpoint
- Protected Attributes inherited from Maintenance
array $mArgs = []
 This is the list of arguments that were actually passed.
int null $mBatchSize = null
 Batch size.
string $mDbPass = null
string $mDbUser = null
string $mDescription = ''
 A description of the script, children should change this via addDescription()
bool $mInputLoaded = false
 Have we already loaded our user input?
array $mOptions = []
 This is the list of options that were actually passed.
array[] $mParams = []
bool $mQuiet = false
 Special vars for params that are always used.
string null $mSelf
 Name of the script currently running.
MaintenanceParameters $parameters

Detailed Description

Definition at line 31 of file dumpBackup.php.

Constructor & Destructor Documentation

◆ __construct()

DumpBackup::__construct ( $args = null)
array | null$argsFor backward compatibility

Reimplemented from BackupDumper.

Definition at line 32 of file dumpBackup.php.

References Maintenance\addDescription(), Maintenance\addOption(), BackupDumper\dump(), Maintenance\loadWithArgv(), Maintenance\output(), processOptions(), and BackupDumper\progress().

Member Function Documentation

◆ execute()

DumpBackup::execute ( )

Do the actual work.

All child classes will need to implement this

bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Reimplemented from Maintenance.

Definition at line 76 of file dumpBackup.php.

References BackupDumper\dump(), Maintenance\fatalError(), Maintenance\hasOption(), and processOptions().

◆ processOptions()

DumpBackup::processOptions ( )

Processes arguments and sets $this->$sink accordingly.

Reimplemented from BackupDumper.

Definition at line 96 of file dumpBackup.php.

References BackupDumper\$pages, Maintenance\fatalError(), Maintenance\getOption(), and Maintenance\hasOption().

Referenced by __construct(), and execute().

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