Copyright year updated, converted double->single quotes

[core.git] / inc / classes / interfaces / cache / class_Cacheable.php

diff --git a/inc/classes/interfaces/cache/class_Cacheable.php b/inc/classes/interfaces/cache/class_Cacheable.php
index e2748a23961f9b0e22bb7c26c96379a183c0c5be..af15240140603c111870bd817382502d7547475a 100644 (file)
--- a/inc/classes/interfaces/cache/class_Cacheable.php
+++ b/inc/classes/interfaces/cache/class_Cacheable.php
@@ -2,11 +2,11 @@
 /**
  * An interface for classes which are "able" to cache
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,10 +25,37 @@ interface Cacheable extends FrameworkInterface {
        /**
         * Does the specified offset exist in cache?
         *
-        * @param       $offset         The offsrt we are looking for
-        * @return      $exists         Wether the offset exists
+        * @param       $offset                 The offset we are looking for
+        * @param       $arrayElement   If type is array, then this element must be found
+        * @param       $minimumCount   If array element is found then this count must at least match
+        * @return      $exists                 Whether the offset exists
         */
-       function offsetExists ($offset);
+       function offsetExists($offset, $arrayElement = NULL, $minimumCount = 0);
+
+       /**
+        * Setter for cache offset
+        *
+        * @param       $offset         The offset we shall set
+        * @param       $data           Data to store in cache
+        * @return      void
+        */
+       function offsetSet($offset, $data);
+
+       /**
+        * Getter for cache offset or "null" if not found
+        *
+        * @param       $offset         The offset we shall set
+        * @return      $data           Data to store in cache
+        */
+       function offsetGet($offset);
+
+       /**
+        * Purges the given cache entry
+        *
+        * @param       $offset         The offset we shall set
+        * @return      void
+        */
+       function purgeOffset($offset);
 }
 
 // [EOF]