3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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
47 static private $_singleton = NULL;
52 * @param array $config
53 * An array of configuration params.
55 * @return \CRM_Utils_Cache
57 public 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.
66 public static function &singleton() {
67 if (self
::$_singleton === NULL) {
68 $className = 'ArrayCache'; // default to ArrayCache for now
70 // Maintain backward compatibility for now.
71 // Setting CIVICRM_USE_MEMCACHE or CIVICRM_USE_ARRAYCACHE will
72 // override the CIVICRM_DB_CACHE_CLASS setting.
73 // Going forward, CIVICRM_USE_xxxCACHE should be deprecated.
74 if (defined('CIVICRM_USE_MEMCACHE') && CIVICRM_USE_MEMCACHE
) {
75 $className = 'Memcache';
77 elseif (defined('CIVICRM_USE_ARRAYCACHE') && CIVICRM_USE_ARRAYCACHE
) {
78 $className = 'ArrayCache';
80 elseif (defined('CIVICRM_DB_CACHE_CLASS') && CIVICRM_DB_CACHE_CLASS
) {
81 $className = CIVICRM_DB_CACHE_CLASS
;
84 // a generic method for utilizing any of the available db caches.
85 $dbCacheClass = 'CRM_Utils_Cache_' . $className;
86 require_once str_replace('_', DIRECTORY_SEPARATOR
, $dbCacheClass) . '.php';
87 $settings = self
::getCacheSettings($className);
88 self
::$_singleton = new $dbCacheClass($settings);
90 return self
::$_singleton;
94 * Get cache relevant settings.
99 * associative array of settings for the cache
101 public static function getCacheSettings($cachePlugin) {
102 switch ($cachePlugin) {
111 'host' => 'localhost',
117 // Use old constants if needed to ensure backward compatability
118 if (defined('CIVICRM_MEMCACHE_HOST')) {
119 $defaults['host'] = CIVICRM_MEMCACHE_HOST
;
122 if (defined('CIVICRM_MEMCACHE_PORT')) {
123 $defaults['port'] = CIVICRM_MEMCACHE_PORT
;
126 if (defined('CIVICRM_MEMCACHE_TIMEOUT')) {
127 $defaults['timeout'] = CIVICRM_MEMCACHE_TIMEOUT
;
130 if (defined('CIVICRM_MEMCACHE_PREFIX')) {
131 $defaults['prefix'] = CIVICRM_MEMCACHE_PREFIX
;
134 // Use new constants if possible
135 if (defined('CIVICRM_DB_CACHE_HOST')) {
136 $defaults['host'] = CIVICRM_DB_CACHE_HOST
;
139 if (defined('CIVICRM_DB_CACHE_PORT')) {
140 $defaults['port'] = CIVICRM_DB_CACHE_PORT
;
143 if (defined('CIVICRM_DB_CACHE_TIMEOUT')) {
144 $defaults['timeout'] = CIVICRM_DB_CACHE_TIMEOUT
;
147 if (defined('CIVICRM_DB_CACHE_PREFIX')) {
148 $defaults['prefix'] = CIVICRM_DB_CACHE_PREFIX
;
155 if (defined('CIVICRM_DB_CACHE_TIMEOUT')) {
156 $defaults['timeout'] = CIVICRM_DB_CACHE_TIMEOUT
;
158 if (defined('CIVICRM_DB_CACHE_PREFIX')) {
159 $defaults['prefix'] = CIVICRM_DB_CACHE_PREFIX
;