MediaWiki  1.23.3
ProcessCacheLRU Class Reference

Handles per process caching of items. More...

Inheritance diagram for ProcessCacheLRU:

Public Member Functions

 __construct ( $maxKeys)
 
 clear ( $keys=null)
 Clear one or several cache entries, or all cache entries. More...
 
 get ( $key, $prop)
 Get a property field for a cache entry. More...
 
 has ( $key, $prop, $maxAge=0)
 Check if a property field exists for a cache entry. More...
 
 set ( $key, $prop, $value)
 Set a property field for a cache entry. More...
 

Protected Member Functions

 ping ( $key)
 Push an entry to the top of the cache. More...
 

Protected Attributes

Array $cache = array()
 
Array $cacheTimes = array()
 
 $maxCacheKeys
 

Detailed Description

Handles per process caching of items.

Definition at line 28 of file ProcessCacheLRU.php.

Constructor & Destructor Documentation

◆ __construct()

ProcessCacheLRU::__construct (   $maxKeys)
Parameters
$maxKeysinteger Maximum number of entries allowed (min 1).
Exceptions
UnexpectedValueExceptionWhen $maxCacheKeys is not an int or =< 0.

Definition at line 38 of file ProcessCacheLRU.php.

Member Function Documentation

◆ clear()

ProcessCacheLRU::clear (   $keys = null)

Clear one or several cache entries, or all cache entries.

Parameters
$keysstring|Array
Returns
void

Definition at line 108 of file ProcessCacheLRU.php.

References $keys, array(), as, and cache.

◆ get()

ProcessCacheLRU::get (   $key,
  $prop 
)

Get a property field for a cache entry.

This returns null if the property is not set. If the item is already set, it will be pushed to the top of the cache.

Parameters
$keystring
$propstring
Returns
mixed

Definition at line 93 of file ProcessCacheLRU.php.

References cache, and ping().

◆ has()

ProcessCacheLRU::has (   $key,
  $prop,
  $maxAge = 0 
)

Check if a property field exists for a cache entry.

Parameters
$keystring
$propstring
$maxAgeinteger Ignore items older than this many seconds (since 1.21)
Returns
bool

Definition at line 76 of file ProcessCacheLRU.php.

References cache.

◆ ping()

ProcessCacheLRU::ping (   $key)
protected

Push an entry to the top of the cache.

Parameters
$keystring

Definition at line 125 of file ProcessCacheLRU.php.

References cache.

Referenced by get(), and set().

◆ set()

ProcessCacheLRU::set (   $key,
  $prop,
  $value 
)

Set a property field for a cache entry.

This will prune the cache if it gets too large based on LRU. If the item is already set, it will be pushed to the top of the cache.

Parameters
$keystring
$propstring
$valuemixed
Returns
void

Definition at line 55 of file ProcessCacheLRU.php.

References $value, cache, key, and ping().

Member Data Documentation

◆ $cache

Array ProcessCacheLRU::$cache = array()
protected

Definition at line 29 of file ProcessCacheLRU.php.

◆ $cacheTimes

Array ProcessCacheLRU::$cacheTimes = array()
protected

Definition at line 30 of file ProcessCacheLRU.php.

◆ $maxCacheKeys

ProcessCacheLRU::$maxCacheKeys
protected

Definition at line 32 of file ProcessCacheLRU.php.


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