3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
54 * An array of configuration params.
56 * @return \CRM_Utils_Cache
58 public function __construct(&$config) {
59 CRM_Core_Error
::fatal(ts('this is just an interface and should not be called directly'));
63 * Singleton function used to manage this object
69 public static function &singleton() {
70 if (self
::$_singleton === NULL) {
71 $className = 'ArrayCache'; // default to ArrayCache for now
73 // Maintain backward compatibility for now.
74 // Setting CIVICRM_USE_MEMCACHE or CIVICRM_USE_ARRAYCACHE will
75 // override the CIVICRM_DB_CACHE_CLASS setting.
76 // Going forward, CIVICRM_USE_xxxCACHE should be deprecated.
77 if (defined('CIVICRM_USE_MEMCACHE') && CIVICRM_USE_MEMCACHE
) {
78 $className = 'Memcache';
80 elseif (defined('CIVICRM_USE_ARRAYCACHE') && CIVICRM_USE_ARRAYCACHE
) {
81 $className = 'ArrayCache';
83 elseif (defined('CIVICRM_DB_CACHE_CLASS') && CIVICRM_DB_CACHE_CLASS
) {
84 $className = CIVICRM_DB_CACHE_CLASS
;
87 // a generic method for utilizing any of the available db caches.
88 $dbCacheClass = 'CRM_Utils_Cache_' . $className;
89 require_once str_replace('_', DIRECTORY_SEPARATOR
, $dbCacheClass) . '.php';
90 $settings = self
::getCacheSettings($className);
91 self
::$_singleton = new $dbCacheClass($settings);
93 return self
::$_singleton;
97 * Get cache relevant settings
102 * associative array of settings for the cache
105 public static function getCacheSettings($cachePlugin) {
106 switch ($cachePlugin) {
115 'host' => 'localhost',
121 // Use old constants if needed to ensure backward compatability
122 if (defined('CIVICRM_MEMCACHE_HOST')) {
123 $defaults['host'] = CIVICRM_MEMCACHE_HOST
;
126 if (defined('CIVICRM_MEMCACHE_PORT')) {
127 $defaults['port'] = CIVICRM_MEMCACHE_PORT
;
130 if (defined('CIVICRM_MEMCACHE_TIMEOUT')) {
131 $defaults['timeout'] = CIVICRM_MEMCACHE_TIMEOUT
;
134 if (defined('CIVICRM_MEMCACHE_PREFIX')) {
135 $defaults['prefix'] = CIVICRM_MEMCACHE_PREFIX
;
138 // Use new constants if possible
139 if (defined('CIVICRM_DB_CACHE_HOST')) {
140 $defaults['host'] = CIVICRM_DB_CACHE_HOST
;
143 if (defined('CIVICRM_DB_CACHE_PORT')) {
144 $defaults['port'] = CIVICRM_DB_CACHE_PORT
;
147 if (defined('CIVICRM_DB_CACHE_TIMEOUT')) {
148 $defaults['timeout'] = CIVICRM_DB_CACHE_TIMEOUT
;
151 if (defined('CIVICRM_DB_CACHE_PREFIX')) {
152 $defaults['prefix'] = CIVICRM_DB_CACHE_PREFIX
;
159 if (defined('CIVICRM_DB_CACHE_TIMEOUT')) {
160 $defaults['timeout'] = CIVICRM_DB_CACHE_TIMEOUT
;
162 if (defined('CIVICRM_DB_CACHE_PREFIX')) {
163 $defaults['prefix'] = CIVICRM_DB_CACHE_PREFIX
;