3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * Cache is an empty base object, we'll modify the scheme when we have different caching schemes
40 class CRM_Utils_Cache
{
42 * We only need one instance of this object. So we use the singleton
43 * pattern and cache the instance in this variable
48 static private $_singleton = NULL;
53 * @param array $config an array of configuration params
55 * @return \CRM_Utils_Cache
57 function __construct(&$config) {
58 CRM_Core_Error
::fatal(ts('this is just an interface and should not be called directly'));
62 * singleton function used to manage this object
68 static function &singleton() {
69 if (self
::$_singleton === NULL) {
70 $className = 'ArrayCache'; // default to ArrayCache for now
72 // Maintain backward compatibility for now.
73 // Setting CIVICRM_USE_MEMCACHE or CIVICRM_USE_ARRAYCACHE will
74 // override the CIVICRM_DB_CACHE_CLASS setting.
75 // Going forward, CIVICRM_USE_xxxCACHE should be deprecated.
76 if (defined('CIVICRM_USE_MEMCACHE') && CIVICRM_USE_MEMCACHE
) {
77 $className = 'Memcache';
79 else if (defined('CIVICRM_USE_ARRAYCACHE') && CIVICRM_USE_ARRAYCACHE
) {
80 $className = 'ArrayCache';
82 else if (defined('CIVICRM_DB_CACHE_CLASS') && CIVICRM_DB_CACHE_CLASS
) {
83 $className = CIVICRM_DB_CACHE_CLASS
;
86 // a generic method for utilizing any of the available db caches.
87 $dbCacheClass = 'CRM_Utils_Cache_' . $className;
88 require_once(str_replace('_', DIRECTORY_SEPARATOR
, $dbCacheClass) . '.php');
89 $settings = self
::getCacheSettings($className);
90 self
::$_singleton = new $dbCacheClass($settings);
92 return self
::$_singleton;
96 * Get cache relevant settings
101 * associative array of settings for the cache
104 static function getCacheSettings($cachePlugin) {
105 switch ($cachePlugin) {
114 'host' => 'localhost',
120 // Use old constants if needed to ensure backward compatability
121 if (defined('CIVICRM_MEMCACHE_HOST')) {
122 $defaults['host'] = CIVICRM_MEMCACHE_HOST
;
125 if (defined('CIVICRM_MEMCACHE_PORT')) {
126 $defaults['port'] = CIVICRM_MEMCACHE_PORT
;
129 if (defined('CIVICRM_MEMCACHE_TIMEOUT')) {
130 $defaults['timeout'] = CIVICRM_MEMCACHE_TIMEOUT
;
133 if (defined('CIVICRM_MEMCACHE_PREFIX')) {
134 $defaults['prefix'] = CIVICRM_MEMCACHE_PREFIX
;
137 // Use new constants if possible
138 if (defined('CIVICRM_DB_CACHE_HOST')) {
139 $defaults['host'] = CIVICRM_DB_CACHE_HOST
;
142 if (defined('CIVICRM_DB_CACHE_PORT')) {
143 $defaults['port'] = CIVICRM_DB_CACHE_PORT
;
146 if (defined('CIVICRM_DB_CACHE_TIMEOUT')) {
147 $defaults['timeout'] = CIVICRM_DB_CACHE_TIMEOUT
;
150 if (defined('CIVICRM_DB_CACHE_PREFIX')) {
151 $defaults['prefix'] = CIVICRM_DB_CACHE_PREFIX
;
158 if (defined('CIVICRM_DB_CACHE_TIMEOUT')) {
159 $defaults['timeout'] = CIVICRM_DB_CACHE_TIMEOUT
;
161 if (defined('CIVICRM_DB_CACHE_PREFIX')) {
162 $defaults['prefix'] = CIVICRM_DB_CACHE_PREFIX
;