Maintenance script that reassigns edits from a user or IP address to another user. More...

Inheritance diagram for ReassignEdits:

Collaboration diagram for ReassignEdits:

[legend]

Public Member Functions
	__construct ()
	Default constructor.

	execute ()
	Do the actual work.

Public Member Functions inherited from Maintenance
function	__construct ()

	checkRequiredExtensions ()
	Verify that the required extensions are installed.

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

function	execute ()

	finalSetup ()
	Handle some last-minute setup here.

	getConfig ()

	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

	getName ()
	Get the script's name.

	globals ()
	Potentially debug globals.

	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.

	loadSettings ()
	Generic setup for most installs.

	loadWithArgv ( $argv)
	Load params and arguments from a given array of command-line arguments.

	memoryLimit ()
	Normally we disable the memory_limit when running admin scripts.

	outputChanneled ( $msg, $channel=null)
	Message outputter with channeled message support.

	purgeRedundantText ( $delete=true)
	Support function for cleaning up redundant text records.

	runChild ( $maintClass, $classFile=null)
	Run a child maintenance script.

	setAgentAndTriggers ()
	Set triggers like when to try to run deferred updates.

	setConfig (Config $config)

	setDB (IDatabase $db)
	Sets database object to be returned by getDB().

	setup ()
	Do some sanity checking and basic setup.

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking.

	updateSearchIndexForPage ( $dbw, $pageId)
	Update the searchindex table for a given pageid.

Private Member Functions
	doReassignEdits (&$from, &$to, $rc=false, $report=false)
	Reassign edits from one user to another.

	initialiseUser ( $username)
	Initialise the user object.

	userConditions (&$user, $idfield, $utfield)
	Return the most efficient set of user conditions i.e.

	userSpecification (&$user, $idfield, $utfield)
	Return user specifications i.e.

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

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.

static	readconsole ( $prompt='> ')
	Prompt the console for input.

static	requireTestsAutoloader ()
	Call this to set up the autoloader to allow classes to be used from the tests directory.

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)

Public Attributes inherited from Maintenance
resource	$fileHandle
	Used when creating separate schema files.

array	$orderedOptions = []
	Used to read the options in the order they were passed.

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type.

const	DB_STD = 1

const	STDIN_ALL = 'all'

Protected Member Functions inherited from Maintenance
	activateProfiler ()
	Activate the profiler (assuming $wgProfiler is set)

	addArg ( $arg, $description, $required=true)
	Add some args that are needed.

	addDefaultParams ()
	Add the default parameters to the scripts.

	addDescription ( $text)
	Set the description text.

	addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
	Add a parameter to the script.

	adjustMemoryLimit ()
	Adjusts PHP's memory limit to better suit our needs, if needed.

	afterFinalSetup ()
	Execute a callback function at the end of initialisation.

	beginTransaction (IDatabase $dbw, $fname)
	Begin a transcation on a DB.

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transcation on a DB handle and wait for replica DBs to catch up.

	deleteOption ( $name)
	Remove an option.

	error ( $err, $die=0)
	Throw an error to the user.

	getArg ( $argId=0, $default=null)
	Get an argument.

	getDB ( $db, $groups=[], $wiki=false)
	Returns a database to be used by current maintenance script.

	getDir ()
	Get the maintenance directory.

	getOption ( $name, $default=null)
	Get an option, or return the default.

	getStdin ( $len=null)
	Return input from stdin.

	hasArg ( $argId=0)
	Does a given argument exist?

	hasOption ( $name)
	Checks to see if a particular param exists.

	loadSpecialVars ()
	Handle the special variables that are global to all scripts.

	maybeHelp ( $force=false)
	Maybe show the help.

	output ( $out, $channel=null)
	Throw some output to the user.

	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run.

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transcation on a DB handle.

	setBatchSize ( $s=0)
	Set the batch size.

	validateParamsAndArgs ()
	Run some validation checks on the params, etc.

Protected Attributes inherited from Maintenance
	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

	$mParams = []

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Detailed Description

Maintenance script that reassigns edits from a user or IP address to another user.

Definition at line 34 of file reassignEdits.php.

Constructor & Destructor Documentation

◆ __construct()

ReassignEdits::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 35 of file reassignEdits.php.

References Maintenance\addArg(), Maintenance\addDescription(), and Maintenance\addOption().

Member Function Documentation

◆ doReassignEdits()

ReassignEdits::doReassignEdits	(	&	$from,
		&	$to,
			$rc = false,
			$report = false )

private

Reassign edits from one user to another.

Parameters

User	$from	User to take edits from
User	$to	User to assign edits to
bool	$rc	Update the recent changes table
bool	$report	Don't change things; just echo numbers

Returns: int Number of entries changed, or that would be changed

Definition at line 76 of file reassignEdits.php.

References $res, Maintenance\beginTransaction(), Maintenance\commitTransaction(), DB_MASTER, Maintenance\getDB(), output(), userConditions(), and userSpecification().

Referenced by execute().

◆ execute()

ReassignEdits::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 45 of file reassignEdits.php.

References doReassignEdits(), error, Maintenance\getArg(), Maintenance\hasArg(), Maintenance\hasOption(), initialiseUser(), and output().

◆ initialiseUser()

ReassignEdits::initialiseUser ( $username )

private

Initialise the user object.

Parameters

string $username Username or IP address

Returns: User

Definition at line 181 of file reassignEdits.php.

References $user, $username, and error.

Referenced by execute().

◆ userConditions()

ReassignEdits::userConditions	(	&	$user,
			$idfield,
			$utfield )

private

Return the most efficient set of user conditions i.e.

a user => id mapping, or a user_text => text mapping

Parameters

User	$user	User for the condition
string	$idfield	Field name containing the identifier
string	$utfield	Field name containing the user text

Returns: array

Definition at line 156 of file reassignEdits.php.

Referenced by doReassignEdits().

◆ userSpecification()

ReassignEdits::userSpecification	(	&	$user,
			$idfield,
			$utfield )

private

Return user specifications i.e.

user => id, user_text => text

Parameters

User	$user	User for the spec
string	$idfield	Field name containing the identifier
string	$utfield	Field name containing the user text

Returns: array

Definition at line 171 of file reassignEdits.php.

Referenced by doReassignEdits().

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

maintenance/reassignEdits.php

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doReassignEdits()

◆ execute()

◆ initialiseUser()

◆ userConditions()

◆ userSpecification()