MediaWiki master
MediaWiki\User\TempUser\TempUserDetailsLookup Class Reference

Caching lookup service for metadata related to temporary accounts, such as expiration. More...

Public Member Functions

 __construct (TempUserConfig $tempUserConfig, UserRegistrationLookup $userRegistrationLookup)
 
 getExpirationState ( $registration)
 Check whether a temporary account registered at the given timestamp is expired now.
 
 isExpired (UserIdentity $user)
 Check if a temporary user account is expired.
 
 preloadExpirationStatus (iterable $users)
 Preload the expiration status of temporary accounts within a set of users.
 

Detailed Description

Caching lookup service for metadata related to temporary accounts, such as expiration.

Since
1.44

Definition at line 18 of file TempUserDetailsLookup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\TempUser\TempUserDetailsLookup::__construct ( TempUserConfig $tempUserConfig,
UserRegistrationLookup $userRegistrationLookup )

Definition at line 24 of file TempUserDetailsLookup.php.

Member Function Documentation

◆ getExpirationState()

MediaWiki\User\TempUser\TempUserDetailsLookup::getExpirationState ( $registration)

Check whether a temporary account registered at the given timestamp is expired now.

Parameters
string | null | false$registrationDB timestamp of the registration time. May be null or false if not known.
Returns
bool true if the account is expired, false otherwise.

Definition at line 95 of file TempUserDetailsLookup.php.

◆ isExpired()

MediaWiki\User\TempUser\TempUserDetailsLookup::isExpired ( UserIdentity $user)

Check if a temporary user account is expired.

Parameters
UserIdentity$user
Returns
bool true if the account is expired, false otherwise.

Definition at line 41 of file TempUserDetailsLookup.php.

◆ preloadExpirationStatus()

MediaWiki\User\TempUser\TempUserDetailsLookup::preloadExpirationStatus ( iterable $users)

Preload the expiration status of temporary accounts within a set of users.

Parameters
iterable<UserIdentity>$users The users to preload the expiration status for.

Definition at line 64 of file TempUserDetailsLookup.php.


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