MediaWiki  1.29.1
RenameuserSQL Class Reference

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

Collaboration diagram for RenameuserSQL:

Public Member Functions

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

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. More...
 
string $new
 The new username. More...
 
string $old
 The old username. More...
 
array $tables
 The the tables => fields to be updated. More...
 
integer $uid
 The user ID. More...
 
const CONTRIB_JOB = 500
 Users with more than this number of edits will have their rename operation deferred via the job queue. More...
 
const NAME_COL = 0
 
const TIME_COL = 2
 
const UID_COL = 1
 

Protected Member Functions

 debug ( $msg)
 

Static Private Member Functions

static lockUserAndGetId ( $name)
 

Private Attributes

string $debugPrefix = ''
 A prefix to use in all debug log messages. More...
 
string $reason = ''
 Reason to be used in the log entry. More...
 
User $renamer
 User object of the user performing the rename, for logging purposes. More...
 

Detailed Description

Class which performs the actual renaming of users.

Definition at line 9 of file RenameuserSQL.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
$oldstring The old username
$newstring The new username
$uid
User$renamer
$optionsarray 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 95 of file RenameuserSQL.php.

References $new, $old, $options, $renamer, $uid, User\newFromId(), reason(), Hooks\run(), and wfQueriesMustScale().

Member Function Documentation

◆ debug()

RenameuserSQL::debug (   $msg)
protected

Definition at line 155 of file RenameuserSQL.php.

References wfDebugLog().

Referenced by rename().

◆ lockUserAndGetId()

static RenameuserSQL::lockUserAndGetId (   $name)
staticprivate
Parameters
string$nameCurrent wiki local user name
Returns
integer Returns 0 if no row was found

Definition at line 369 of file RenameuserSQL.php.

References $name, DB_MASTER, and wfGetDB().

◆ rename()

Member Data Documentation

◆ $checkIfUserExists

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

Access:\n private

Definition at line 49 of file RenameuserSQL.php.

◆ $debugPrefix

string RenameuserSQL::$debugPrefix = ''
private

A prefix to use in all debug log messages.

Definition at line 70 of file RenameuserSQL.php.

◆ $new

string RenameuserSQL::$new

The new username.

Access:\n private

Definition at line 24 of file RenameuserSQL.php.

Referenced by __construct(), and rename().

◆ $old

string RenameuserSQL::$old

The old username.

Access:\n private

Definition at line 16 of file RenameuserSQL.php.

Referenced by __construct(), and rename().

◆ $reason

string RenameuserSQL::$reason = ''
private

Reason to be used in the log entry.

Definition at line 63 of file RenameuserSQL.php.

◆ $renamer

User RenameuserSQL::$renamer
private

User object of the user performing the rename, for logging purposes.

Definition at line 56 of file RenameuserSQL.php.

Referenced by __construct().

◆ $tables

array RenameuserSQL::$tables

The the tables => fields to be updated.

Access:\n private

Definition at line 40 of file RenameuserSQL.php.

◆ $uid

integer RenameuserSQL::$uid

The user ID.

Access:\n private

Definition at line 32 of file RenameuserSQL.php.

Referenced by __construct(), and rename().

◆ CONTRIB_JOB

const RenameuserSQL::CONTRIB_JOB = 500

Users with more than this number of edits will have their rename operation deferred via the job queue.

Definition at line 76 of file RenameuserSQL.php.

◆ NAME_COL

const RenameuserSQL::NAME_COL = 0

Definition at line 79 of file RenameuserSQL.php.

Referenced by rename().

◆ TIME_COL

const RenameuserSQL::TIME_COL = 2

Definition at line 81 of file RenameuserSQL.php.

Referenced by rename().

◆ UID_COL

const RenameuserSQL::UID_COL = 1

Definition at line 80 of file RenameuserSQL.php.

Referenced by rename().


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