Maintenance script that checks for articles to fix after adding/deleting namespaces. More...

Inheritance diagram for NamespaceConflictChecker:

Collaboration diagram for NamespaceConflictChecker:

[legend]

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 Attributes
DatabaseBase	$db

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()

Private Member Functions
	checkAll ( $fix, $suffix='')

	checkNamespace ( $ns, $name, $fix, $suffix='')

	checkPrefix ( $key, $prefix, $fix, $suffix='')

	getConflicts ( $ns, $name)
	Find pages in mainspace that have a prefix of the new namespace so we know titles that will need migrating. More...

	getInterwikiList ()
	Get the interwiki list. More...

	reportConflict ( $row, $suffix)
	Report any conflicts we find. More...

	resolveConflict ( $row, $resolvable, $suffix)
	Resolve any conflicts. More...

	resolveConflictOn ( $row, $table, $prefix)
	Resolve a given conflict. 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...

Detailed Description

Maintenance script that checks for articles to fix after adding/deleting namespaces.

Definition at line 35 of file namespaceDupes.php.

Constructor & Destructor Documentation

◆ __construct()

NamespaceConflictChecker::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 41 of file namespaceDupes.php.

References Maintenance\addOption().

Member Function Documentation

◆ checkAll()

NamespaceConflictChecker::checkAll	(	$fix,
		$suffix = `''`
	)

private

Todo:: Document

Parameters

$fix	Boolean: whether or not to fix broken entries
$suffix	String: suffix to append to renamed articles

Returns: bool

Definition at line 79 of file namespaceDupes.php.

References $name, $ok, $wgContLang, $wgNamespaceAliases, array(), as, checkNamespace(), MWNamespace\getCanonicalNamespaces(), getInterwikiList(), and global.

Referenced by execute().

◆ checkNamespace()

NamespaceConflictChecker::checkNamespace	(	$ns,
		$name,
		$fix,
		$suffix = `''`
	)

private

Todo:: Document

Parameters

$ns	Integer: a namespace id
$name	String
$fix	Boolean: whether to fix broken entries
$suffix	String: suffix to append to renamed articles

Returns: bool

Definition at line 165 of file namespaceDupes.php.

References $count, $name, $ok, as, getConflicts(), reportConflict(), and resolveConflict().

Referenced by checkAll(), and checkPrefix().

◆ checkPrefix()

NamespaceConflictChecker::checkPrefix	(	$key,
		$prefix,
		$fix,
		$suffix = `''`
	)

private

Todo:: Do this for real

Parameters

$key
$prefix
$fix
$suffix	string

Returns: bool

Definition at line 191 of file namespaceDupes.php.

References checkNamespace(), and Maintenance\output().

Referenced by execute().

◆ execute()

NamespaceConflictChecker::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 51 of file namespaceDupes.php.

References $retval, checkAll(), checkPrefix(), DB_MASTER, Maintenance\getOption(), Maintenance\hasOption(), Maintenance\output(), and wfGetDB().

◆ getConflicts()

NamespaceConflictChecker::getConflicts	(	$ns,
		$name
	)

private

Find pages in mainspace that have a prefix of the new namespace so we know titles that will need migrating.

Parameters

$ns	Integer: namespace id (id for new namespace?)
$name	String: prefix that is being made a namespace

Returns: array

Definition at line 205 of file namespaceDupes.php.

References $name, array(), and as.

Referenced by checkNamespace().

◆ getInterwikiList()

NamespaceConflictChecker::getInterwikiList ( )

private

Get the interwiki list.

Returns: Array

Definition at line 148 of file namespaceDupes.php.

References array(), as, and Interwiki\getAllPrefixes().

Referenced by checkAll().

◆ reportConflict()

NamespaceConflictChecker::reportConflict	(	$row,
		$suffix
	)

private

Report any conflicts we find.

Returns: bool

Definition at line 241 of file namespaceDupes.php.

References Title\makeTitleSafe(), and Maintenance\output().

Referenced by checkNamespace().

◆ resolveConflict()

NamespaceConflictChecker::resolveConflict	(	$row,
		$resolvable,
		$suffix
	)

private

Resolve any conflicts.

Parameters

$row	Object: row from the page table to fix
$resolvable	Boolean
$suffix	String: suffix to append to the fixed page

Returns: bool

Definition at line 279 of file namespaceDupes.php.

References $title, Title\makeTitleSafe(), Maintenance\output(), and resolveConflictOn().

Referenced by checkNamespace().

◆ resolveConflictOn()

NamespaceConflictChecker::resolveConflictOn	(	$row,
		$table,
		$prefix
	)

private

Resolve a given conflict.

Parameters

$row	Object: row from the old broken entry
$table	String: table to update
$prefix	String: prefix for column name, like page or ar

Returns: bool

Definition at line 311 of file namespaceDupes.php.

References array(), Title\makeTitleSafe(), and Maintenance\output().

Referenced by resolveConflict().

Member Data Documentation

◆ $db

DatabaseBase NamespaceConflictChecker::$db

protected

Definition at line 39 of file namespaceDupes.php.

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

maintenance/namespaceDupes.php

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAll()

◆ checkNamespace()

◆ checkPrefix()

◆ execute()

◆ getConflicts()

◆ getInterwikiList()

◆ reportConflict()

◆ resolveConflict()

◆ resolveConflictOn()

Member Data Documentation

◆ $db