lib/system/cache/source/ICacheSource.class.php

   1 <?php
   2 namespace dns\system\cache\source;
   3
   4 /**
   5  * Any cache sources should implement this interface.
   6  *
   7  * @author      Alexander Ebert
   8  * @copyright   2001-2014 WoltLab GmbH
   9  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  10  * @package     com.woltlab.wcf
  11  * @subpackage  system.cache.source
  12  * @category    Community Framework
  13  */
  14 interface ICacheSource {
  15         /**
  16          * Flushes a specific cache, optionally removing caches which share the same name.
  17          *
  18          * @param       string          $cacheName
  19          * @param       boolean         $useWildcard
  20          */
  21         public function flush($cacheName, $useWildcard);
  22
  23         /**
  24          * Clears the cache completely.
  25          */
  26         public function flushAll();
  27
  28         /**
  29          * Returns a cached variable.
  30          *
  31          * @param       string          $cacheName
  32          * @param       integer         $maxLifetime
  33          * @return      mixed
  34          */
  35         public function get($cacheName, $maxLifetime);
  36
  37         /**
  38          * Stores a variable in the cache.
  39          *
  40          * @param       string          $cacheName
  41          * @param       mixed           $value
  42          * @param       integer         $maxLifetime
  43          */
  44         public function set($cacheName, $value, $maxLifetime);
  45 }