|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Platine Template |
|
5
|
|
|
* |
|
6
|
|
|
* Platine Template is a template engine that has taken a lot of inspiration from Django. |
|
7
|
|
|
* |
|
8
|
|
|
* This content is released under the MIT License (MIT) |
|
9
|
|
|
* |
|
10
|
|
|
* Copyright (c) 2020 Platine Template |
|
11
|
|
|
* Copyright (c) 2014 Guz Alexander, http://guzalexander.com |
|
12
|
|
|
* Copyright (c) 2011, 2012 Harald Hanek, http://www.delacap.com |
|
13
|
|
|
* Copyright (c) 2006 Mateo Murphy |
|
14
|
|
|
* |
|
15
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
|
16
|
|
|
* of this software and associated documentation files (the "Software"), to deal |
|
17
|
|
|
* in the Software without restriction, including without limitation the rights |
|
18
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
19
|
|
|
* copies of the Software, and to permit persons to whom the Software is |
|
20
|
|
|
* furnished to do so, subject to the following conditions: |
|
21
|
|
|
* |
|
22
|
|
|
* The above copyright notice and this permission notice shall be included in all |
|
23
|
|
|
* copies or substantial portions of the Software. |
|
24
|
|
|
* |
|
25
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
26
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
27
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
28
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
29
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
30
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
31
|
|
|
* SOFTWARE. |
|
32
|
|
|
*/ |
|
33
|
|
|
|
|
34
|
|
|
/** |
|
35
|
|
|
* @file AbstractCache.php |
|
36
|
|
|
* |
|
37
|
|
|
* The Template cache base class |
|
38
|
|
|
* |
|
39
|
|
|
* @package Platine\Template\Cache |
|
40
|
|
|
* @author Platine Developers Team |
|
41
|
|
|
* @copyright Copyright (c) 2020 |
|
42
|
|
|
* @license http://opensource.org/licenses/MIT MIT License |
|
43
|
|
|
* @link https://www.platine-php.com |
|
44
|
|
|
* @version 1.0.0 |
|
45
|
|
|
* @filesource |
|
46
|
|
|
*/ |
|
47
|
|
|
|
|
48
|
|
|
declare(strict_types=1); |
|
49
|
|
|
|
|
50
|
|
|
namespace Platine\Template\Cache; |
|
51
|
|
|
|
|
52
|
|
|
use Platine\Template\Configuration; |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* @class AbstractCache |
|
56
|
|
|
* @package Platine\Template\Cache |
|
57
|
|
|
*/ |
|
58
|
|
|
abstract class AbstractCache |
|
59
|
|
|
{ |
|
60
|
|
|
/** |
|
61
|
|
|
* The cache expiration in second |
|
62
|
|
|
* @var int |
|
63
|
|
|
*/ |
|
64
|
|
|
protected int $expire = 3600; |
|
65
|
|
|
|
|
66
|
|
|
/** |
|
67
|
|
|
* The cache prefix to use |
|
68
|
|
|
* @var string |
|
69
|
|
|
*/ |
|
70
|
|
|
protected string $prefix = '__template'; |
|
71
|
|
|
|
|
72
|
|
|
/** |
|
73
|
|
|
* The configuration instance |
|
74
|
|
|
* @var Configuration |
|
75
|
|
|
*/ |
|
76
|
|
|
protected Configuration $config; |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* Create new instance |
|
80
|
|
|
* @param Configuration|null $config |
|
81
|
|
|
*/ |
|
82
|
|
|
public function __construct(?Configuration $config = null) |
|
83
|
|
|
{ |
|
84
|
|
|
$this->config = $config ?? new Configuration([]); |
|
85
|
|
|
|
|
86
|
|
|
$this->expire = $this->config->get('cache_expire'); |
|
87
|
|
|
$this->prefix = $this->config->get('cache_prefix'); |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* Return the cache stored value |
|
92
|
|
|
* @param string $key |
|
93
|
|
|
* @param bool $unserialize |
|
94
|
|
|
* @return mixed |
|
95
|
|
|
*/ |
|
96
|
|
|
abstract public function read(string $key, bool $unserialize = true): mixed; |
|
97
|
|
|
|
|
98
|
|
|
/** |
|
99
|
|
|
* Whether the cache exists |
|
100
|
|
|
* @param string $key |
|
101
|
|
|
* @return bool |
|
102
|
|
|
*/ |
|
103
|
|
|
abstract public function exists(string $key): bool; |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* Save the cache data |
|
107
|
|
|
* @param string $key |
|
108
|
|
|
* @param mixed $value |
|
109
|
|
|
* @param bool $serialize |
|
110
|
|
|
* @return bool |
|
111
|
|
|
*/ |
|
112
|
|
|
abstract public function write(string $key, mixed $value, bool $serialize = true): bool; |
|
113
|
|
|
|
|
114
|
|
|
|
|
115
|
|
|
/** |
|
116
|
|
|
* Delete all cache data |
|
117
|
|
|
* @param bool $expired |
|
118
|
|
|
* @return bool |
|
119
|
|
|
*/ |
|
120
|
|
|
abstract public function flush(bool $expired = false): bool; |
|
121
|
|
|
} |
|
122
|
|
|
|
platine-php /
template
