2016-10-13 13:11:22 -04:00
|
|
|
<?php declare(strict_types=1);
|
2016-08-04 14:55:37 -04:00
|
|
|
/**
|
|
|
|
* Ion
|
|
|
|
*
|
|
|
|
* Building blocks for web development
|
|
|
|
*
|
2016-10-13 13:11:22 -04:00
|
|
|
* PHP version 7
|
2016-08-26 23:10:20 -04:00
|
|
|
*
|
2016-08-04 14:55:37 -04:00
|
|
|
* @package Ion
|
2016-08-26 23:10:20 -04:00
|
|
|
* @author Timothy J. Warren <tim@timshomepage.net>
|
|
|
|
* @copyright 2015 - 2016 Timothy J. Warren
|
|
|
|
* @license http://www.opensource.org/licenses/mit-license.html MIT License
|
|
|
|
* @version 1.0.0
|
|
|
|
* @link https://git.timshomepage.net/timw4mail/ion
|
2016-08-04 14:55:37 -04:00
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Aviat\Ion\Cache;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Interface for retrieving values from cache
|
|
|
|
*/
|
|
|
|
interface CacheInterface {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve a cached value if it exists, otherwise, get the value
|
|
|
|
* from the passed arguments
|
|
|
|
*
|
2016-08-26 17:21:50 -04:00
|
|
|
* @param object $object - object to retrieve fresh value from
|
|
|
|
* @param string $method - method name to call
|
|
|
|
* @param [array] $args - the arguments to pass to the retrieval method
|
2016-08-04 14:55:37 -04:00
|
|
|
* @return mixed - the cached or fresh data
|
|
|
|
*/
|
|
|
|
public function get($object, $method, array $args=[]);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieve a fresh value, and update the cache
|
|
|
|
*
|
2016-08-26 17:21:50 -04:00
|
|
|
* @param object $object - object to retrieve fresh value from
|
|
|
|
* @param string $method - method name to call
|
|
|
|
* @param [array] $args - the arguments to pass to the retrieval method
|
2016-08-04 14:55:37 -04:00
|
|
|
* @return mixed - the fresh data
|
|
|
|
*/
|
|
|
|
public function getFresh($object, $method, array $args=[]);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Clear the entire cache
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function purge();
|
|
|
|
}
|
|
|
|
// End of CacheInterface.php
|