MediaWiki\RenameUser\RenameuserSQL Class Reference

Class which performs the actual renaming of users. More...

Public Member Functions
	__construct ( $old, $new, $uid, User $renamer, $options=[])
	Constructor.
	rename ()
	Do the rename operation.

Public Attributes
bool	$checkIfUserExists
	Flag that can be set to false, in case another process has already started the updates and the old username may have already been renamed in the user table.
string	$new
	The new username of the user being renamed.
string	$old
	The old username of the user being renamed.
array	$tables
	The [ tables => fields ] to be updated.
array[]	$tablesJob
	[ tables => fields ] to be updated in a deferred job
int	$uid
	The user ID of the user being renamed.
const	NAME_COL = 0
const	TIME_COL = 2
const	UID_COL = 1

Protected Member Functions
	debug ( $msg)

Detailed Description

Class which performs the actual renaming of users.

Definition at line 26 of file RenameuserSQL.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\RenameUser\RenameuserSQL::__construct	(		$old,
			$new,
			$uid,
		User	$renamer,
			$options = [] )

Constructor.

Parameters

string	$old	The old username
string	$new	The new username
int	$uid
User	$renamer
array	$options	Optional extra options. 'reason' - string, reason for the rename 'debugPrefix' - string, prefixed to debug messages 'checkIfUserExists' - bool, whether to update the user table

Definition at line 132 of file RenameuserSQL.php.

References MediaWiki\RenameUser\RenameuserSQL\$new, MediaWiki\RenameUser\RenameuserSQL\$old, MediaWiki\RenameUser\RenameuserSQL\$uid, MediaWiki\MainConfigNames\BlockTargetMigrationStage, MediaWiki\MediaWikiServices\getInstance(), SCHEMA_COMPAT_WRITE_MASK, and MediaWiki\MainConfigNames\UpdateRowsPerJob.

Member Function Documentation

debug()

MediaWiki\RenameUser\RenameuserSQL::debug ( $msg )

protected

Definition at line 170 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\rename().

rename()

MediaWiki\RenameUser\RenameuserSQL::rename

(

)

Do the rename operation.

Returns

bool

Definition at line 181 of file RenameuserSQL.php.

References MediaWiki\RenameUser\RenameuserSQL\$new, MediaWiki\RenameUser\RenameuserSQL\$old, $params, MediaWiki\RenameUser\RenameuserSQL\$uid, MediaWiki\RenameUser\RenameuserSQL\debug(), MediaWiki\Specials\SpecialLog\getLogTypesOnUser(), MediaWiki\RenameUser\RenameuserSQL\NAME_COL, NS_USER, RC_LOG, SCHEMA_COMPAT_WRITE_NEW, SCHEMA_COMPAT_WRITE_OLD, MediaWiki\RenameUser\RenameuserSQL\TIME_COL, and MediaWiki\RenameUser\RenameuserSQL\UID_COL.

Member Data Documentation

$checkIfUserExists

bool MediaWiki\RenameUser\RenameuserSQL::$checkIfUserExists

Flag that can be set to false, in case another process has already started the updates and the old username may have already been renamed in the user table.

Definition at line 68 of file RenameuserSQL.php.

$new

string MediaWiki\RenameUser\RenameuserSQL::$new

The new username of the user being renamed.

Definition at line 39 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\__construct(), and MediaWiki\RenameUser\RenameuserSQL\rename().

$old

string MediaWiki\RenameUser\RenameuserSQL::$old

The old username of the user being renamed.

Definition at line 32 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\__construct(), and MediaWiki\RenameUser\RenameuserSQL\rename().

$tables

array MediaWiki\RenameUser\RenameuserSQL::$tables

The [ tables => fields ] to be updated.

Definition at line 53 of file RenameuserSQL.php.

$tablesJob

array [] MediaWiki\RenameUser\RenameuserSQL::$tablesJob

[ tables => fields ] to be updated in a deferred job

Definition at line 60 of file RenameuserSQL.php.

$uid

int MediaWiki\RenameUser\RenameuserSQL::$uid

The user ID of the user being renamed.

Definition at line 46 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\__construct(), and MediaWiki\RenameUser\RenameuserSQL\rename().

NAME_COL

const MediaWiki\RenameUser\RenameuserSQL::NAME_COL = 0

Definition at line 92 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\rename().

TIME_COL

const MediaWiki\RenameUser\RenameuserSQL::TIME_COL = 2

Definition at line 94 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\rename().

UID_COL

const MediaWiki\RenameUser\RenameuserSQL::UID_COL = 1

Definition at line 93 of file RenameuserSQL.php.

Referenced by MediaWiki\RenameUser\RenameuserSQL\rename().

---

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

• includes/RenameUser/RenameuserSQL.php