UserCache Class Reference

Public Member Functions
	__construct (LoggerInterface $logger, IConnectionProvider $dbProvider, LinkBatchFactory $linkBatchFactory)
	Uses dependency injection since 1.36. More...
	doQuery (array $userIds, $options=[], $caller='')
	Preloads user names for given list of users. More...
	getProp ( $userId, $prop)
	Get a property of a user based on their user ID. More...
	getUserName ( $userId, $ip)
	Get the name of a user or return $ip if the user ID is 0. More...

Static Public Member Functions
static	singleton ()

Protected Member Functions
	queryNeeded ( $uid, $type, array $options)
	Check if a cache type is in $options and was not loaded for this user. More...

Protected Attributes
	$cache = []
	$typesCached = []

Detailed Description

Since

1.20

Definition at line 32 of file UserCache.php.

Constructor & Destructor Documentation

__construct()

UserCache::__construct	(	LoggerInterface	$logger,
		IConnectionProvider	$dbProvider,
		LinkBatchFactory	$linkBatchFactory
	)

Uses dependency injection since 1.36.

Parameters

LoggerInterface	$logger
IConnectionProvider	$dbProvider
LinkBatchFactory	$linkBatchFactory

Definition at line 59 of file UserCache.php.

Member Function Documentation

doQuery()

UserCache::doQuery	(	array	$userIds,
			$options = [],
			$caller = ''
	)

Preloads user names for given list of users.

Parameters

array	$userIds	List of user IDs
array	$options	Option flags; include 'userpage' and 'usertalk'
string	$caller	The calling method

Definition at line 109 of file UserCache.php.

References NS_USER, NS_USER_TALK, and queryNeeded().

Referenced by getProp().

getProp()

UserCache::getProp	(		$userId,
			$prop
	)

Get a property of a user based on their user ID.

Parameters

int	$userId
string	$prop	User property

Returns

mixed|false The property or false if the user does not exist

Definition at line 76 of file UserCache.php.

References doQuery().

Referenced by getUserName().

getUserName()

UserCache::getUserName	(		$userId,
			$ip
	)

Get the name of a user or return $ip if the user ID is 0.

Parameters

int	$userId
string	$ip

Returns

string

Since

1.22

Definition at line 99 of file UserCache.php.

References getProp().

queryNeeded()

UserCache::queryNeeded (   $uid,   $type, array  $options  )

protected

Check if a cache type is in $options and was not loaded for this user.

Parameters

int	$uid	User ID
string	$type	Cache type
array	$options	Requested cache types

Returns

bool

Definition at line 174 of file UserCache.php.

Referenced by doQuery().

singleton()

static UserCache::singleton ( )

static

Returns

UserCache

Definition at line 48 of file UserCache.php.

Referenced by MediaWiki\User\User\whoIs(), and MediaWiki\User\User\whoIsReal().

Member Data Documentation

$cache

UserCache::$cache = []

protected

Definition at line 33 of file UserCache.php.

$typesCached

UserCache::$typesCached = []

protected

Definition at line 34 of file UserCache.php.

---

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

• includes/cache/UserCache.php