MediaWiki  1.23.15
Orphans Class Reference

Maintenance script that looks for 'orphan' revisions hooked to pages which don't exist and 'childless' pages with no revisions. More...

Inheritance diagram for Orphans:
Collaboration diagram for Orphans:

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...
 

Private Member Functions

 checkOrphans ( $fix)
 Check for orphan revisions. More...
 
 checkSeparation ( $fix)
 Check for pages where page_latest is wrong. More...
 
 checkWidows ( $fix)
 
 lockTables ( $db, $extraTable=array())
 Lock the appropriate tables for the script. 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 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...
 
- 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()
 

Detailed Description

Maintenance script that looks for 'orphan' revisions hooked to pages which don't exist and 'childless' pages with no revisions.

Definition at line 39 of file orphans.php.

Constructor & Destructor Documentation

◆ __construct()

Orphans::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 40 of file orphans.php.

References Maintenance\addOption().

Member Function Documentation

◆ checkOrphans()

Orphans::checkOrphans (   $fix)
private

Check for orphan revisions.

Parameters
$fixbool Whether to fix broken revisions when found

Definition at line 73 of file orphans.php.

References $comment, $wgContLang, array(), as, DB_MASTER, global, lockTables(), Maintenance\output(), and wfGetDB().

Referenced by execute().

◆ checkSeparation()

Orphans::checkSeparation (   $fix)
private

Check for pages where page_latest is wrong.

Parameters
$fixbool Whether to fix broken entries

Definition at line 170 of file orphans.php.

References $article, $title, array(), as, DB_MASTER, WikiPage\factory(), lockTables(), Title\makeTitle(), Revision\newFromId(), Maintenance\output(), and wfGetDB().

Referenced by execute().

◆ checkWidows()

Orphans::checkWidows (   $fix)
private
Parameters
$fixbool
Todo:
DON'T USE THIS YET! It will remove entries which have children, but which aren't properly attached (eg if page_latest is bogus but valid revisions do exist)

Definition at line 125 of file orphans.php.

References array(), as, DB_MASTER, lockTables(), Maintenance\output(), and wfGetDB().

◆ execute()

Orphans::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 49 of file orphans.php.

References checkOrphans(), checkSeparation(), and Maintenance\hasOption().

◆ lockTables()

Orphans::lockTables (   $db,
  $extraTable = array() 
)
private

Lock the appropriate tables for the script.

Parameters
$dbDatabaseBase object
$extraTableString The name of any extra tables to lock (eg: text)

Definition at line 61 of file orphans.php.

References array().

Referenced by checkOrphans(), checkSeparation(), and checkWidows().


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