3 * An interface for classes which are "able" to cache
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 interface Cacheable extends FrameworkInterface {
26 * Does the specified offset exist in cache?
28 * @param $offset The offset we are looking for
29 * @return $exists Whether the offset exists
31 function offsetExists($offset);
34 * Setter for cache offset
36 * @param $offset The offset we shall set
37 * @param $data Data to store in cache
40 function offsetSet($offset, $data);
43 * Getter for cache offset or "null" if not found
45 * @param $offset The offset we shall set
46 * @return $data Data to store in cache
48 function offsetGet($offset);
51 * Purges the given cache entry
53 * @param $offset The offset we shall set
56 function purgeOffset($offset);