MediaWiki  master
ConvertExtensionToRegistration Class Reference
Inheritance diagram for ConvertExtensionToRegistration:
Collaboration diagram for ConvertExtensionToRegistration:

Public Member Functions

 __construct ()
 
 execute ()
 
 handleHooks ( $realName, $value)
 
- 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...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

Public Attributes

 $dir
 
 $hasWarning = false
 
- 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

 getAllGlobals ()
 
 handleCredits ( $realName, $value)
 
 handleExtensionFunctions ( $realName, $value)
 
 handleExtensionMessagesFiles ( $realName, $value, $vars)
 
 handleMessagesDirs ( $realName, $value)
 
 handleResourceModules ( $realName, $value)
 
 needsComposerAutoloader ( $path)
 
 removeAbsolutePath ( $realName, $value)
 
 removeAutodiscoveredParserTestFiles ( $realName, $value)
 
- 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...
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getBatchSize ()
 Returns batch size. 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 option 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...
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 

Protected Attributes

 $custom
 
string [] $formerGlobals
 Things that were formerly globals and should still be converted. More...
 
string [] $noLongerSupportedGlobals
 No longer supported globals (with reason) should not be converted and emit a warning. More...
 
string [] string [] $promote
 Keys that should be put at the top of the generated JSON file (T86608) More...
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
 $mParams = []
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Private Member Functions

 stripPath ( $val, $dir)
 

Private Attributes

 $json
 

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, Config $config)
 
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...
 

Detailed Description

Definition at line 5 of file convertExtensionToRegistration.php.

Constructor & Destructor Documentation

◆ __construct()

ConvertExtensionToRegistration::__construct ( )

Member Function Documentation

◆ execute()

◆ getAllGlobals()

ConvertExtensionToRegistration::getAllGlobals ( )
protected

Definition at line 65 of file convertExtensionToRegistration.php.

References $formerGlobals, and class.

Referenced by execute().

◆ handleCredits()

ConvertExtensionToRegistration::handleCredits (   $realName,
  $value 
)
protected

Definition at line 241 of file convertExtensionToRegistration.php.

References $keys, $name, $value, as, and json.

◆ handleExtensionFunctions()

ConvertExtensionToRegistration::handleExtensionFunctions (   $realName,
  $value 
)
protected

Definition at line 165 of file convertExtensionToRegistration.php.

References $value, as, Maintenance\fatalError(), and json.

◆ handleExtensionMessagesFiles()

ConvertExtensionToRegistration::handleExtensionMessagesFiles (   $realName,
  $value,
  $vars 
)
protected

Definition at line 191 of file convertExtensionToRegistration.php.

References $file, $value, $vars, as, json, Maintenance\output(), and stripPath().

◆ handleHooks()

ConvertExtensionToRegistration::handleHooks (   $realName,
  $value 
)

◆ handleMessagesDirs()

ConvertExtensionToRegistration::handleMessagesDirs (   $realName,
  $value 
)
protected

Definition at line 183 of file convertExtensionToRegistration.php.

References $dirs, $value, as, json, and stripPath().

◆ handleResourceModules()

ConvertExtensionToRegistration::handleResourceModules (   $realName,
  $value 
)
protected

◆ needsComposerAutoloader()

ConvertExtensionToRegistration::needsComposerAutoloader (   $path)
protected

Definition at line 313 of file convertExtensionToRegistration.php.

References $path.

Referenced by execute().

◆ removeAbsolutePath()

ConvertExtensionToRegistration::removeAbsolutePath (   $realName,
  $value 
)
protected

Definition at line 217 of file convertExtensionToRegistration.php.

References $out, $value, as, json, and stripPath().

◆ removeAutodiscoveredParserTestFiles()

ConvertExtensionToRegistration::removeAutodiscoveredParserTestFiles (   $realName,
  $value 
)
protected

Definition at line 225 of file convertExtensionToRegistration.php.

References $out, $path, $value, as, json, and stripPath().

◆ stripPath()

ConvertExtensionToRegistration::stripPath (   $val,
  $dir 
)
private

Member Data Documentation

◆ $custom

ConvertExtensionToRegistration::$custom
protected
Initial value:
= [
'MessagesDirs' => 'handleMessagesDirs'

Definition at line 7 of file convertExtensionToRegistration.php.

◆ $dir

ConvertExtensionToRegistration::$dir

Definition at line 54 of file convertExtensionToRegistration.php.

◆ $formerGlobals

string [] ConvertExtensionToRegistration::$formerGlobals
protected
Initial value:
= [
'TrackingCategories',
]

Things that were formerly globals and should still be converted.

Definition at line 24 of file convertExtensionToRegistration.php.

Referenced by getAllGlobals().

◆ $hasWarning

ConvertExtensionToRegistration::$hasWarning = false

Definition at line 54 of file convertExtensionToRegistration.php.

◆ $json

ConvertExtensionToRegistration::$json
private

Definition at line 54 of file convertExtensionToRegistration.php.

Referenced by execute().

◆ $noLongerSupportedGlobals

string [] ConvertExtensionToRegistration::$noLongerSupportedGlobals
protected
Initial value:
= [
'SpecialPageGroups' => 'deprecated'

No longer supported globals (with reason) should not be converted and emit a warning.

Definition at line 33 of file convertExtensionToRegistration.php.

◆ $promote

string [] string [] ConvertExtensionToRegistration::$promote
protected
Initial value:
= [
'name',
'namemsg',
'version',
'author',
'url',
'description',
'descriptionmsg',
'license-name',
'type',
]

Keys that should be put at the top of the generated JSON file (T86608)

Definition at line 42 of file convertExtensionToRegistration.php.


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