CRM/Utils/Cache/Memcache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Utils_Cache_Memcache {
  36   const DEFAULT_HOST    = 'localhost';
  37   const DEFAULT_PORT    = 11211;
  38   const DEFAULT_TIMEOUT = 3600;
  39   const DEFAULT_PREFIX  = '';
  40
  41   /**
  42    * The host name of the memcached server
  43    *
  44    * @var string
  45    */
  46   protected $_host = self::DEFAULT_HOST;
  47
  48   /**
  49    * The port on which to connect on
  50    *
  51    * @var int
  52    */
  53   protected $_port = self::DEFAULT_PORT;
  54
  55   /**
  56    * The default timeout to use
  57    *
  58    * @var int
  59    */
  60   protected $_timeout = self::DEFAULT_TIMEOUT;
  61
  62   /**
  63    * The prefix prepended to cache keys.
  64    *
  65    * If we are using the same memcache instance for multiple CiviCRM
  66    * installs, we must have a unique prefix for each install to prevent
  67    * the keys from clobbering each other.
  68    *
  69    * @var string
  70    */
  71   protected $_prefix = self::DEFAULT_PREFIX;
  72
  73   /**
  74    * The actual memcache object
  75    *
  76    * @var resource
  77    */
  78   protected $_cache;
  79
  80   /**
  81    * Constructor
  82    *
  83    * @param array $config an array of configuration params
  84    *
  85    * @return \CRM_Utils_Cache_Memcache
  86    */
  87   function __construct($config) {
  88     if (isset($config['host'])) {
  89       $this->_host = $config['host'];
  90     }
  91     if (isset($config['port'])) {
  92       $this->_port = $config['port'];
  93     }
  94     if (isset($config['timeout'])) {
  95       $this->_timeout = $config['timeout'];
  96     }
  97     if (isset($config['prefix'])) {
  98       $this->_prefix = $config['prefix'];
  99     }
 100
 101     $this->_cache = new Memcache();
 102
 103     if (!$this->_cache->connect($this->_host, $this->_port)) {
 104       // dont use fatal here since we can go in an infinite loop
 105       echo 'Could not connect to Memcached server';
 106       CRM_Utils_System::civiExit();
 107     }
 108   }
 109
 110   /**
 111    * @param $key
 112    * @param $value
 113    *
 114    * @return bool
 115    */
 116   function set($key, &$value) {
 117     if (!$this->_cache->set($this->_prefix . $key, $value, FALSE, $this->_timeout)) {
 118       return FALSE;
 119     }
 120     return TRUE;
 121   }
 122
 123   /**
 124    * @param $key
 125    *
 126    * @return mixed
 127    */
 128   function &get($key) {
 129     $result = $this->_cache->get($this->_prefix . $key);
 130     return $result;
 131   }
 132
 133   /**
 134    * @param $key
 135    *
 136    * @return mixed
 137    */
 138   function delete($key) {
 139     return $this->_cache->delete($this->_prefix . $key);
 140   }
 141
 142   /**
 143    * @return mixed
 144    */
 145   function flush() {
 146     return $this->_cache->flush();
 147   }
 148 }
 149