Interface for all classes implementing CacheHelper functionality. More...
Public Member Functions | |
| getCachedValue ($computeFunction, $args=array(), $key=null) | |
| Get a cached value if available or compute it if not and then cache it if possible. | |
| saveCache () | |
| Saves the HTML to the cache in case it got recomputed. | |
| setCacheEnabled ($cacheEnabled) | |
| Sets if the cache should be enabled or not. | |
| setExpiry ($cacheExpiry) | |
| Sets the time to live for the cache, in seconds or a unix timestamp indicating the point of expiry... | |
| startCache ($cacheExpiry=null, $cacheEnabled=null) | |
| Initializes the caching. | |
Detailed Description
Interface for all classes implementing CacheHelper functionality.
- Since:
- 1.20
Definition at line 30 of file CacheHelper.php.
Member Function Documentation
| ICacheHelper::getCachedValue | ( | $ | computeFunction, |
| $ | args = array(), |
||
| $ | key = null |
||
| ) |
Get a cached value if available or compute it if not and then cache it if possible.
The provided $computeFunction is only called when the computation needs to happen and should return a result value. $args are arguments that will be passed to the compute function when called.
- Since:
- 1.20
- Parameters:
-
{function} $computeFunction array | mixed $args string | null $key
- Returns:
- mixed
Implemented in CacheHelper, SpecialCachedPage, and CachedAction.
Saves the HTML to the cache in case it got recomputed.
Should be called after the last time anything is added via addCachedHTML.
- Since:
- 1.20
Implemented in CacheHelper, SpecialCachedPage, and CachedAction.
| ICacheHelper::setCacheEnabled | ( | $ | cacheEnabled | ) |
Sets if the cache should be enabled or not.
- Since:
- 1.20
- Parameters:
-
boolean $cacheEnabled
Implemented in CacheHelper, SpecialCachedPage, and CachedAction.
| ICacheHelper::setExpiry | ( | $ | cacheExpiry | ) |
Sets the time to live for the cache, in seconds or a unix timestamp indicating the point of expiry...
- Since:
- 1.20
- Parameters:
-
integer $cacheExpiry
Implemented in CacheHelper, SpecialCachedPage, and CachedAction.
| ICacheHelper::startCache | ( | $ | cacheExpiry = null, |
| $ | cacheEnabled = null |
||
| ) |
Initializes the caching.
Should be called before the first time anything is added via addCachedHTML.
- Since:
- 1.20
- Parameters:
-
integer | null $cacheExpiry Sets the cache expiry, either ttl in seconds or unix timestamp. boolean | null $cacheEnabled Sets if the cache should be enabled or not.
Implemented in CacheHelper, SpecialCachedPage, and CachedAction.
The documentation for this interface was generated from the following file:
- includes/CacheHelper.php
