Create User objects. More...

Inherits MediaWiki\User\UserRigorOptions.

Collaboration diagram for MediaWiki\User\UserFactory:

Public Member Functions
	__construct (ServiceOptions $options, ILBFactory $loadBalancerFactory, UserNameUtils $userNameUtils)

	invalidateCache (UserIdentity $userIdentity)
	Purge user related caches, "touch" the user table to invalidate further caches.

	isUserTableShared ()
	Returns if the user table is shared with other wikis.

	newAnonymous (?string $ip=null)
	Returns a new anonymous User based on ip.

	newFromActorId (int $actorId)
	Factory method for creation from a given actor ID, replacing User::newFromActorId.

	newFromAnyId (?int $userId, ?string $userName, ?int $actorId=null, $dbDomain=false)
	Factory method for creation from an ID, name, and/or actor ID, replacing User::newFromAnyId.

	newFromAuthority (Authority $authority)

	newFromConfirmationCode (string $confirmationCode, int $flags=IDBAccessObject::READ_NORMAL)
	Factory method to fetch the user for a given email confirmation code, replacing User::newFromConfirmationCode.

	newFromId (int $id)
	Factory method for creation from a given user ID, replacing User::newFromId.

	newFromName (string $name, string $validate=self::RIGOR_VALID)
	Factory method for creating users by name, replacing static User::newFromName.

	newFromNameOrIp (string $name)
	Returns either an anonymous or a named User based on the supplied argument.

	newFromRow ( $row, $data=null)

	newFromUserIdentity (UserIdentity $userIdentity)
	Factory method for creation from a given UserIdentity, replacing User::newFromIdentity.

	newTempPlaceholder ()
	Create a placeholder user for an anonymous user who will be upgraded to a temporary user.

	newUnsavedTempUser (?string $name)
	Create an unsaved temporary user with a previously acquired name or a placeholder name.

Public Attributes
const	CONSTRUCTOR_OPTIONS
	RIGOR_* constants are inherited from UserRigorOptions.

Public Attributes inherited from MediaWiki\User\UserRigorOptions
const	RIGOR_CREATABLE = 'creatable'
	Check that a user name is valid for batch processes, login and account creation.

const	RIGOR_NONE = 'none'
	No validation at all.

const	RIGOR_USABLE = 'usable'
	Check that a user name is valid for batch processes and login.

const	RIGOR_VALID = 'valid'
	Check that a user name is valid for batch processes.

Detailed Description

Create User objects.

This creates User objects, and involves all the same global state, but wraps it in a service class to avoid static coupling, which eases mocking in unit tests.

Since: 1.35

Definition at line 45 of file UserFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\UserFactory::__construct	(	ServiceOptions	$options,
		ILBFactory	$loadBalancerFactory,
		UserNameUtils	$userNameUtils )

Definition at line 64 of file UserFactory.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and Wikimedia\Rdbms\ILBFactory\getMainLB().

Member Function Documentation

◆ invalidateCache()

MediaWiki\User\UserFactory::invalidateCache ( UserIdentity $userIdentity )

Purge user related caches, "touch" the user table to invalidate further caches.

Since: 1.41

Parameters

UserIdentity $userIdentity

Definition at line 386 of file UserFactory.php.

◆ isUserTableShared()

MediaWiki\User\UserFactory::isUserTableShared ( )

Returns if the user table is shared with other wikis.

Returns: bool

Definition at line 442 of file UserFactory.php.

Referenced by MediaWiki\Specials\SpecialRenameUser\__construct().

◆ newAnonymous()

MediaWiki\User\UserFactory::newAnonymous ( ?string $ip = null )

Returns a new anonymous User based on ip.

Since: 1.35

Parameters

string | null $ip IP address

Returns: User

Definition at line 120 of file UserFactory.php.

◆ newFromActorId()

MediaWiki\User\UserFactory::newFromActorId ( int $actorId )

Factory method for creation from a given actor ID, replacing User::newFromActorId.

Since: 1.35

Parameters

int $actorId

Returns: User

Definition at line 177 of file UserFactory.php.

◆ newFromAnyId()

MediaWiki\User\UserFactory::newFromAnyId	(	?int	$userId,
		?string	$userName,
		?int	$actorId = null,
			$dbDomain = false )

Factory method for creation from an ID, name, and/or actor ID, replacing User::newFromAnyId.

Note: This does not check that the ID, name, and actor ID all correspond to the same user.

Since: 1.35

Parameters

?int	$userId
?string	$userName
?int	$actorId
string \| false	$dbDomain

Returns: User

Exceptions

InvalidArgumentException if none of userId, userName, and actorId are specified

Definition at line 238 of file UserFactory.php.

◆ newFromAuthority()

MediaWiki\User\UserFactory::newFromAuthority ( Authority $authority )

Access: internal: for transition from User to Authority as performer concept.

Parameters

Authority $authority

Returns: User

Definition at line 347 of file UserFactory.php.

◆ newFromConfirmationCode()

MediaWiki\User\UserFactory::newFromConfirmationCode	(	string	$confirmationCode,
		int	$flags = IDBAccessObject::READ_NORMAL )

Factory method to fetch the user for a given email confirmation code, replacing User::newFromConfirmationCode.

This code is generated when an account is created or its e-mail address has changed. If the code is invalid or has expired, returns null.

Since: 1.35

Parameters

string	$confirmationCode
int	$flags

Returns: User|null

Definition at line 304 of file UserFactory.php.

References DB_PRIMARY.

◆ newFromId()

MediaWiki\User\UserFactory::newFromId ( int $id )

Factory method for creation from a given user ID, replacing User::newFromId.

Since: 1.35

Parameters

int $id Valid user ID

Returns: User

Definition at line 161 of file UserFactory.php.

◆ newFromName()

MediaWiki\User\UserFactory::newFromName	(	string	$name,
		string	$validate = self::RIGOR_VALID )

Factory method for creating users by name, replacing static User::newFromName.

This is slightly less efficient than newFromId(), so use newFromId() if you have both an ID and a name handy.

Note: unlike User::newFromName, this returns null instead of false for invalid usernames

Since: 1.35; 1.36 returns null instead of false for invalid user names

Parameters

string	$name	Username, validated by Title::newFromText
string	$validate	Validation strategy, one of the RIGOR_* constants. For no validation, use RIGOR_NONE. If you just want to create valid user who can be either a named user or an IP, consider using newFromNameOrIp() instead of calling this with RIGOR_NONE.

Returns: ?User User object, or null if the username is invalid (e.g. if it contains illegal characters or is an IP address). If the username is not present in the database, the result will be a user object with a name, a user id of 0, and default settings.

Definition at line 95 of file UserFactory.php.

Referenced by MediaWiki\Pager\ContributionsPager\__construct().

◆ newFromNameOrIp()

MediaWiki\User\UserFactory::newFromNameOrIp ( string $name )

Returns either an anonymous or a named User based on the supplied argument.

If IP is supplied, an anonymous user will be created, otherwise a valid named user. If you don't want to have the named user validated, use self::newFromName(). If you want to create simple anonymous user without providing the IP, use self::newAnonymous()

Since: 1.44

Parameters

string $name IP address or username

Returns: User|null

Definition at line 145 of file UserFactory.php.

◆ newFromRow()

MediaWiki\User\UserFactory::newFromRow	(		$row,
			$data = null )

See also: User::newFromRow

Since: 1.36

Parameters

stdClass	$row	A row from the user table
array \| null	$data	Further data to load into the object

Returns: User

Definition at line 338 of file UserFactory.php.

◆ newFromUserIdentity()

MediaWiki\User\UserFactory::newFromUserIdentity ( UserIdentity $userIdentity )

Factory method for creation from a given UserIdentity, replacing User::newFromIdentity.

Since: 1.35

Parameters

UserIdentity $userIdentity

Returns: User

Definition at line 193 of file UserFactory.php.

◆ newTempPlaceholder()

MediaWiki\User\UserFactory::newTempPlaceholder ( )

Create a placeholder user for an anonymous user who will be upgraded to a temporary user.

This will throw an exception if temp user autocreation is disabled.

Since: 1.39

Returns: User

Definition at line 362 of file UserFactory.php.

◆ newUnsavedTempUser()

MediaWiki\User\UserFactory::newUnsavedTempUser ( ?string $name )

Create an unsaved temporary user with a previously acquired name or a placeholder name.

Since: 1.39

Parameters

?string $name If null, a placeholder name is used

Returns: User

Definition at line 375 of file UserFactory.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\User\UserFactory::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::SharedDB,
        MainConfigNames::SharedTables,
    ]

RIGOR_* constants are inherited from UserRigorOptions.

Access: internal

Definition at line 52 of file UserFactory.php.

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

includes/user/UserFactory.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ invalidateCache()

◆ isUserTableShared()

◆ newAnonymous()

◆ newFromActorId()

◆ newFromAnyId()

◆ newFromAuthority()

◆ newFromConfirmationCode()

◆ newFromId()

◆ newFromName()

◆ newFromNameOrIp()

◆ newFromRow()

◆ newFromUserIdentity()

◆ newTempPlaceholder()

◆ newUnsavedTempUser()

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS