aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cache/driver/interface.php
blob: 313a2d4b31d44967c0cf38a7d30a1cc3228f6231 (plain)
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
<?php
/**
*
* @package acm
* @copyright (c) 2010 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
	exit;
}

/**
* An interface that all cache drivers must implement
*
* @package acm
*/
interface phpbb_cache_driver_interface
{
	/**
	* Load global cache
	*/
	public function load();

	/**
	* Unload cache object
	*/
	public function unload();

	/**
	* Save modified objects
	*/
	public function save();

	/**
	* Tidy cache
	*/
	public function tidy();

	/**
	* Get saved cache object
	*/
	public function get($var_name);

	/**
	* Put data into cache
	*/
	public function put($var_name, $var, $ttl = 0);

	/**
	* Purge cache data
	*/
	public function purge();

	/**
	* Destroy cache data
	*/
	public function destroy($var_name, $table = '');

	/**
	* Check if a given cache entry exist
	*/
	public function _exists($var_name);

	/**
	* Load cached sql query
	*/
	public function sql_load($query);

	/**
	* Save sql query
	*/
	public function sql_save($query, &$query_result, $ttl);

	/**
	* Ceck if a given sql query exist in cache
	*/
	public function sql_exists($query_id);

	/**
	* Fetch row from cache (database)
	*/
	public function sql_fetchrow($query_id);

	/**
	* Fetch a field from the current row of a cached database result (database)
	*/
	public function sql_fetchfield($query_id, $field);

	/**
	* Seek a specific row in an a cached database result (database)
	*/
	public function sql_rowseek($rownum, $query_id);

	/**
	* Free memory used for a cached database result (database)
	*/
	public function sql_freeresult($query_id);
}