-
Notifications
You must be signed in to change notification settings - Fork 0
/
DriverInterface.php
69 lines (62 loc) · 1.78 KB
/
DriverInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?php
/**
* @author Joshua Estes
* @copyright 2015 Joshua Estes
* @license https://raw.githubusercontent.com/JoshuaEstes/Kash/master/LICENSE MIT
*/
namespace Kash\Driver;
use Kash\CacheItemInterface;
/**
* @since 0.1.0
*/
interface DriverInterface
{
/**
* Returns true if the item exists in it's cache
*
* @since 0.1.0
* @param CacheItemInterface $item
* @return boolean
*/
public function has(CacheItemInterface $item);
/**
* Uses a CacheItemInterface to find the item in the backend. If the item
* is found it returns that item. If it is not found it should pass back
* the original item passed to it.
*
* @since 0.1.0
* @param CacheItemInterface $item
* @return CacheItemInterface
*/
public function get(CacheItemInterface $item);
/**
* Clears the entire cache backend of cached items. If successful it should
* return true. If there was an error, it should throw a CacheException
*
* @since 0.1.0
* @throws CacheException
* @return boolean
*/
public function clear();
/**
* Delete an item from the cache backend using the item passed into it. It
* should return true if the item was successfully deleted, if any issues
* happen it should throw a CacheException
*
* @since 0.1.0
* @param CacheItemInterface $item
* @throws CacheException
* @return boolean
*/
public function delete(CacheItemInterface $item);
/**
* Persists an item to the backend cache. Returns true if successful or
* throws a CacheException if there was an error.
*
* @since 0.1.0
* @param CacheItemInterface $item
* @throws CacheException
* @return boolean
*/
public function save(CacheItemInterface $item);
}