MediaWiki
1.23.6
|
Class for scripts that perform database maintenance and want to log the update in updatelog
so we can later skip it.
More...
Public Member Functions | |
__construct () | |
Default constructor. More... | |
execute () | |
Do the actual work. More... | |
Public Member Functions inherited from Maintenance | |
cleanupChanneled () | |
Clean up channeled output. More... | |
clearParamsAndArgs () | |
Clear all params and arguments. More... | |
finalSetup () | |
Handle some last-minute setup here. More... | |
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... | |
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... | |
setDB (&$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... | |
Protected Member Functions | |
doDBUpdates () | |
Do the actual work. More... | |
getUpdateKey () | |
Get the update key name to go in the update log table. More... | |
updatelogFailedMessage () | |
Message to show the the update log was unable to log the completion of this update. More... | |
updateSkippedMessage () | |
Message to show that the update was done already and was just skipped. More... | |
Protected Member Functions inherited from Maintenance | |
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) | |
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... | |
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=array(), $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... | |
setBatchSize ( $s=0) | |
Set the batch size. More... | |
validateParamsAndArgs () | |
Run some validation checks on the params, etc. More... | |
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 | 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 Maintenance | |
resource | $fileHandle |
Used when creating separate schema files. More... | |
$mDbPass | |
const | DB_ADMIN = 2 |
const | DB_NONE = 0 |
Constants for DB access type. More... | |
const | DB_STD = 1 |
const | STDIN_ALL = 'all' |
Protected Attributes inherited from Maintenance | |
$mArgList = array() | |
$mArgs = array() | |
int | $mBatchSize = null |
Batch size. More... | |
$mDbUser | |
$mDescription = '' | |
$mInputLoaded = false | |
$mOptions = array() | |
$mParams = array() | |
$mQuiet = false | |
$mSelf | |
$mShortParamsMap = array() | |
Class for scripts that perform database maintenance and want to log the update in updatelog
so we can later skip it.
Definition at line 1209 of file Maintenance.php.
LoggedUpdateMaintenance::__construct | ( | ) |
Default constructor.
Children should call this first if implementing their own constructors
Reimplemented from Maintenance.
Reimplemented in PopulateLogSearch, PopulateLogUsertext, FixExtLinksProtocolRelative, PopulateParentId, PopulateRevisionLength, PopulateRevisionSha1, PopulateFilearchiveSha1, PopulateRecentChangesSource, and PopulateImageSha1.
Definition at line 1210 of file Maintenance.php.
References Maintenance\addOption(), and Maintenance\setBatchSize().
|
abstractprotected |
Do the actual work.
All child classes will need to implement this. Return true to log the update as done or false (usually on failure).
Reimplemented in PopulateImageSha1, PopulateLogSearch, PopulateLogUsertext, FixExtLinksProtocolRelative, PopulateParentId, PopulateFilearchiveSha1, PopulateRevisionLength, PopulateRevisionSha1, and PopulateRecentChangesSource.
Referenced by execute().
LoggedUpdateMaintenance::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from Maintenance.
Reimplemented in PopulateImageSha1.
Definition at line 1216 of file Maintenance.php.
References array(), DB_MASTER, doDBUpdates(), Maintenance\getDB(), getUpdateKey(), Maintenance\hasOption(), Maintenance\output(), updatelogFailedMessage(), and updateSkippedMessage().
|
abstractprotected |
Get the update key name to go in the update log table.
Reimplemented in PopulateRecentChangesSource, PopulateLogSearch, PopulateLogUsertext, PopulateImageSha1, FixExtLinksProtocolRelative, PopulateParentId, PopulateRevisionLength, PopulateRevisionSha1, and PopulateFilearchiveSha1.
Referenced by execute(), updatelogFailedMessage(), and updateSkippedMessage().
|
protected |
Message to show the the update log was unable to log the completion of this update.
Definition at line 1252 of file Maintenance.php.
References getUpdateKey().
Referenced by execute().
|
protected |
Message to show that the update was done already and was just skipped.
Reimplemented in PopulateLogSearch, PopulateLogUsertext, PopulateImageSha1, FixExtLinksProtocolRelative, PopulateParentId, and PopulateFilearchiveSha1.
Definition at line 1243 of file Maintenance.php.
References getUpdateKey().
Referenced by execute().