MediaWiki  REL1_20
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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.

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 42 of file UserCache.php.

Member Function Documentation

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

Preloads user names for given list of users.

Parameters:
$userIdsArray List of user IDs
$optionsArray Option flags; include 'userpage' and 'usertalk'
$callerString: the calling method

Definition at line 67 of file UserCache.php.

References $comment, $dbr, $lb, $options, $res, queryNeeded(), wfGetDB(), wfProfileIn(), and wfProfileOut().

Referenced by getProp().

UserCache::getProp ( $  userId,
$  prop 
)

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

Parameters:
$userIdinteger User ID
$propstring User property
Returns:
mixed The property or false if the user does not exist

Definition at line 51 of file UserCache.php.

References doQuery(), and wfDebug().

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

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

Parameters:
$uidinteger user ID
$typestring Cache type
$optionsArray Requested cache types
Returns:
bool

Definition at line 131 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().

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: