MediaWiki  1.28.1
BackupDumper Class Reference
Inheritance diagram for BackupDumper:
Collaboration diagram for BackupDumper:

Public Member Functions

 __construct ($args=null)
 __destruct ()
 backupDb ()
 backupServer ()
 dump ($history, $text=WikiExporter::TEXT)
 execute ()
 fatalError ($msg)
 initProgress ($history=WikiExporter::FULL)
 Initialise starting time and maximum revision count. More...
 loadPlugin ($class, $file)
 Load a plugin and register it. More...
 processOptions ()
 Processes arguments and sets $this->$sink accordingly. More...
 progress ($string)
 registerFilter ($name, $class)
 registerOutput ($name, $class)
 report ($final=false)
 reportPage ()
 revCount ()
 setDB (IDatabase $db=null)
 Force the dump to use the provided database connection for database operations, wherever possible. More...
 showReport ()
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor. More...
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 cleanupChanneled ()
 Clean up channeled output. More...
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 execute ()
 Do the actual work. More...
 finalSetup ()
 Handle some last-minute setup here. More...
 getConfig ()
 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...
 loadWithArgv ($argv)
 Load params and arguments from a given array of command-line arguments. 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...
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates. More...
 setConfig (Config $config)
 setDB (IDatabase $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...

Public Attributes

 $dumpUploadFileContents = false
 $dumpUploads = false
 $endId = 0
 $orderRevs = false
 $pages = null
 $reporting = true
 $revEndId = 0
 $revStartId = 0
 $skipFooter = false
 $skipHeader = false
 $startId = 0
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type. More...
const DB_STD = 1
const STDIN_ALL = 'all'

Protected Attributes

 $filterTypes = []
IDatabase null $forcedDb = null
 The dependency-injected database to use. More...
 $ID = 0
 $lastTime = 0
LoadBalancer $lb
 $outputTypes = []
 $pageCount = 0
 $pageCountLast = 0
 $reportingInterval = 100
 $revCount = 0
 $revCountLast = 0
 $server = null
 $sink = null
- Protected Attributes inherited from Maintenance
 $mArgList = []
 $mArgs = []
int $mBatchSize = null
 Batch size. More...
 $mDescription = ''
 $mInputLoaded = false
 $mOptions = []
 $mParams = []
 $mQuiet = false
 $mShortParamsMap = []

Private Attributes

 $stubText = false

Additional Inherited Members

- 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 requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
static setLBFactoryTriggers (LBFactory $LBFactory)
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...
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 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, $multiOccurrence=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...
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. 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=[], $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...
 requireExtension ($name)
 Indicate that the specified extension must be loaded before the script can run. More...
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 setBatchSize ($s=0)
 Set the batch size. More...
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...

Detailed Description

Definition at line 33 of file

Constructor & Destructor Documentation

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

Definition at line 78 of file

References $args, Maintenance\addOption(), Maintenance\loadWithArgv(), processOptions(), registerFilter(), and registerOutput().

BackupDumper::__destruct ( )

Definition at line 346 of file

Member Function Documentation

BackupDumper::backupDb ( )
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.

Definition at line 319 of file

References $forcedDb, DB_REPLICA, and wfGetLBFactory().

Referenced by dump().

BackupDumper::backupServer ( )

Definition at line 352 of file

References $wgDBserver, global, and server.

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

Definition at line 145 of file

BackupDumper::fatalError (   $msg)

Definition at line 420 of file

References Maintenance\error().

Referenced by DumpBackup\processOptions(), and processOptions().

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.

int$historyWikiExporter::CURRENT or WikiExporter::FULL

Definition at line 299 of file

References $dbr, $forcedDb, WikiExporter\CURRENT, DB_REPLICA, and wfGetDB().

Referenced by dump().

BackupDumper::loadPlugin (   $class,

Load a plugin and register it.

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

Definition at line 137 of file

Referenced by processOptions().

BackupDumper::processOptions ( )

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

Definition at line 152 of file

References $options, Maintenance\$orderedOptions, $sink, $type, as, fatalError(), Maintenance\getOption(), Maintenance\hasOption(), list, loadPlugin(), and server.

Referenced by __construct().

BackupDumper::registerFilter (   $name,
string$className of filter plugin class

Definition at line 126 of file

References $name.

Referenced by __construct().

BackupDumper::registerOutput (   $name,
string$className of output filter plugin class

Definition at line 118 of file

References $name.

Referenced by __construct().

BackupDumper::report (   $final = false)

Definition at line 369 of file

References revCount(), and showReport().

Referenced by TextPassDumper\dump(), dump(), and revCount().

BackupDumper::reportPage ( )

Definition at line 360 of file

BackupDumper::revCount ( )

Definition at line 364 of file

References report().

Referenced by report(), TextPassDumper\showReport(), and showReport().

BackupDumper::setDB ( IDatabase  $db = null)

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

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

Definition at line 341 of file

BackupDumper::showReport ( )

Definition at line 375 of file

References $lastTime, $pageCountLast, $revCount, $revCountLast, progress(), revCount(), TS_DB, wfTimestamp(), and wfWikiID().

Referenced by report().

Member Data Documentation

BackupDumper::$dumpUploadFileContents = false

Definition at line 43 of file

Referenced by dump().

BackupDumper::$dumpUploads = false

Definition at line 42 of file

Referenced by dump().

BackupDumper::$endId = 0

Definition at line 39 of file

BackupDumper::$filterTypes = []

Definition at line 56 of file

IDatabase null BackupDumper::$forcedDb = null

The dependency-injected database to use.

See also

Definition at line 67 of file

Referenced by backupDb(), initProgress(), and TextPassDumper\rotateDb().

BackupDumper::$ID = 0

Definition at line 58 of file

BackupDumper::$lastTime = 0

Definition at line 51 of file

Referenced by TextPassDumper\endElement(), TextPassDumper\showReport(), and showReport().

LoadBalancer BackupDumper::$lb

Definition at line 70 of file

BackupDumper::$orderRevs = false

Definition at line 44 of file

BackupDumper::$outputTypes = []

Definition at line 55 of file

BackupDumper::$pageCount = 0

Definition at line 47 of file

BackupDumper::$pageCountLast = 0

Definition at line 52 of file

Referenced by TextPassDumper\showReport(), and showReport().

BackupDumper::$pages = null

Definition at line 35 of file

Referenced by DumpBackup\processOptions().

BackupDumper::$reporting = true

Definition at line 34 of file

BackupDumper::$reportingInterval = 100

Definition at line 46 of file

BackupDumper::$revCount = 0

Definition at line 48 of file

Referenced by TextPassDumper\showReport(), and showReport().

BackupDumper::$revCountLast = 0

Definition at line 53 of file

Referenced by TextPassDumper\showReport(), and showReport().

BackupDumper::$revEndId = 0

Definition at line 41 of file

BackupDumper::$revStartId = 0

Definition at line 40 of file

BackupDumper::$server = null

Definition at line 49 of file

BackupDumper::$sink = null

Definition at line 50 of file

Referenced by processOptions().

BackupDumper::$skipFooter = false

Definition at line 37 of file

BackupDumper::$skipHeader = false

Definition at line 36 of file

BackupDumper::$startId = 0

Definition at line 38 of file

BackupDumper::$stubText = false

Definition at line 73 of file

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