MediaWiki  1.23.8
GetConfiguration Class Reference

Print serialized output of MediaWiki config vars. More...

Inheritance diagram for GetConfiguration:
Collaboration diagram for GetConfiguration:

Public Member Functions

 __construct ()
 Default constructor. More...
 execute ()
 Do the actual work. More...
 finalSetup ()
 finalSetup() since we need MWException More...
- Public Member Functions inherited from Maintenance
 cleanupChanneled ()
 Clean up channeled output. More...
 clearParamsAndArgs ()
 Clear all params and arguments. 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

 formatVarDump ( $res)
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. 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...

Protected Attributes

 $regex = null
 $settings_list = array()
- Protected Attributes inherited from Maintenance
 $mArgList = array()
 $mArgs = array()
int $mBatchSize = null
 Batch size. More...
 $mDescription = ''
 $mInputLoaded = false
 $mOptions = array()
 $mParams = array()
 $mQuiet = false
 $mShortParamsMap = array()

Static Protected Attributes

static $outFormats
 List of format output internally supported. More...

Private Member Functions

 isAllowedVariable ( $value)

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...
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type. More...
const DB_STD = 1
const STDIN_ALL = 'all'

Detailed Description

Print serialized output of MediaWiki config vars.

Definition at line 33 of file getConfiguration.php.

Constructor & Destructor Documentation

◆ __construct()

GetConfiguration::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 50 of file getConfiguration.php.

References Maintenance\addOption().

Member Function Documentation

◆ execute()

GetConfiguration::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 113 of file getConfiguration.php.

References $GLOBALS, $name, $out, $res, $value, array(), as, FormatJson\encode(), formatVarDump(), Maintenance\getOption(), and Maintenance\output().

◆ finalSetup()

GetConfiguration::finalSetup ( )

finalSetup() since we need MWException

Reimplemented from Maintenance.

Definition at line 87 of file getConfiguration.php.

References $GLOBALS, $name, as, Maintenance\getOption(), Maintenance\hasOption(), and isAllowedVariable().

◆ formatVarDump()

GetConfiguration::formatVarDump (   $res)

Definition at line 165 of file getConfiguration.php.

References $res, $ret, $value, as, and Maintenance\output().

Referenced by execute().

◆ isAllowedVariable()

GetConfiguration::isAllowedVariable (   $value)

Definition at line 178 of file getConfiguration.php.

References $value, and as.

Referenced by finalSetup().

◆ validateParamsAndArgs()

GetConfiguration::validateParamsAndArgs ( )

Run some validation checks on the params, etc.

Reimplemented from Maintenance.

Definition at line 59 of file getConfiguration.php.

References Maintenance\error(), Maintenance\getOption(), and Maintenance\maybeHelp().

Member Data Documentation

◆ $outFormats

Initial value:

List of format output internally supported.

Each item MUST be lower case.

Definition at line 43 of file getConfiguration.php.

◆ $regex

GetConfiguration::$regex = null

Definition at line 35 of file getConfiguration.php.

◆ $settings_list

GetConfiguration::$settings_list = array()

Definition at line 37 of file getConfiguration.php.

The documentation for this class was generated from the following file:
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.