BackendInterface.php
2.17 KB
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<?php
namespace Phalcon\Cache {
/**
* Phalcon\Cache\BackendInterface initializer
*/
interface BackendInterface {
/**
* Starts a cache. The $keyname allows to identify the created fragment
*
* @param int|string $keyName
* @param long $lifetime
* @return mixed
*/
public function start($keyName, $lifetime=null);
/**
* Stops the frontend without store any cached content
*
* @param boolean $stopBuffer
*/
public function stop($stopBuffer=null);
/**
* Returns front-end instance adapter related to the back-end
*
* @return mixed
*/
public function getFrontend();
/**
* Returns the backend options
*
* @return array
*/
public function getOptions();
/**
* Checks whether the last cache is fresh or cached
*
* @return boolean
*/
public function isFresh();
/**
* Checks whether the cache has starting buffering or not
*
* @return boolean
*/
public function isStarted();
/**
* Sets the last key used in the cache
*
* @param string $lastKey
*/
public function setLastKey($lastKey);
/**
* Gets the last key stored by the cache
*
* @return string
*/
public function getLastKey();
/**
* Returns a cached content
*
* @param int|string $keyName
* @param long $lifetime
* @return mixed
*/
public function get($keyName, $lifetime=null);
/**
* Stores cached content into the file backend and stops the frontend
*
* @param int|string $keyName
* @param string $content
* @param long $lifetime
* @param boolean $stopBuffer
*/
public function save($keyName=null, $content=null, $lifetime=null, $stopBuffer=null);
/**
* Deletes a value from the cache by its key
*
* @param int|string $keyName
* @return boolean
*/
public function delete($keyName);
/**
* Query the existing cached keys
*
* @param string $prefix
* @return array
*/
public function queryKeys($prefix=null);
/**
* Checks if cache exists and it hasn't expired
*
* @param string $keyName
* @param long $lifetime
* @return boolean
*/
public function exists($keyName=null, $lifetime=null);
}
}