This class handles the logic for the actor table migration. More...

Collaboration diagram for ActorMigration:

Public Member Functions
	__construct ( $stage)

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

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

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

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

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

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

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

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

Static Public Member Functions
static	newMigration ()
	Static constructor.

Static Private Member Functions
static	getFieldNames ( $key)

Private Attributes
array null	$joinCache = null
	Cache for `self::getJoin()`

int	$stage
	One of the MIGRATION_* constants.

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

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)

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

Detailed Description

This class handles the logic for the actor table migration.

This is not intended to be a long-term part of MediaWiki; it will be deprecated and removed along with $wgActorTableSchemaMigrationStage.

Since: 1.31

Definition at line 35 of file ActorMigration.php.

Constructor & Destructor Documentation

◆ __construct()

ActorMigration::__construct ( $stage )

Access:\n private

Definition at line 81 of file ActorMigration.php.

Member Function Documentation

◆ getExistingActorId()

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

Get actor ID from UserIdentity, if it exists.

Since: 1.31.9

Parameters

IDatabase	$db
UserIdentity	$user

Returns: int|false

Definition at line 193 of file ActorMigration.php.

References 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 116 of file ActorMigration.php.

◆ 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 270 of file ActorMigration.php.

References $ret, getExistingActorId(), getNewActorId(), list, and MIGRATION_WRITE_BOTH.

◆ 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 the primary key for the main table insert and extra fields needed for the temp table.

Definition at line 306 of file ActorMigration.php.

References $ret, $t, User\getActorId(), list, MIGRATION_WRITE_BOTH, User\newFromAnyId(), 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.

Definition at line 135 of file ActorMigration.php.

References $t, $tables, list, MIGRATION_NEW, and MIGRATION_OLD.

◆ getNewActorId()

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

Attempt to assign an actor ID to the given user.

If it is already assigned, return the existing ID.

Since: 1.31.9

Parameters

IDatabase \| int	$dbw	Either a database to read from, or the query flags to use
UserIdentity	$user

Returns: int The new actor ID

Definition at line 218 of file ActorMigration.php.

References $options, User\isUsableName(), list, User\newFromName(), string, and wfGetDB().

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[]	$users	Users to test for
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'.
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 387 of file ActorMigration.php.

References $t, $tables, list, Wikimedia\Rdbms\IDatabase\makeList(), MIGRATION_NEW, and MIGRATION_OLD.

◆ 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 98 of file ActorMigration.php.

References MIGRATION_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 107 of file ActorMigration.php.

References MIGRATION_NEW.

◆ newMigration()

static ActorMigration::newMigration ( )

static

Static constructor.

Returns: ActorMigration

Definition at line 89 of file ActorMigration.php.

Member Data Documentation

◆ $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 63 of file ActorMigration.php.

◆ $joinCache

array null ActorMigration::$joinCache = null

private

Cache for self::getJoin()

Definition at line 75 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 70 of file ActorMigration.php.

◆ $stage

int ActorMigration::$stage

private

One of the MIGRATION_* constants.

Definition at line 78 of file ActorMigration.php.

◆ $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 45 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

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getExistingActorId()

◆ getFieldNames()

◆ getInsertValues()

◆ getInsertValuesWithTempTable()

◆ getJoin()

◆ getNewActorId()

◆ getWhere()

◆ isAnon()

◆ isNotAnon()

◆ newMigration()

Member Data Documentation

◆ $formerTempTables

◆ $joinCache

◆ $specialFields

◆ $stage

◆ $tempTables