MediaWiki  1.30.0
GadgetDefinitionNamespaceRepo Class Reference

GadgetRepo implementation where each gadget has a page in the Gadget definition namespace, and scripts and styles are located in the Gadget namespace. More...

Inheritance diagram for GadgetDefinitionNamespaceRepo:
Collaboration diagram for GadgetDefinitionNamespaceRepo:

Public Member Functions

 __construct ()
 
 getGadget ( $id)
 
 getGadgetIds ()
 Get a list of gadget ids from cache/database. More...
 
 purgeGadgetEntry ( $id)
 Update the cache for a specific Gadget whenever it is updated. More...
 
 purgeGadgetIdsList ()
 Purge the list of gadget ids when a page is deleted or if a new page is created. More...
 
- Public Member Functions inherited from GadgetRepo
 getStructuredList ()
 Get a list of gadgets sorted by category. More...
 

Public Attributes

const CACHE_TTL = 86400
 How long in seconds the list of gadget ids and individual gadgets should be cached for (1 day) More...
 

Private Member Functions

 getGadgetCacheKey ( $id)
 
 getGadgetIdsKey ()
 

Private Attributes

WANObjectCache $wanCache
 

Additional Inherited Members

- Static Public Member Functions inherited from GadgetRepo
static setSingleton ( $repo=null)
 Should only be used by unit tests. More...
 
static singleton ()
 Get the configured default GadgetRepo. More...
 

Detailed Description

GadgetRepo implementation where each gadget has a page in the Gadget definition namespace, and scripts and styles are located in the Gadget namespace.

Definition at line 10 of file GadgetDefinitionNamespaceRepo.php.

Constructor & Destructor Documentation

◆ __construct()

GadgetDefinitionNamespaceRepo::__construct ( )

Definition at line 22 of file GadgetDefinitionNamespaceRepo.php.

Member Function Documentation

◆ getGadget()

GadgetDefinitionNamespaceRepo::getGadget (   $id)

◆ getGadgetCacheKey()

GadgetDefinitionNamespaceRepo::getGadgetCacheKey (   $id)
private
Parameters
strng$id
Returns
string

Definition at line 130 of file GadgetDefinitionNamespaceRepo.php.

References Gadget\GADGET_CLASS_VERSION.

Referenced by getGadget(), and purgeGadgetEntry().

◆ getGadgetIds()

GadgetDefinitionNamespaceRepo::getGadgetIds ( )

Get a list of gadget ids from cache/database.

Returns
string[]

Reimplemented from GadgetRepo.

Definition at line 31 of file GadgetDefinitionNamespaceRepo.php.

References $dbr, array(), DB_SLAVE, getGadgetIdsKey(), IExpiringStore\TTL_PROC_SHORT, and wfGetDB().

◆ getGadgetIdsKey()

GadgetDefinitionNamespaceRepo::getGadgetIdsKey ( )
private
Returns
string

Definition at line 122 of file GadgetDefinitionNamespaceRepo.php.

Referenced by getGadgetIds(), and purgeGadgetIdsList().

◆ purgeGadgetEntry()

GadgetDefinitionNamespaceRepo::purgeGadgetEntry (   $id)

Update the cache for a specific Gadget whenever it is updated.

Parameters
string$id

Definition at line 115 of file GadgetDefinitionNamespaceRepo.php.

References getGadgetCacheKey().

◆ purgeGadgetIdsList()

GadgetDefinitionNamespaceRepo::purgeGadgetIdsList ( )

Purge the list of gadget ids when a page is deleted or if a new page is created.

Definition at line 59 of file GadgetDefinitionNamespaceRepo.php.

References getGadgetIdsKey().

Member Data Documentation

◆ $wanCache

WANObjectCache GadgetDefinitionNamespaceRepo::$wanCache
private

Definition at line 20 of file GadgetDefinitionNamespaceRepo.php.

◆ CACHE_TTL

const GadgetDefinitionNamespaceRepo::CACHE_TTL = 86400

How long in seconds the list of gadget ids and individual gadgets should be cached for (1 day)

Definition at line 15 of file GadgetDefinitionNamespaceRepo.php.


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