This class handles the logic for the actor table migration and should always be used in lieu of directly accessing database tables. More...

Collaboration diagram for ActorMigration:

[legend]

Public Member Functions
	__construct ( $stage, UserFactory $userFactory, UserNameUtils $userNameUtils)

	getExistingActorId (IDatabase $db, UserIdentity $user)
	Get actor ID from UserIdentity, if it exists. More...

	getInsertValues (IDatabase $dbw, $key, UserIdentity $user)
	Get UPDATE fields for the actor. More...

	getInsertValuesWithTempTable (IDatabase $dbw, $key, UserIdentity $user)
	Get UPDATE fields for the actor. More...

	getJoin ( $key)
	Get SELECT fields and joins for the actor key. More...

	getNewActorId (IDatabase $dbw, UserIdentity $user)
	Attempt to assign an actor ID to the given user. More...

	getWhere (IDatabase $db, $key, $users, $useId=true)
	Get WHERE condition for the actor. More...

	isAnon ( $field)
	Return an SQL condition to test if a user field is anonymous. More...

	isNotAnon ( $field)
	Return an SQL condition to test if a user field is non-anonymous. More...

Static Public Member Functions
static	newMigration ()
	Static constructor. More...

Public Attributes
const	MIGRATION_STAGE_SCHEMA_COMPAT = 1
	Constant for extensions to feature-test whether $wgActorTableSchemaMigrationStage (in MW <1.34) expects MIGRATION_* or SCHEMA_COMPAT_*. More...

Static Private Member Functions
static	checkDeprecation ( $key)
	Issue deprecation warning/error as appropriate. More...

static	getFieldNames ( $key)

Private Attributes
array	$joinCache = []
	Cache for `self::getJoin()` More...

int	$stage
	Combination of SCHEMA_COMPAT_* constants. More...

UserFactory	$userFactory

UserNameUtils	$userNameUtils

Static Private Attributes
static string null[]	$deprecated
	Define fields that are deprecated for use with this class. More...

static array	$formerTempTables = []
	Fields that formerly used $tempTables Key is '$key', value is the MediaWiki version in which it was removed from $tempTables. More...

static string[]	$removed = []
	Define fields that are removed for use with this class. More...

static array	$specialFields
	Define fields that use non-standard mapping Keys are the user id column name, values are arrays with two elements (the user text column name and the actor id column name) More...

static array	$tempTables
	Define fields that use temporary tables for transitional purposes Keys are '$key', values are arrays with four fields: More...

Detailed Description

This class handles the logic for the actor table migration and should always be used in lieu of directly accessing database tables.

This is not intended to be a long-term part of MediaWiki; it will be deprecated and removed once actor migration is complete.

Since: 1.31; 1.34 Use with 'ar_user', 'img_user', 'oi_user', 'fa_user', 'rc_user', 'log_user', and 'ipb_by' is deprecated. Callers should reference the corresponding actor fields directly.

Definition at line 41 of file ActorMigration.php.

Constructor & Destructor Documentation

◆ __construct()

ActorMigration::__construct	(		$stage,
		UserFactory	$userFactory,
		UserNameUtils	$userNameUtils
	)

Definition at line 126 of file ActorMigration.php.

References $stage, $userFactory, $userNameUtils, SCHEMA_COMPAT_READ_BOTH, SCHEMA_COMPAT_READ_NEW, SCHEMA_COMPAT_READ_OLD, SCHEMA_COMPAT_WRITE_BOTH, SCHEMA_COMPAT_WRITE_NEW, and SCHEMA_COMPAT_WRITE_OLD.

Member Function Documentation

◆ checkDeprecation()

static ActorMigration::checkDeprecation ( $key )

staticprivate

Issue deprecation warning/error as appropriate.

Parameters

string $key

Definition at line 164 of file ActorMigration.php.

References wfDeprecated().

Referenced by getInsertValues(), getInsertValuesWithTempTable(), getJoin(), and getWhere().

◆ getExistingActorId()

ActorMigration::getExistingActorId	(	IDatabase	$db,
		UserIdentity	$user
	)

Get actor ID from UserIdentity, if it exists.

Since: 1.35.0

Parameters

IDatabase	$db
UserIdentity	$user

Returns: int|false

Definition at line 267 of file ActorMigration.php.

References MediaWiki\User\UserIdentity\getName(), and Wikimedia\Rdbms\IDatabase\selectRow().

Referenced by getInsertValues().

◆ getFieldNames()

static ActorMigration::getFieldNames ( $key )

staticprivate

Parameters

string $key A key such as "rev_user" identifying the actor field being fetched.

Returns: string[] [ $text, $actor ]

Definition at line 198 of file ActorMigration.php.

Referenced by getInsertValues(), getInsertValuesWithTempTable(), getJoin(), and getWhere().

◆ getInsertValues()

ActorMigration::getInsertValues	(	IDatabase	$dbw,
			$key,
		UserIdentity	$user
	)

Get UPDATE fields for the actor.

Parameters

IDatabase	$dbw	Database to use for creating an actor ID, if necessary
string	$key	A key such as "rev_user" identifying the actor field being fetched.
UserIdentity	$user	User to set in the update

Returns: array to merge into $values to IDatabase->update() or $a to IDatabase->insert()

Definition at line 344 of file ActorMigration.php.

References checkDeprecation(), getExistingActorId(), getFieldNames(), MediaWiki\User\UserIdentity\getId(), MediaWiki\User\UserIdentity\getName(), getNewActorId(), SCHEMA_COMPAT_WRITE_NEW, and SCHEMA_COMPAT_WRITE_OLD.

◆ getInsertValuesWithTempTable()

ActorMigration::getInsertValuesWithTempTable	(	IDatabase	$dbw,
			$key,
		UserIdentity	$user
	)

Get UPDATE fields for the actor.

Parameters

IDatabase	$dbw	Database to use for creating an actor ID, if necessary
string	$key	A key such as "rev_user" identifying the actor field being fetched.
UserIdentity	$user	User to set in the update

Returns

array with two values:

array to merge into $values to IDatabase->update() or $a to IDatabase->insert()
callback to call with the primary key for the main table insert and extra fields needed for the temp table.

Definition at line 382 of file ActorMigration.php.

References $t, checkDeprecation(), MediaWiki\User\UserIdentity\getActorId(), getFieldNames(), MediaWiki\User\UserIdentity\getId(), MediaWiki\User\UserIdentity\getName(), SCHEMA_COMPAT_WRITE_NEW, SCHEMA_COMPAT_WRITE_OLD, Wikimedia\Rdbms\IDatabase\upsert(), and wfDeprecated().

◆ getJoin()

ActorMigration::getJoin ( $key )

Get SELECT fields and joins for the actor key.

Parameters

string $key A key such as "rev_user" identifying the actor field being fetched.

Returns

array[] With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (array) to include in the $join_conds to IDatabase->select() All tables, fields, and joins are aliased, so + is safe to use. -return array{tables:string[],fields:string[],joins:array}

Definition at line 214 of file ActorMigration.php.

References $t, checkDeprecation(), getFieldNames(), and SCHEMA_COMPAT_READ_OLD.

◆ getNewActorId()

ActorMigration::getNewActorId	(	IDatabase	$dbw,
		UserIdentity	$user
	)

Attempt to assign an actor ID to the given user.

If it is already assigned, return the existing ID.

Since: 1.35.0

Parameters

IDatabase	$dbw
UserIdentity	$user

Returns: int The new actor ID

Definition at line 292 of file ActorMigration.php.

References Wikimedia\Rdbms\IDatabase\affectedRows(), MediaWiki\User\UserIdentity\getId(), MediaWiki\User\UserIdentity\getName(), Wikimedia\Rdbms\IDatabase\insert(), Wikimedia\Rdbms\IDatabase\insertId(), and Wikimedia\Rdbms\IDatabase\selectField().

Referenced by getInsertValues().

◆ getWhere()

ActorMigration::getWhere	(	IDatabase	$db,
			$key,
			$users,
			$useId = `true`
	)

Get WHERE condition for the actor.

Parameters

IDatabase	$db	Database to use for quoting and list-making
string	$key	A key such as "rev_user" identifying the actor field being fetched.
UserIdentity \| UserIdentity[] \| null \| false	$users	Users to test for. Passing null, false, or the empty array will return 'conds' that never match, and an empty array for 'orconds'.
bool	$useId	If false, don't try to query by the user ID. Intended for use with rc_user since it has an index on (rc_user_text,rc_timestamp) but not (rc_user,rc_timestamp).

Returns

array With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
conds: (string) to include in the $cond to IDatabase->select()
orconds: (array[]) array of alternatives in case a union of multiple queries would be more efficient than a query with OR. May have keys 'actor', 'userid', 'username'. Since 1.32, this is guaranteed to contain just one alternative if $users contains a single user.
joins: (array) to include in the $join_conds to IDatabase->select() All tables and joins are aliased, so + is safe to use.

Definition at line 473 of file ActorMigration.php.

References $t, checkDeprecation(), getFieldNames(), LIST_AND, LIST_OR, Wikimedia\Rdbms\IDatabase\makeList(), and SCHEMA_COMPAT_READ_NEW.

◆ isAnon()

ActorMigration::isAnon ( $field )

Return an SQL condition to test if a user field is anonymous.

Parameters

string $field Field name or SQL fragment

Returns: string

Definition at line 180 of file ActorMigration.php.

References SCHEMA_COMPAT_READ_NEW.

◆ isNotAnon()

ActorMigration::isNotAnon ( $field )

Return an SQL condition to test if a user field is non-anonymous.

Parameters

string $field Field name or SQL fragment

Returns: string

Definition at line 189 of file ActorMigration.php.

References SCHEMA_COMPAT_READ_NEW.

◆ newMigration()

static ActorMigration::newMigration ( )

static

Static constructor.

Returns: ActorMigration

Definition at line 156 of file ActorMigration.php.

Referenced by ChangesListSpecialPage\__construct(), WikiPage\archiveRevisions(), SiteStatsUpdate\cacheUpdate(), Orphans\checkOrphans(), WikiPage\commitRollback(), LocalFileDeleteBatch\doDBInserts(), DeduplicateArchiveRevId\doDBUpdates(), PopulateIpChanges\doDBUpdates(), RevDelLogList\doQuery(), ReassignEdits\doReassignEdits(), WikiExporter\dumpLogs(), ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), LocalFileRestoreBatch\execute(), DeleteDefaultMessages\execute(), FixUserRegistration\execute(), InitEditCount\execute(), ChangesListSpecialPage\filterOnUserExperienceLevel(), WikiPage\getContributors(), EditPage\getLastDelete(), MediaWiki\Block\DatabaseBlock\getQueryInfo(), RecentChange\getQueryInfo(), ArchivedFile\getQueryInfo(), ContribsPager\getQueryInfo(), DeletedContribsPager\getQueryInfo(), LocalFile\getQueryInfo(), OldLocalFile\getQueryInfo(), RollbackEdits\getRollbackTitles(), DatabaseLogEntry\getSelectQueryData(), ContribsPager\getTargetTable(), WikiRevision\importLogItem(), ManualLogEntry\insert(), RemoveUnusedAccounts\isInactiveAccount(), MediaWiki\Storage\PageEditStash\lastEditTime(), LogPager\limitPerformer(), ApiQueryUserContribs\prepareQuery(), RebuildRecentchanges\rebuildRecentChangesTablePass1(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), OldLocalFile\recordOldUpload(), LocalFile\recordUpload3(), ApiQueryAllImages\run(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), RecentChange\save(), LogPage\saveContent(), and RecentChangesUpdateJob\updateActiveUsers().

Member Data Documentation

◆ $deprecated

string null [] ActorMigration::$deprecated

staticprivate

Initial value:

= [
        'ar_user' => null, 
        'img_user' => null, 
        'oi_user' => null, 
        'fa_user' => null, 
        'rc_user' => null, 
        'log_user' => null, 
        'ipb_by' => null, 
    ]

Define fields that are deprecated for use with this class.

Keys are '$key', value is null for soft deprecation or a string naming the deprecated version for hard deprecation.

Definition at line 82 of file ActorMigration.php.

◆ $formerTempTables

array ActorMigration::$formerTempTables = []

staticprivate

Fields that formerly used $tempTables Key is '$key', value is the MediaWiki version in which it was removed from $tempTables.

Definition at line 75 of file ActorMigration.php.

◆ $joinCache

array ActorMigration::$joinCache = []

private

Cache for self::getJoin()

Definition at line 109 of file ActorMigration.php.

◆ $removed

string [] ActorMigration::$removed = []

staticprivate

Define fields that are removed for use with this class.

Keys are '$key', value is the MediaWiki version in which use was removed.

Definition at line 97 of file ActorMigration.php.

◆ $specialFields

array ActorMigration::$specialFields

staticprivate

Initial value:

= [
        'ipb_by' => [ 'ipb_by_text', 'ipb_by_actor' ],
    ]

Define fields that use non-standard mapping Keys are the user id column name, values are arrays with two elements (the user text column name and the actor id column name)

Definition at line 104 of file ActorMigration.php.

◆ $stage

int ActorMigration::$stage

private

Combination of SCHEMA_COMPAT_* constants.

Definition at line 112 of file ActorMigration.php.

Referenced by __construct().

◆ $tempTables

array ActorMigration::$tempTables

staticprivate

Initial value:

= [
        'rev_user' => [
            'table' => 'revision_actor_temp',
            'pk' => 'revactor_rev',
            'field' => 'revactor_actor',
            'joinPK' => 'rev_id',
            'extra' => [
                'revactor_timestamp' => 'rev_timestamp',
                'revactor_page' => 'rev_page',
            ],
        ],
    ]

Define fields that use temporary tables for transitional purposes Keys are '$key', values are arrays with four fields:

table: Temporary table name
pk: Temporary table column referring to the main table's primary key
field: Temporary table column referring actor.actor_id
joinPK: Main table's primary key

Definition at line 57 of file ActorMigration.php.

◆ $userFactory

UserFactory ActorMigration::$userFactory

private

Definition at line 115 of file ActorMigration.php.

Referenced by __construct().

◆ $userNameUtils

UserNameUtils ActorMigration::$userNameUtils

private

Definition at line 118 of file ActorMigration.php.

Referenced by __construct().

◆ MIGRATION_STAGE_SCHEMA_COMPAT

const ActorMigration::MIGRATION_STAGE_SCHEMA_COMPAT = 1

Constant for extensions to feature-test whether $wgActorTableSchemaMigrationStage (in MW <1.34) expects MIGRATION_* or SCHEMA_COMPAT_*.

Definition at line 47 of file ActorMigration.php.

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

includes/ActorMigration.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDeprecation()

◆ getExistingActorId()

◆ getFieldNames()

◆ getInsertValues()

◆ getInsertValuesWithTempTable()

◆ getJoin()

◆ getNewActorId()

◆ getWhere()

◆ isAnon()

◆ isNotAnon()

◆ newMigration()

Member Data Documentation

◆ $deprecated

◆ $formerTempTables

◆ $joinCache

◆ $removed

◆ $specialFields

◆ $stage

◆ $tempTables

◆ $userFactory

◆ $userNameUtils

◆ MIGRATION_STAGE_SCHEMA_COMPAT