framework/main/interfaces/cache/class_Cacheable.php

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