MediaWiki\Cache\UserCache Class Reference

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

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.

Protected Attributes
array	$cache = []
	(uid => property => value)
array	$typesCached = []
	(uid => cache type => 1)

Detailed Description

Since

1.20

Deprecated

since 1.43, use ActorStore

Definition at line 20 of file UserCache.php.

Constructor & Destructor Documentation

__construct()

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

Uses dependency injection since 1.36.

Parameters

LoggerInterface	$logger
IConnectionProvider	$dbProvider
LinkBatchFactory	$linkBatchFactory

Definition at line 51 of file UserCache.php.

Member Function Documentation

doQuery()

MediaWiki\Cache\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 101 of file UserCache.php.

References NS_USER, NS_USER_TALK, and MediaWiki\Cache\UserCache\queryNeeded().

Referenced by MediaWiki\Cache\UserCache\getProp().

getProp()

MediaWiki\Cache\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 68 of file UserCache.php.

References MediaWiki\Cache\UserCache\doQuery().

Referenced by MediaWiki\Cache\UserCache\getUserName().

getUserName()

MediaWiki\Cache\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 91 of file UserCache.php.

References MediaWiki\Cache\UserCache\getProp().

queryNeeded()

MediaWiki\Cache\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 167 of file UserCache.php.

Referenced by MediaWiki\Cache\UserCache\doQuery().

singleton()

static MediaWiki\Cache\UserCache::singleton ( )

static

Deprecated

since 1.43, use MediaWikiServices::getInstance()->getUserCache()

Returns

UserCache

Definition at line 39 of file UserCache.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

Member Data Documentation

$cache

array MediaWiki\Cache\UserCache::$cache = []

protected

(uid => property => value)

Definition at line 22 of file UserCache.php.

$typesCached

array MediaWiki\Cache\UserCache::$typesCached = []

protected

(uid => cache type => 1)

Definition at line 24 of file UserCache.php.

---

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

• includes/Cache/UserCache.php