inc/classes/interfaces/cache/class_Cacheable.php

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