DumpBackup Class Reference
Inheritance diagram for DumpBackup:
Collaboration diagram for DumpBackup:
Public Member Functions | |
| __construct ( $args=null) | |
| execute () | |
| Do the actual work. More... | |
| processOptions () | |
| Processes arguments and sets $this->$sink accordingly. More... | |
 Public Member Functions inherited from BackupDumper | |
| __destruct () | |
| backupDb () | |
| backupServer () | |
| dump ( $history, $text=WikiExporter::TEXT) | |
| fatalError ( $msg) | |
| initProgress ( $history=WikiExporter::FULL) | |
| Initialise starting time and maximum revision count. More... | |
| loadPlugin ( $class, $file) | |
| Load a plugin and register it. 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... | |
| 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) | |
| 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... | |
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). More... | |
| 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... | |
| Public Attributes inherited from BackupDumper | |
| $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... | |
| $mDbPass | |
| 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 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... | |
| Protected Attributes inherited from BackupDumper | |
| $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... | |
| $mDbUser | |
| $mDescription = '' | |
| $mInputLoaded = false | |
| $mOptions = [] | |
| $mParams = [] | |
| $mQuiet = false | |
| $mSelf | |
| $mShortParamsMap = [] | |
Detailed Description
Definition at line 30 of file dumpBackup.php.
Constructor & Destructor Documentation
◆ __construct()
| DumpBackup::__construct | ( | $args = null | ) |
- Parameters
-
array $args For backward compatibility
Reimplemented from BackupDumper.
Definition at line 31 of file dumpBackup.php.
References $args, a, Maintenance\addDescription(), Maintenance\addOption(), are, database, BackupDumper\dump(), format, captcha-old\help, https, interchange, is(), Maintenance\loadWithArgv(), not, of, or, Maintenance\output(), page, processOptions(), BackupDumper\progress(), script(), see, and wiki.
Member Function Documentation
◆ execute()
| DumpBackup::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from BackupDumper.
Definition at line 74 of file dumpBackup.php.
References WikiExporter\CURRENT, BackupDumper\dump(), Maintenance\error(), WikiExporter\FULL, Maintenance\hasOption(), WikiExporter\LOGS, processOptions(), WikiExporter\RANGE, WikiExporter\STABLE, WikiExporter\STUB, and WikiExporter\TEXT.
◆ processOptions()
| DumpBackup::processOptions | ( | ) |
Processes arguments and sets $this->$sink accordingly.
Reimplemented from BackupDumper.
Definition at line 94 of file dumpBackup.php.
References BackupDumper\$pages, BackupDumper\fatalError(), file, Maintenance\getOption(), Maintenance\hasOption(), and pages.
Referenced by __construct(), and execute().
The documentation for this class was generated from the following file:
- maintenance/dumpBackup.php
