MediaWiki
master
|
Public Member Functions | |
__construct (ILoadBalancer $loadBalancer, UserNameUtils $userNameUtils, LoggerInterface $logger, $wikiId=WikiAwareEntity::LOCAL) | |
acquireActorId (UserIdentity $user, IDatabase $dbw) | |
Attempt to assign an actor ID to the given $user. More... | |
acquireSystemActorId (UserIdentity $user, IDatabase $dbw) | |
Attempt to assign an ID to an actor for a system user. More... | |
createNewActor (UserIdentity $user, IDatabase $dbw) | |
Create a new actor for the given $user. More... | |
deleteActor (UserIdentity $actor, IDatabase $dbw) | |
Delete the actor from the actor table. More... | |
deleteUserIdentityFromCache (UserIdentity $actor) | |
findActorId (UserIdentity $user, IReadableDatabase $db) | |
Find the actor_id of the given $user. More... | |
findActorIdByName ( $name, IDatabase $db) | |
Find the actor_id of the given $name. More... | |
getActorById (int $actorId, IDatabase $db) | |
Find an actor by $id. More... | |
getUnknownActor () | |
In case all reasonable attempts of initializing a proper actor from the database have failed, entities can be attributed to special 'Unknown user' actor. More... | |
getUserIdentityByName (string $name, int $queryFlags=self::READ_NORMAL) | |
Find an actor by $name. More... | |
getUserIdentityByUserId (int $userId, int $queryFlags=self::READ_NORMAL) | |
Find an actor by $userId. More... | |
newActorFromRow (stdClass $row) | |
Instantiate a new UserIdentity object based on a $row from the actor table. More... | |
newActorFromRowFields ( $userId, $name, $actorId) | |
Instantiate a new UserIdentity object based on field values from a DB row. More... | |
newSelectQueryBuilder ( $dbOrQueryFlags=self::READ_NORMAL) | |
Returns a specialized SelectQueryBuilder for querying the UserIdentity objects. More... | |
normalizeUserName (string $name) | |
Returns a canonical form of user name suitable for storage. More... | |
![]() | |
findActorIdByName (string $name, IDatabase $db) | |
Find the actor_id for the given name. More... | |
Public Attributes | |
const | UNKNOWN_USER_NAME = 'Unknown user' |
![]() | |
const | READ_NONE = -1 |
Constants for object loading bitfield flags (higher => higher QoS) More... | |
Definition at line 44 of file ActorStore.php.
MediaWiki\User\ActorStore::__construct | ( | ILoadBalancer | $loadBalancer, |
UserNameUtils | $userNameUtils, | ||
LoggerInterface | $logger, | ||
$wikiId = WikiAwareEntity::LOCAL |
|||
) |
ILoadBalancer | $loadBalancer | |
UserNameUtils | $userNameUtils | |
LoggerInterface | $logger | |
string | false | $wikiId |
Definition at line 71 of file ActorStore.php.
MediaWiki\User\ActorStore::acquireActorId | ( | UserIdentity | $user, |
IDatabase | $dbw | ||
) |
Attempt to assign an actor ID to the given $user.
If it is already assigned, return the existing ID.
UserIdentity | $user | |
IDatabase | $dbw | The database connection to acquire the ID from. The database must correspond to ActorStore's wiki ID. |
CannotCreateActorException | if no actor ID has been assigned to this $user |
Implements MediaWiki\User\ActorNormalization.
Definition at line 399 of file ActorStore.php.
MediaWiki\User\ActorStore::acquireSystemActorId | ( | UserIdentity | $user, |
IDatabase | $dbw | ||
) |
Attempt to assign an ID to an actor for a system user.
If an actor ID already exists, return it.
UserIdentity | $user | |
IDatabase | $dbw |
CannotCreateActorException | if the existing actor is associated with registered user. |
Definition at line 503 of file ActorStore.php.
MediaWiki\User\ActorStore::createNewActor | ( | UserIdentity | $user, |
IDatabase | $dbw | ||
) |
Create a new actor for the given $user.
If an actor with this name already exists, this method throws.
UserIdentity | $user | |
IDatabase | $dbw |
CannotCreateActorException | if an actor with this name already exist. |
Definition at line 459 of file ActorStore.php.
MediaWiki\User\ActorStore::deleteActor | ( | UserIdentity | $actor, |
IDatabase | $dbw | ||
) |
Delete the actor from the actor table.
UserIdentity | $actor | |
IDatabase | $dbw |
Definition at line 562 of file ActorStore.php.
MediaWiki\User\ActorStore::deleteUserIdentityFromCache | ( | UserIdentity | $actor | ) |
UserIdentity | $actor |
Definition at line 188 of file ActorStore.php.
MediaWiki\User\ActorStore::findActorId | ( | UserIdentity | $user, |
IReadableDatabase | $db | ||
) |
Find the actor_id of the given $user.
UserIdentity | $user | |
IReadableDatabase | $db | The database connection to operate on. The database must correspond to ActorStore's wiki ID. |
Implements MediaWiki\User\ActorNormalization.
Definition at line 299 of file ActorStore.php.
MediaWiki\User\ActorStore::findActorIdByName | ( | $name, | |
IDatabase | $db | ||
) |
Find the actor_id of the given $name.
string | $name | |
IDatabase | $db | The database connection to operate on. The database must correspond to ActorStore's wiki ID. |
Definition at line 335 of file ActorStore.php.
MediaWiki\User\ActorStore::getActorById | ( | int | $actorId, |
IDatabase | $db | ||
) |
Find an actor by $id.
int | $actorId | |
IDatabase | $db | The database connection to operate on. The database must correspond to ActorStore's wiki ID. |
Implements MediaWiki\User\ActorNormalization.
Definition at line 200 of file ActorStore.php.
MediaWiki\User\ActorStore::getUnknownActor | ( | ) |
In case all reasonable attempts of initializing a proper actor from the database have failed, entities can be attributed to special 'Unknown user' actor.
Implements MediaWiki\User\ActorNormalization.
Definition at line 697 of file ActorStore.php.
MediaWiki\User\ActorStore::getUserIdentityByName | ( | string | $name, |
int | $queryFlags = self::READ_NORMAL |
||
) |
Find an actor by $name.
string | $name | |
int | $queryFlags | one of IDBAccessObject constants |
Implements MediaWiki\User\UserIdentityLookup.
Definition at line 228 of file ActorStore.php.
MediaWiki\User\ActorStore::getUserIdentityByUserId | ( | int | $userId, |
int | $queryFlags = self::READ_NORMAL |
||
) |
Find an actor by $userId.
int | $userId | |
int | $queryFlags | one of IDBAccessObject constants |
Implements MediaWiki\User\UserIdentityLookup.
Definition at line 248 of file ActorStore.php.
MediaWiki\User\ActorStore::newActorFromRow | ( | stdClass | $row | ) |
Instantiate a new UserIdentity object based on a $row from the actor table.
Use this method when an actor row was already fetched from the DB via a join. This method just constructs a new instance and does not try fetching missing values from the DB again, use UserIdentityLookup for that.
stdClass | $row | with the following fields:
|
InvalidArgumentException |
Implements MediaWiki\User\ActorNormalization.
Definition at line 101 of file ActorStore.php.
MediaWiki\User\ActorStore::newActorFromRowFields | ( | $userId, | |
$name, | |||
$actorId | |||
) |
Instantiate a new UserIdentity object based on field values from a DB row.
Until ActorMigration is completed, the actor table joins alias actor field names to legacy field names. This method is convenience to construct the UserIdentity based on legacy field names. It's more relaxed with typing then ::newFromRow to better support legacy code, so always prefer ::newFromRow in new code. Eventually, once ActorMigration is completed and all queries use explicit join with actor table, this method will be deprecated and removed.
InvalidArgumentException |
int | null | $userId | |
string | null | $name | |
int | null | $actorId |
Implements MediaWiki\User\ActorNormalization.
Definition at line 144 of file ActorStore.php.
MediaWiki\User\ActorStore::newSelectQueryBuilder | ( | $dbOrQueryFlags = self::READ_NORMAL | ) |
Returns a specialized SelectQueryBuilder for querying the UserIdentity objects.
IDatabase | int | $dbOrQueryFlags | The database connection to perform the query on, or one of self::READ_* constants. |
Implements MediaWiki\User\UserIdentityLookup.
Definition at line 716 of file ActorStore.php.
MediaWiki\User\ActorStore::normalizeUserName | ( | string | $name | ) |
Returns a canonical form of user name suitable for storage.
string | $name |
Definition at line 592 of file ActorStore.php.
const MediaWiki\User\ActorStore::UNKNOWN_USER_NAME = 'Unknown user' |
Definition at line 46 of file ActorStore.php.