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. More... | |
| newAnonymous (?string $ip=null) | |
| Returns a new anonymous User based on ip. More... | |
| newFromActorId (int $actorId) | |
| Factory method for creation from a given actor ID, replacing User::newFromActorId. More... | |
| 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. More... | |
| newFromAuthority (Authority $authority) | |
| newFromConfirmationCode (string $confirmationCode, int $flags=self::READ_NORMAL) | |
| Factory method to fetch the user for a given email confirmation code, replacing User::newFromConfirmationCode. More... | |
| newFromId (int $id) | |
| Factory method for creation from a given user ID, replacing User::newFromId. More... | |
| newFromName (string $name, string $validate=self::RIGOR_VALID) | |
| Factory method for creating users by name, replacing static User::newFromName. More... | |
| newFromRow ( $row, $data=null) | |
| newFromUserIdentity (UserIdentity $userIdentity) | |
| Factory method for creation fom a given UserIdentity, replacing User::newFromIdentity. More... | |
| newTempPlaceholder () | |
| Create a placeholder user for an anonymous user who will be upgraded to a temporary user. More... | |
| newUnsavedTempUser (string $name) | |
| Create an unsaved temporary user with a previously acquired name. More... | |
Public Attributes | |
| const | CONSTRUCTOR_OPTIONS |
| RIGOR_* constants are inherited from UserRigorOptions READ_* constants are inherited from IDBAccessObject. More... | |
 Public Attributes inherited from IDBAccessObject | |
| const | READ_NONE = -1 |
| Constants for object loading bitfield flags (higher => higher QoS) More... | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\User\UserFactory::__construct | ( | ServiceOptions | $options, |
| ILBFactory | $loadBalancerFactory, | ||
| UserNameUtils | $userNameUtils | ||
| ) |
- Parameters
-
ServiceOptions $options ILBFactory $loadBalancerFactory UserNameUtils $userNameUtils
Definition at line 75 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 369 of file UserFactory.php.
References DB_PRIMARY, MediaWiki\User\UserIdentity\getId(), MediaWiki\DAO\WikiAwareEntity\getWikiId(), MediaWiki\User\UserIdentity\isRegistered(), and User\purge().
◆ 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 130 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 167 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 226 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 330 of file UserFactory.php.
◆ newFromConfirmationCode()
| MediaWiki\User\UserFactory::newFromConfirmationCode | ( | string | $confirmationCode, |
| int | $flags = self::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 286 of file UserFactory.php.
References DBAccessObjectUtils\getDBOptions().
◆ 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 151 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.
- 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 105 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 321 of file UserFactory.php.
References User\newFromRow().
◆ newFromUserIdentity()
| MediaWiki\User\UserFactory::newFromUserIdentity | ( | UserIdentity | $userIdentity | ) |
Factory method for creation fom a given UserIdentity, replacing User::newFromIdentity.
- Since
- 1.35
- Parameters
-
UserIdentity $userIdentity
- Returns
- User
Definition at line 183 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 345 of file UserFactory.php.
◆ newUnsavedTempUser()
| MediaWiki\User\UserFactory::newUnsavedTempUser | ( | string | $name | ) |
Create an unsaved temporary user with a previously acquired name.
- Since
- 1.39
- Parameters
-
string $name
- Returns
- User
Definition at line 358 of file UserFactory.php.
Member Data Documentation
◆ CONSTRUCTOR_OPTIONS
| const MediaWiki\User\UserFactory::CONSTRUCTOR_OPTIONS |
RIGOR_* constants are inherited from UserRigorOptions READ_* constants are inherited from IDBAccessObject.
- Access: internal
Definition at line 50 of file UserFactory.php.
The documentation for this class was generated from the following file:
- includes/user/UserFactory.php
