3 namespace Org\Mxchange\CoreFramework\Cache;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 * An interface for classes which are "able" to cache
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 <<<<<<< HEAD:framework/main/interfaces/cache/class_Cacheable.php
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
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
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.
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.
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/>.
34 interface Cacheable extends FrameworkInterface {
36 * Does the specified offset exist in cache?
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
43 function offsetExists($offset, $arrayElement = NULL, $minimumCount = 0);
46 * Setter for cache offset
48 * @param $offset The offset we shall set
49 * @param $data Data to store in cache
52 function offsetSet($offset, $data);
55 * Getter for cache offset or "null" if not found
57 * @param $offset The offset we shall set
58 * @return $data Data to store in cache
60 function offsetGet($offset);
63 * Purges the given cache entry
65 * @param $offset The offset we shall set
68 function purgeOffset($offset);