MediaWiki  REL1_31
MediaWiki\Storage\NameTableStore Class Reference
Collaboration diagram for MediaWiki\Storage\NameTableStore:

Public Member Functions

 __construct (LoadBalancer $dbLoadBalancer, WANObjectCache $cache, LoggerInterface $logger, $table, $idField, $nameField, callable $normalizationCallback=null, $wikiId=false)
 
 acquireId ( $name)
 Acquire the id of the given name. More...
 
 getId ( $name)
 Get the id of the given name. More...
 
 getMap ()
 Get the whole table, in no particular order as a map of ids to names. More...
 
 getName ( $id)
 Get the name of the given id. More...
 

Private Member Functions

 getCacheKey ()
 
 getDBConnection ( $index, $flags=0)
 
 getTableFromCachesOrReplica ()
 
 loadTable (IDatabase $db)
 Gets the table from the db. More...
 
 normalizeName ( $name)
 
 purgeWANCache ( $purgeCallback)
 Reap the WANCache entry for this table. More...
 
 store ( $name)
 Stores the given name in the DB, returning the ID when an insert occurs. More...
 

Private Attributes

WANObjectCache $cache
 
int $cacheTTL
 
string $idField
 
LoadBalancer $loadBalancer
 
LoggerInterface $logger
 
string $nameField
 
null callable $normalizationCallback = null
 
string $table
 
string[] $tableCache = null
 
bool string $wikiId = false
 

Detailed Description

Author
Addshore
Since
1.31

Definition at line 35 of file NameTableStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\NameTableStore::__construct ( LoadBalancer  $dbLoadBalancer,
WANObjectCache  $cache,
LoggerInterface  $logger,
  $table,
  $idField,
  $nameField,
callable  $normalizationCallback = null,
  $wikiId = false 
)
Parameters
LoadBalancer$dbLoadBalancerA load balancer for acquiring database connections
WANObjectCache$cacheA cache manager for caching data
LoggerInterface$logger
string$table
string$idField
string$nameField
callable$normalizationCallbackNormalization to be applied to names before being saved or queried. This should be a callback that accepts and returns a single string.
bool | string$wikiIdThe ID of the target wiki database. Use false for the local wiki.

Definition at line 75 of file NameTableStore.php.

References MediaWiki\Storage\NameTableStore\$cache, MediaWiki\Storage\NameTableStore\$idField, MediaWiki\Storage\NameTableStore\$logger, MediaWiki\Storage\NameTableStore\$nameField, MediaWiki\Storage\NameTableStore\$normalizationCallback, MediaWiki\Storage\NameTableStore\$table, MediaWiki\Storage\NameTableStore\$wikiId, cache, table, and IExpiringStore\TTL_MONTH.

Member Function Documentation

◆ acquireId()

◆ getCacheKey()

MediaWiki\Storage\NameTableStore::getCacheKey ( )
private

◆ getDBConnection()

MediaWiki\Storage\NameTableStore::getDBConnection (   $index,
  $flags = 0 
)
private
Parameters
int$indexA database index, like DB_MASTER or DB_REPLICA
int$flagsDatabase connection flags
Returns
IDatabase

Definition at line 102 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\acquireId(), MediaWiki\Storage\NameTableStore\getName(), MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica(), MediaWiki\Storage\NameTableStore\purgeWANCache(), and MediaWiki\Storage\NameTableStore\store().

◆ getId()

MediaWiki\Storage\NameTableStore::getId (   $name)

Get the id of the given name.

If the name doesn't exist this will throw. This should be used in cases where we believe the name already exists or want to check for existence.

Parameters
string$name
Exceptions
NameTableAccessExceptionThe name does not exist
Returns
int Id

Definition at line 182 of file NameTableStore.php.

References $name, MediaWiki\Storage\NameTableStore\$table, MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica(), MediaWiki\Storage\NameTableAccessException\newFromDetails(), MediaWiki\Storage\NameTableStore\normalizeName(), and table.

◆ getMap()

MediaWiki\Storage\NameTableStore::getMap ( )

Get the whole table, in no particular order as a map of ids to names.

This method could be subject to DB or cache lag.

Returns
string[] keys are the name ids, values are the names themselves Example: [ 1 => 'foo', 3 => 'bar' ]

Definition at line 266 of file NameTableStore.php.

References MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica().

◆ getName()

MediaWiki\Storage\NameTableStore::getName (   $id)

Get the name of the given id.

If the id doesn't exist this will throw. This should be used in cases where we believe the id already exists.

Note: Calls to this method will result in a master select for non existing IDs.

Parameters
int$id
Exceptions
NameTableAccessExceptionThe id does not exist
Returns
string name

Definition at line 207 of file NameTableStore.php.

References $source, MediaWiki\Storage\NameTableStore\$table, as, cache, DB_MASTER, DB_REPLICA, MediaWiki\Storage\NameTableStore\getCacheKey(), Wikimedia\Rdbms\Database\getCacheSetOptions(), MediaWiki\Storage\NameTableStore\getDBConnection(), MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica(), MediaWiki\Storage\NameTableStore\loadTable(), MediaWiki\Storage\NameTableAccessException\newFromDetails(), table, WANObjectCache\TTL_UNCACHEABLE, and use.

◆ getTableFromCachesOrReplica()

◆ loadTable()

MediaWiki\Storage\NameTableStore::loadTable ( IDatabase  $db)
private

Gets the table from the db.

Parameters
IDatabase$db
Returns
string[]

Definition at line 316 of file NameTableStore.php.

References as, Wikimedia\Rdbms\IDatabase\select(), and table.

Referenced by MediaWiki\Storage\NameTableStore\acquireId(), MediaWiki\Storage\NameTableStore\getName(), and MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica().

◆ normalizeName()

MediaWiki\Storage\NameTableStore::normalizeName (   $name)
private
Parameters
string$name
Returns
string

Definition at line 114 of file NameTableStore.php.

References $name.

Referenced by MediaWiki\Storage\NameTableStore\acquireId(), and MediaWiki\Storage\NameTableStore\getId().

◆ purgeWANCache()

MediaWiki\Storage\NameTableStore::purgeWANCache (   $purgeCallback)
private

Reap the WANCache entry for this table.

Parameters
callable$purgeCallbackcallback to 'purge' the WAN cache

Definition at line 298 of file NameTableStore.php.

References DB_MASTER, and MediaWiki\Storage\NameTableStore\getDBConnection().

Referenced by MediaWiki\Storage\NameTableStore\acquireId().

◆ store()

MediaWiki\Storage\NameTableStore::store (   $name)
private

Stores the given name in the DB, returning the ID when an insert occurs.

Parameters
string$name
Returns
int|null int if we know the ID, null if we don't

Definition at line 342 of file NameTableStore.php.

References $name, DB_MASTER, MediaWiki\Storage\NameTableStore\getDBConnection(), and table.

Referenced by MediaWiki\Storage\NameTableStore\acquireId().

Member Data Documentation

◆ $cache

WANObjectCache MediaWiki\Storage\NameTableStore::$cache
private

Definition at line 41 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\__construct().

◆ $cacheTTL

int MediaWiki\Storage\NameTableStore::$cacheTTL
private

Definition at line 53 of file NameTableStore.php.

◆ $idField

string MediaWiki\Storage\NameTableStore::$idField
private

Definition at line 58 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\__construct().

◆ $loadBalancer

LoadBalancer MediaWiki\Storage\NameTableStore::$loadBalancer
private

Definition at line 38 of file NameTableStore.php.

◆ $logger

LoggerInterface MediaWiki\Storage\NameTableStore::$logger
private

Definition at line 44 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\__construct().

◆ $nameField

string MediaWiki\Storage\NameTableStore::$nameField
private

Definition at line 60 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\__construct().

◆ $normalizationCallback

null callable MediaWiki\Storage\NameTableStore::$normalizationCallback = null
private

Definition at line 62 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\__construct().

◆ $table

◆ $tableCache

string [] MediaWiki\Storage\NameTableStore::$tableCache = null
private

◆ $wikiId

bool string MediaWiki\Storage\NameTableStore::$wikiId = false
private

Definition at line 50 of file NameTableStore.php.

Referenced by MediaWiki\Storage\NameTableStore\__construct().


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