Repository navigation
Expand file tree
/
Copy pathinterface.Cache.php
More file actions
94 lines (86 loc) · 2.96 KB
/
Copy pathinterface.Cache.php
File metadata and controls
94 lines (86 loc) · 2.96 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
<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
* (under the project TAO & TAO2);
* 2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
* (under the project TAO-TRANSFER);
* 2009-2012 (update and modification) Public Research Centre Henri Tudor
* (under the project TAO-SUSTAIN & TAO-DEV);
* 2013-2014 (update and modification) Open Assessment Technologies SA;
*/
/**
* basic interface a cache implementation has to implement
* @deprecated please use oat\oatbox\cache\SimpleCache
*/
interface common_cache_Cache
{
/**
* Service manager id.
*/
public const SERVICE_ID = 'generis/cache';
// --- OPERATIONS ---
/**
* puts "something" into the cache,
* * If this is an object and implements Serializable,
* * we use the serial provided by the object
* * else a serial must be provided
* @access public
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
* @param mixed $mixed
* @param null $serial
* @param null $ttl
* @return mixed
*/
public function put($mixed, $serial = null, $ttl = null);
/**
* gets the entry associted to the serial
* throws an exception if not found
*
* @access public
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
* @param string serial
* @return common_Serializable
* @throws common_cache_NotFoundException
*/
public function get($serial);
/**
* test whenever an entry associted to the serial exists
*
* @access public
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
* @param string serial
* @return boolean
*/
public function has($serial);
/**
* removes an entry from the cache
*
* @access public
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
* @param string serial
* @return mixed
*/
public function remove($serial);
/**
* empties the cache
*
* @access public
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
* @return mixed
*/
public function purge();
}