MediaWiki
1.30.0
|
This class stores an arbitrary value along with its dependencies. More...
Public Member Functions | |
__construct ( $value=false, $deps=[]) | |
Create an instance. More... | |
getValue () | |
Get the user-defined value. More... | |
initialiseDeps () | |
Initialise dependency values in preparation for storing. More... | |
isExpired () | |
Returns true if any of the dependencies have expired. More... | |
storeToCache ( $cache, $key, $expiry=0) | |
Store the wrapper to a cache. More... | |
Static Public Member Functions | |
static | getValueFromCache ( $cache, $key, $expiry=0, $callback=false, $callbackParams=[], $deps=[]) |
Attempt to get a value from the cache. More... | |
Private Attributes | |
CacheDependency[] | $deps |
$value | |
This class stores an arbitrary value along with its dependencies.
Users should typically only use DependencyWrapper::getValueFromCache(), rather than instantiating one of these objects directly.
Definition at line 31 of file CacheDependency.php.
DependencyWrapper::__construct | ( | $value = false , |
|
$deps = [] |
|||
) |
Create an instance.
mixed | $value | The user-supplied value |
CacheDependency | CacheDependency[] | $deps | A dependency or dependency array. All dependencies must be objects implementing CacheDependency. |
Definition at line 42 of file CacheDependency.php.
DependencyWrapper::getValue | ( | ) |
Get the user-defined value.
Definition at line 81 of file CacheDependency.php.
References $value.
|
static |
Attempt to get a value from the cache.
If the value is expired or missing, it will be generated with the callback function (if present), and the newly calculated value will be stored to the cache in a wrapper.
BagOStuff | $cache | A cache object |
string | $key | The cache key |
int | $expiry | The expiry timestamp or interval in seconds |
bool | callable | $callback | The callback for generating the value, or false |
array | $callbackParams | The function parameters for the callback |
array | $deps | The dependencies to store on a cache miss. Note: these are not the dependencies used on a cache hit! Cache hits use the stored dependency array. |
Definition at line 114 of file CacheDependency.php.
References $cache, $deps, $value, and isExpired().
DependencyWrapper::initialiseDeps | ( | ) |
Initialise dependency values in preparation for storing.
This must be called before serialization.
Definition at line 71 of file CacheDependency.php.
References as.
Referenced by storeToCache().
DependencyWrapper::isExpired | ( | ) |
Returns true if any of the dependencies have expired.
Definition at line 57 of file CacheDependency.php.
References as.
Referenced by getValueFromCache().
DependencyWrapper::storeToCache | ( | $cache, | |
$key, | |||
$expiry = 0 |
|||
) |
Store the wrapper to a cache.
BagOStuff | $cache | |
string | $key | |
int | $expiry |
Definition at line 92 of file CacheDependency.php.
References $cache, and initialiseDeps().
|
private |
Definition at line 34 of file CacheDependency.php.
Referenced by __construct(), and getValueFromCache().
|
private |
Definition at line 32 of file CacheDependency.php.
Referenced by __construct(), getValue(), and getValueFromCache().