<?php
// Own namespace
namespace Org\Mxchange\CoreFramework\Cache;

// Import framework stuff
use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;

/**
 * An interface for classes which are "able" to cache
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
interface Cacheable extends FrameworkInterface {
	/**
	 * Does the specified offset exist in cache?
	 *
	 * @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, $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);

}