Commit | Line | Data |
---|---|---|
7f254ad8 AE |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.6 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2015 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2015 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | class CRM_Utils_Cache_APCcache { | |
36 | const DEFAULT_TIMEOUT = 3600; | |
37 | const DEFAULT_PREFIX = ''; | |
38 | ||
39 | /** | |
40 | * The default timeout to use. | |
41 | * | |
42 | * @var int | |
43 | */ | |
44 | protected $_timeout = self::DEFAULT_TIMEOUT; | |
45 | ||
46 | /** | |
47 | * The prefix prepended to cache keys. | |
48 | * | |
49 | * If we are using the same memcache instance for multiple CiviCRM | |
50 | * installs, we must have a unique prefix for each install to prevent | |
51 | * the keys from clobbering each other. | |
52 | * | |
53 | * @var string | |
54 | */ | |
55 | protected $_prefix = self::DEFAULT_PREFIX; | |
56 | ||
57 | /** | |
58 | * Constructor. | |
59 | * | |
60 | * @param array $config | |
61 | * An array of configuration params. | |
62 | * | |
63 | * @return \CRM_Utils_Cache_APCcache | |
64 | */ | |
65 | public function __construct(&$config) { | |
66 | if (isset($config['timeout'])) { | |
67 | $this->_timeout = intval($config['timeout']); | |
68 | } | |
69 | if (isset($config['prefix'])) { | |
70 | $this->_prefix = $config['prefix']; | |
71 | } | |
72 | } | |
73 | ||
74 | /** | |
75 | * @param $key | |
76 | * @param $value | |
77 | * | |
78 | * @return bool | |
79 | */ | |
80 | public function set($key, &$value) { | |
81 | if (!apc_store($this->_prefix . $key, $value, $this->_timeout)) { | |
82 | return FALSE; | |
83 | } | |
84 | return TRUE; | |
85 | } | |
86 | ||
87 | /** | |
88 | * @param $key | |
89 | * | |
90 | * @return mixed | |
91 | */ | |
92 | public function &get($key) { | |
93 | return apc_fetch($this->_prefix . $key); | |
94 | } | |
95 | ||
96 | /** | |
97 | * @param $key | |
98 | * | |
99 | * @return bool|string[] | |
100 | */ | |
101 | public function delete($key) { | |
102 | return apc_delete($this->_prefix . $key); | |
103 | } | |
104 | ||
105 | public function flush() { | |
106 | $allinfo = apc_cache_info('user'); | |
107 | $keys = $allinfo['cache_list']; | |
108 | $prefix = $this->_prefix . "CRM_"; // Our keys follows this pattern: ([A-Za-z0-9_]+)?CRM_[A-Za-z0-9_]+ | |
109 | $lp = strlen($prefix); // Get prefix length | |
110 | ||
111 | foreach ($keys as $key) { | |
112 | $name = $key['info']; | |
113 | if ($prefix == substr($name, 0, $lp)) { | |
114 | // Ours? | |
115 | apc_delete($this->_prefix . $name); | |
116 | } | |
117 | } | |
118 | } | |
119 | ||
120 | } |