makes parts of the API of Maintenance that is hidden by protected visibily visible for testing, and makes up for a stream closing hack in Maintenance.php. More...
Public Member Functions | |
| __construct (MediaWikiTestCase $testCase) | |
| __destruct () | |
| Safety net around register_shutdown_function of Maintenance.php. More... | |
| addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurance=false) | |
| Add a parameter to the script. More... | |
| execute () | |
| Do the actual work. More... | |
| getOption ( $name, $default=null) | |
| Get an option, or return the default. More... | |
| output ( $out, $channel=null) | |
| Throw some output to the user. More... | |
| outputChanneled ( $msg, $channel=null) | |
| Message outputter with channeled message support. More... | |
| simulateShutdown () | |
| Simulates what Maintenance wants to happen at script's end. More... | |
 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... | |
| 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... | |
Private Attributes | |
| bool | $shutdownSimulated = false |
| shutdownSimulated === true if simulateShutdown has done it's work More... | |
| MediaWikiTestCase | $testCase |
| The test case that generated this instance. 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 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... | |
| 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... | |
| 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... | |
| 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 Maintenance | |
| $mArgList = [] | |
| $mArgs = [] | |
| int | $mBatchSize = null |
| Batch size. More... | |
| $mDbUser | |
| $mDescription = '' | |
| $mInputLoaded = false | |
| $mOptions = [] | |
| $mParams = [] | |
| $mQuiet = false | |
| $mSelf | |
| $mShortParamsMap = [] | |
Detailed Description
makes parts of the API of Maintenance that is hidden by protected visibily visible for testing, and makes up for a stream closing hack in Maintenance.php.
This class is solely used for being able to test Maintenance right now without having to apply major refactorings to fix some design issues in Maintenance.php. Before adding more functions here, please consider whether this approach is correct, or a refactoring Maintenance to separate concers is more appropriate.
Upon refactoring, keep in mind that besides the maintenance scrits themselves and tests right here, also at least Extension:Maintenance make use of Maintenance.
Due to a hack in Maintenance.php using register_shutdown_function, be sure to finally call simulateShutdown on MaintenanceFixup instance before a test ends.
Definition at line 28 of file MaintenanceTest.php.
Constructor & Destructor Documentation
◆ __destruct()
| MaintenanceFixup::__destruct | ( | ) |
Safety net around register_shutdown_function of Maintenance.php.
Definition at line 88 of file MaintenanceTest.php.
References $name.
◆ __construct()
| MaintenanceFixup::__construct | ( | MediaWikiTestCase | $testCase | ) |
Definition at line 107 of file MaintenanceTest.php.
References $testCase.
Member Function Documentation
◆ addOption()
| MaintenanceFixup::addOption | ( | $name, | |
| $description, | |||
$required = false, |
|||
$withArg = false, |
|||
$shortName = false, |
|||
$multiOccurrence = false |
|||
| ) |
Add a parameter to the script.
Will be displayed on –help with the associated description
- Parameters
-
string $name The name of the param (help, version, etc) string $description The description of the param to show on –help bool $required Is the param required? bool $withArg Is an argument required with this option? string | bool $shortName Character to use as short name bool $multiOccurrence Can this option be passed multiple times?
Reimplemented from Maintenance.
Definition at line 122 of file MaintenanceTest.php.
◆ execute()
| MaintenanceFixup::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from Maintenance.
Definition at line 134 of file MaintenanceTest.php.
◆ getOption()
| MaintenanceFixup::getOption | ( | $name, | |
$default = null |
|||
| ) |
Get an option, or return the default.
If the option was added to support multiple occurrences, this will return an array.
- Parameters
-
string $name The name of the param mixed $default Anything you want, default null
- Returns
- mixed
Reimplemented from Maintenance.
Definition at line 128 of file MaintenanceTest.php.
◆ output()
| MaintenanceFixup::output | ( | $out, | |
$channel = null |
|||
| ) |
Throw some output to the user.
Scripts can call this with no fears, as we handle all –quiet stuff here
- Parameters
-
string $out The text to show to the user mixed $channel Unique identifier for the channel. See function outputChanneled.
Reimplemented from Maintenance.
Definition at line 114 of file MaintenanceTest.php.
◆ outputChanneled()
| MaintenanceFixup::outputChanneled | ( | $msg, | |
$channel = null |
|||
| ) |
Message outputter with channeled message support.
Messages on the same channel are concatenated, but any intervening messages in another channel start a new line.
- Parameters
-
string $msg The message without trailing newline string $channel Channel identifier or null for no channel. Channel comparison uses ===.
Reimplemented from Maintenance.
Definition at line 67 of file MaintenanceTest.php.
Referenced by simulateShutdown().
◆ simulateShutdown()
| MaintenanceFixup::simulateShutdown | ( | ) |
Simulates what Maintenance wants to happen at script's end.
Definition at line 54 of file MaintenanceTest.php.
References outputChanneled().
Member Data Documentation
◆ $shutdownSimulated
|
private |
shutdownSimulated === true if simulateShutdown has done it's work
Definition at line 49 of file MaintenanceTest.php.
◆ $testCase
|
private |
The test case that generated this instance.
This member is motivated by allowing the destructor to check whether or not the test failed, in order to avoid unnecessary nags about omitted shutdown simulation. But as it is already available, we also usi it to flagging tests as failed
Definition at line 42 of file MaintenanceTest.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- tests/phpunit/maintenance/MaintenanceTest.php
