inc/main/interfaces/cache/class_Cacheable.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Cache;
   4
   5 // Load framework stuff
   6 use CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for classes which are "able" to cache
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface Cacheable extends FrameworkInterface {
  31         /**
  32          * Does the specified offset exist in cache?
  33          *
  34          * @param       $offset                 The offset we are looking for
  35          * @param       $arrayElement   If type is array, then this element must be found
  36          * @param       $minimumCount   If array element is found then this count must at least match
  37          * @return      $exists                 Whether the offset exists
  38          */
  39         function offsetExists($offset, $arrayElement = NULL, $minimumCount = 0);
  40
  41         /**
  42          * Setter for cache offset
  43          *
  44          * @param       $offset         The offset we shall set
  45          * @param       $data           Data to store in cache
  46          * @return      void
  47          */
  48         function offsetSet($offset, $data);
  49
  50         /**
  51          * Getter for cache offset or "null" if not found
  52          *
  53          * @param       $offset         The offset we shall set
  54          * @return      $data           Data to store in cache
  55          */
  56         function offsetGet($offset);
  57
  58         /**
  59          * Purges the given cache entry
  60          *
  61          * @param       $offset         The offset we shall set
  62          * @return      void
  63          */
  64         function purgeOffset($offset);
  65
  66 }