MediaWiki  master
GenderCache Class Reference

Caches user genders when needed to use correct namespace aliases. More...

Collaboration diagram for GenderCache:

Public Member Functions

 __construct (NamespaceInfo $nsInfo=null, ILoadBalancer $loadBalancer=null)
 
 doLinkBatch ( $data, $caller='')
 Wrapper for doQuery that processes raw LinkBatch data. More...
 
 doQuery ( $users, $caller='')
 Preloads genders for given list of users. More...
 
 doTitlesArray ( $titles, $caller='')
 Wrapper for doQuery that processes a title or string array. More...
 
 getGenderOf ( $username, $caller='')
 Returns the gender for given username. More...
 

Static Public Member Functions

static singleton ()
 

Protected Member Functions

 getDefault ()
 Returns the default gender option in this wiki. More...
 

Protected Attributes

 $cache = []
 
 $default
 
 $misses = 0
 
 $missLimit = 1000
 

Static Private Member Functions

static normalizeUsername ( $username)
 

Private Attributes

ILoadBalancer null $loadBalancer
 
NamespaceInfo $nsInfo
 

Detailed Description

Caches user genders when needed to use correct namespace aliases.

Since
1.18

Definition at line 33 of file GenderCache.php.

Constructor & Destructor Documentation

◆ __construct()

GenderCache::__construct ( NamespaceInfo  $nsInfo = null,
ILoadBalancer  $loadBalancer = null 
)

Definition at line 45 of file GenderCache.php.

References $loadBalancer.

Member Function Documentation

◆ doLinkBatch()

GenderCache::doLinkBatch (   $data,
  $caller = '' 
)

Wrapper for doQuery that processes raw LinkBatch data.

Parameters
array$data
string$caller

Definition at line 110 of file GenderCache.php.

References $username, as, and doQuery().

◆ doQuery()

GenderCache::doQuery (   $users,
  $caller = '' 
)

Preloads genders for given list of users.

Parameters
array | string$usersUsernames
string$callerThe calling method

Definition at line 152 of file GenderCache.php.

References $dbr, $default, $name, $res, $value, as, cache, DB_REPLICA, getDefault(), User\isValidUserName(), and null.

Referenced by doLinkBatch(), doTitlesArray(), and getGenderOf().

◆ doTitlesArray()

GenderCache::doTitlesArray (   $titles,
  $caller = '' 
)

Wrapper for doQuery that processes a title or string array.

Since
1.20
Parameters
array$titlesArray of Title objects or strings
string$callerThe calling method

Definition at line 131 of file GenderCache.php.

References $title, $titles, as, doQuery(), and Title\newFromText().

◆ getDefault()

GenderCache::getDefault ( )
protected

Returns the default gender option in this wiki.

Returns
string

Definition at line 62 of file GenderCache.php.

References $default, User\getDefaultOption(), and null.

Referenced by doQuery(), and getGenderOf().

◆ getGenderOf()

GenderCache::getGenderOf (   $username,
  $caller = '' 
)

Returns the gender for given username.

Parameters
string | User$username
string$callerThe calling method
Returns
string

Definition at line 76 of file GenderCache.php.

References $username, cache, doQuery(), getDefault(), and wfDebug().

◆ normalizeUsername()

static GenderCache::normalizeUsername (   $username)
staticprivate

Definition at line 197 of file GenderCache.php.

References $username.

◆ singleton()

static GenderCache::singleton ( )
static
Deprecated:
in 1.28 see MediaWikiServices::getInstance()->getGenderCache()
Returns
GenderCache

Definition at line 54 of file GenderCache.php.

Member Data Documentation

◆ $cache

GenderCache::$cache = []
protected

Definition at line 34 of file GenderCache.php.

◆ $default

GenderCache::$default
protected

Definition at line 35 of file GenderCache.php.

Referenced by doQuery(), and getDefault().

◆ $loadBalancer

ILoadBalancer null GenderCache::$loadBalancer
private

Definition at line 43 of file GenderCache.php.

Referenced by __construct().

◆ $misses

GenderCache::$misses = 0
protected

Definition at line 36 of file GenderCache.php.

◆ $missLimit

GenderCache::$missLimit = 1000
protected

Definition at line 37 of file GenderCache.php.

◆ $nsInfo

NamespaceInfo GenderCache::$nsInfo
private

Definition at line 40 of file GenderCache.php.


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