Issue #2951163 by nkoporec, Parvateesam, joachim: CachePluginBase::cacheGet()/::cacheSet() doesn't document @params or @return

merge-requests/1654/head
Nathaniel Catchpole 2018-06-07 22:10:38 +01:00
parent c00b97b2a5
commit 11f7f2a817
1 changed files with 9 additions and 0 deletions

View File

@ -97,6 +97,9 @@ abstract class CachePluginBase extends PluginBase {
* Save data to the cache.
*
* A plugin should override this to provide specialized caching behavior.
*
* @param $type
* The cache type, either 'query', 'result'.
*/
public function cacheSet($type) {
switch ($type) {
@ -119,6 +122,12 @@ abstract class CachePluginBase extends PluginBase {
* Retrieve data from the cache.
*
* A plugin should override this to provide specialized caching behavior.
*
* @param $type
* The cache type, either 'query', 'result'.
*
* @return bool
* TRUE if data has been taken from the cache, otherwise FALSE.
*/
public function cacheGet($type) {
$cutoff = $this->cacheExpire($type);