MediaWiki master
Wikimedia\DependencyStore\KeyValueDependencyStore Class Reference

Track per-module file dependencies in object cache via BagOStuff. More...

Inherits Wikimedia\DependencyStore\DependencyStore.

Collaboration diagram for Wikimedia\DependencyStore\KeyValueDependencyStore:

Public Member Functions

 __construct (BagOStuff $stash)
 
 remove ( $type, $entities)
 Delete the currently tracked dependencies for an entity or set of entities.
 
 retrieveMulti ( $type, array $entities)
 Get the currently tracked dependencies for a set of entities.
 
 storeMulti ( $type, array $dataByEntity, $ttl)
 Set the currently tracked dependencies for a set of entities.
 
- Public Member Functions inherited from Wikimedia\DependencyStore\DependencyStore
 newEntityDependencies (array $paths=[], $asOf=null)
 
 retrieve ( $type, $entity)
 Get the currently tracked dependencies for an entity.
 
 store ( $type, $entity, array $data, $ttl)
 Set the currently tracked dependencies for an entity.
 

Detailed Description

Track per-module file dependencies in object cache via BagOStuff.

See also
$wgResourceLoaderUseObjectCacheForDeps
Access: internal
For use by ResourceLoader\Module only
Since
1.35

Definition at line 33 of file KeyValueDependencyStore.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\DependencyStore\KeyValueDependencyStore::__construct ( BagOStuff $stash)
Parameters
BagOStuff$stashStorage backend

Definition at line 40 of file KeyValueDependencyStore.php.

Member Function Documentation

◆ remove()

Wikimedia\DependencyStore\KeyValueDependencyStore::remove ( $type,
$entities )

Delete the currently tracked dependencies for an entity or set of entities.

Parameters
string$typeEntity type
string | string[]$entitiesEntity name(s)

Reimplemented from Wikimedia\DependencyStore\DependencyStore.

Definition at line 85 of file KeyValueDependencyStore.php.

◆ retrieveMulti()

Wikimedia\DependencyStore\KeyValueDependencyStore::retrieveMulti ( $type,
array $entities )

Get the currently tracked dependencies for a set of entities.

See also
KeyValueDependencyStore::retrieve()
Parameters
string$typeEntity type
string[]$entitiesEntity names
Returns
array[] Map of (entity => (paths: paths, asOf: UNIX timestamp or null))

Reimplemented from Wikimedia\DependencyStore\DependencyStore.

Definition at line 44 of file KeyValueDependencyStore.php.

References Wikimedia\DependencyStore\DependencyStore\newEntityDependencies().

◆ storeMulti()

Wikimedia\DependencyStore\KeyValueDependencyStore::storeMulti ( $type,
array $dataByEntity,
$ttl )

Set the currently tracked dependencies for a set of entities.

See also
KeyValueDependencyStore::store()
Parameters
string$typeEntity type
array[]$dataByEntityMap of (entity => (paths: paths, asOf: UNIX timestamp or null))
int$ttlNew time-to-live in seconds

Reimplemented from Wikimedia\DependencyStore\DependencyStore.

Definition at line 65 of file KeyValueDependencyStore.php.


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