HummingBirdAnimeClient/src/Aviat/Ion/Cache/CacheInterface.php

48 lines
1.1 KiB
PHP
Raw Normal View History

2016-04-01 17:35:53 -04:00
<?php
/**
* Ion
*
* Building blocks for web development
*
* @package Ion
* @author Timothy J. Warren
* @copyright Copyright (c) 2015 - 2016
* @license MIT
*/
namespace Aviat\Ion\Cache;
/**
* Interface for retrieving values from cache
*/
interface CacheInterface {
2016-04-01 17:35:53 -04:00
/**
* Retreive a cached value if it exists, otherwise, get the value
* from the passed arguments
*
* @param object $object - object to retrieve fresh value from
* @param string $method - method name to call
2016-04-05 13:19:35 -04:00
* @param [array] $args - the arguments to pass to the retrieval method
2016-04-01 17:35:53 -04:00
* @return mixed - the cached or fresh data
2016-04-05 13:19:35 -04:00
*/
public function get($object, $method, array $args=[]);
/**
* Retreive a fresh value, and update the cache
*
* @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
* @return mixed - the fresh data
*/
public function getFresh($object, $method, array $args=[]);
/**
* Clear the entire cache
*
* @return void
*/
public function purge();
2016-04-01 17:35:53 -04:00
}
// End of CacheInterface.php