MediaWiki REL1_27
|
Public Member Functions | |
__construct ( $args=null) | |
execute () | |
Do the actual work. | |
processOptions () | |
Processes arguments and sets $this->$sink accordingly. | |
![]() | |
__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. | |
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. | |
showReport () | |
![]() | |
function | __construct () |
__construct () | |
Default constructor. | |
cleanupChanneled () | |
Clean up channeled output. | |
clearParamsAndArgs () | |
Clear all params and arguments. | |
function | execute () |
finalSetup () | |
Handle some last-minute setup here. | |
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. | |
globals () | |
Potentially debug globals. | |
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. | |
loadSettings () | |
Generic setup for most installs. | |
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. | |
setConfig (Config $config) | |
setup () | |
Do some sanity checking and basic setup. | |
updateSearchIndex ( $maxLockTime, $callback, $dbw, $results) | |
Perform a search index update with locking. | |
updateSearchIndexForPage ( $dbw, $pageId) | |
Update the searchindex table for a given pageid. | |
Additional Inherited Members | |
![]() | |
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 | 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) | |
![]() | |
$dumpUploadFileContents = false | |
$dumpUploads = false | |
$endId = 0 | |
$pages = null | |
$reporting = true | |
$revEndId = 0 | |
$revStartId = 0 | |
$skipFooter = false | |
$skipHeader = false | |
$startId = 0 | |
![]() | |
resource | $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 | STDIN_ALL = 'all' |
![]() | |
activateProfiler () | |
Activate the profiler (assuming $wgProfiler is set) | |
addArg ( $arg, $description, $required=true) | |
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. | |
adjustMemoryLimit () | |
Adjusts PHP's memory limit to better suit our needs, if needed. | |
afterFinalSetup () | |
Execute a callback function at the end of initialisation. | |
beginTransaction (IDatabase $dbw, $fname) | |
Begin a transcation on a DB. | |
commitTransaction (IDatabase $dbw, $fname) | |
Commit the transcation on a DB handle and wait for slaves to catch up. | |
deleteOption ( $name) | |
Remove an option. | |
error ( $err, $die=0) | |
Throw an error to the user. | |
getArg ( $argId=0, $default=null) | |
Get an argument. | |
getDB ( $db, $groups=[], $wiki=false) | |
Returns a database to be used by current maintenance script. | |
getDir () | |
Get the maintenance directory. | |
getOption ( $name, $default=null) | |
Get an option, or return the default. | |
getStdin ( $len=null) | |
Return input from stdin. | |
hasArg ( $argId=0) | |
Does a given argument exist? | |
hasOption ( $name) | |
Checks to see if a particular param exists. | |
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. | |
rollbackTransaction (IDatabase $dbw, $fname) | |
Rollback the transcation on a DB handle. | |
setBatchSize ( $s=0) | |
Set the batch size. | |
validateParamsAndArgs () | |
Run some validation checks on the params, etc. | |
![]() | |
$filterTypes = [] | |
DatabaseBase null | $forcedDb = null |
The dependency-injected database to use. | |
$ID = 0 | |
$lastTime = 0 | |
LoadBalancer | $lb |
$outputTypes = [] | |
$pageCount = 0 | |
$pageCountLast = 0 | |
$reportingInterval = 100 | |
$revCount = 0 | |
$revCountLast = 0 | |
$server = null | |
$sink = null | |
![]() | |
$mArgList = [] | |
$mArgs = [] | |
int | $mBatchSize = null |
Batch size. | |
$mDbPass | |
$mDbUser | |
$mDescription = '' | |
$mInputLoaded = false | |
$mOptions = [] | |
$mParams = [] | |
$mQuiet = false | |
$mSelf | |
$mShortParamsMap = [] | |
Definition at line 30 of file dumpBackup.php.
DumpBackup::__construct | ( | $args = null | ) |
array | $args | For backward compatibility |
Reimplemented from BackupDumper.
Definition at line 31 of file dumpBackup.php.
References $args, Maintenance\addDescription(), Maintenance\addOption(), are, database, BackupDumper\dump(), format, https, is(), Maintenance\loadWithArgv(), of, or, output(), page, processOptions(), BackupDumper\progress(), see, the, and wiki.
DumpBackup::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from BackupDumper.
Definition at line 72 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.
DumpBackup::processOptions | ( | ) |
Processes arguments and sets $this->$sink accordingly.
Reimplemented from BackupDumper.
Definition at line 92 of file dumpBackup.php.
References BackupDumper\$pages, BackupDumper\fatalError(), file, Maintenance\getOption(), Maintenance\hasOption(), and pages.
Referenced by __construct(), and execute().