UserCache Class Reference

List of all members.

Public Member Functions
	doQuery (array $userIds, $options=array(), $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
	__construct ()
	queryNeeded ($uid, $type, array $options)
	Check if a cache type is in $options and was not loaded for this user.
Protected Attributes
	$cache = array()
	$typesCached = array()

---

Detailed Description

Since:

1.20

Definition at line 27 of file UserCache.php.

---

Constructor & Destructor Documentation

UserCache::__construct

(

)

[protected]

Definition at line 43 of file UserCache.php.

---

Member Function Documentation

UserCache::doQuery	(	array $	userIds,
		$	options = array(),
		$	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 82 of file UserCache.php.

References $comment, $conds, $dbr, $lb, $name, $options, $res, array(), as, cache, queryNeeded(), wfGetDB(), wfProfileIn(), and wfProfileOut().

Referenced by getProp().

UserCache::getProp	(	$	userId,
		$	prop
	)

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

Parameters:

	$userId	integer User ID
string	$prop	User property

Returns:

mixed The property or false if the user does not exist

Definition at line 53 of file UserCache.php.

References array(), cache, doQuery(), and wfDebug().

Referenced by getUserName().

UserCache::getUserName	(	$	userId,
		$	ip
	)

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

Parameters:

integer	$userId
string	$ip

Returns:

string

Since:

1.22

Definition at line 72 of file UserCache.php.

References getProp().

UserCache::queryNeeded	(	$	uid,
		$	type,
		array $	options
	)		[protected]

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

Parameters:

	$uid	integer user ID
string	$type	Cache type
array	$options	Requested cache types

Returns:

bool

Definition at line 148 of file UserCache.php.

Referenced by doQuery().

static UserCache::singleton

(

)

[static]

Returns:

UserCache

Definition at line 34 of file UserCache.php.

Referenced by ImageListPager\doBatchLookups(), ProtectedPagesPager\formatValue(), and ProtectedPagesPager\preprocessResults().

---

Member Data Documentation

UserCache::$cache = array() [protected]

Definition at line 28 of file UserCache.php.

UserCache::$typesCached = array() [protected]

Definition at line 29 of file UserCache.php.

---

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

• includes/cache/UserCache.php