3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Utils_Cache_Memcache
implements CRM_Utils_Cache_Interface
{
35 use CRM_Utils_Cache_NaiveMultipleTrait
; // TODO Consider native implementation.
37 const DEFAULT_HOST
= 'localhost';
38 const DEFAULT_PORT
= 11211;
39 const DEFAULT_TIMEOUT
= 3600;
40 const DEFAULT_PREFIX
= '';
43 * The host name of the memcached server.
47 protected $_host = self
::DEFAULT_HOST
;
50 * The port on which to connect on.
54 protected $_port = self
::DEFAULT_PORT
;
57 * The default timeout to use.
61 protected $_timeout = self
::DEFAULT_TIMEOUT
;
64 * The prefix prepended to cache keys.
66 * If we are using the same memcache instance for multiple CiviCRM
67 * installs, we must have a unique prefix for each install to prevent
68 * the keys from clobbering each other.
72 protected $_prefix = self
::DEFAULT_PREFIX
;
75 * The actual memcache object.
84 * @param array $config
85 * An array of configuration params.
87 * @return \CRM_Utils_Cache_Memcache
89 public function __construct($config) {
90 if (isset($config['host'])) {
91 $this->_host
= $config['host'];
93 if (isset($config['port'])) {
94 $this->_port
= $config['port'];
96 if (isset($config['timeout'])) {
97 $this->_timeout
= $config['timeout'];
99 if (isset($config['prefix'])) {
100 $this->_prefix
= $config['prefix'];
103 $this->_cache
= new Memcache();
105 if (!$this->_cache
->connect($this->_host
, $this->_port
)) {
106 // dont use fatal here since we can go in an infinite loop
107 echo 'Could not connect to Memcached server';
108 CRM_Utils_System
::civiExit();
115 * @param null|int|\DateInterval $ttl
119 public function set($key, $value, $ttl = NULL) {
121 throw new \
RuntimeException("FIXME: " . __CLASS__
. "::set() should support non-NULL TTL");
123 if (!$this->_cache
->set($this->_prefix
. $key, $value, FALSE, $this->_timeout
)) {
131 * @param mixed $default
135 public function get($key, $default = NULL) {
136 if ($default !== NULL) {
137 throw new \
RuntimeException("FIXME: " . __CLASS__
. "::get() only supports NULL default");
139 $result = $this->_cache
->get($this->_prefix
. $key);
148 public function delete($key) {
149 return $this->_cache
->delete($this->_prefix
. $key);
155 public function flush() {
156 // FIXME: Only delete items matching `$this->_prefix`.
157 return $this->_cache
->flush();