CRM/Utils/Cache/ArrayCache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * Class CRM_Utils_Cache_Arraycache
  36  */
  37 class CRM_Utils_Cache_Arraycache implements CRM_Utils_Cache_Interface {
  38
  39   use CRM_Utils_Cache_NaiveMultipleTrait;
  40   use CRM_Utils_Cache_NaiveHasTrait; // TODO Native implementation
  41
  42   /**
  43    * The cache storage container, an in memory array by default
  44    */
  45   protected $_cache;
  46
  47   /**
  48    * Constructor.
  49    *
  50    * @param array $config
  51    *   An array of configuration params.
  52    *
  53    * @return \CRM_Utils_Cache_Arraycache
  54    */
  55   public function __construct($config) {
  56     $this->_cache = array();
  57   }
  58
  59   /**
  60    * @param string $key
  61    * @param mixed $value
  62    * @param null|int|\DateInterval $ttl
  63    * @return bool
  64    */
  65   public function set($key, $value, $ttl = NULL) {
  66     if ($ttl !== NULL) {
  67       throw new \RuntimeException("FIXME: " . __CLASS__ . "::set() should support non-NULL TTL");
  68     }
  69     $this->_cache[$key] = $value;
  70     return TRUE;
  71   }
  72
  73   /**
  74    * @param string $key
  75    * @param mixed $default
  76    *
  77    * @return mixed
  78    */
  79   public function get($key, $default = NULL) {
  80     return CRM_Utils_Array::value($key, $this->_cache, $default);
  81   }
  82
  83   /**
  84    * @param string $key
  85    * @return bool
  86    */
  87   public function delete($key) {
  88     unset($this->_cache[$key]);
  89     return TRUE;
  90   }
  91
  92   public function flush() {
  93     unset($this->_cache);
  94     $this->_cache = array();
  95     return TRUE;
  96   }
  97
  98   public function clear() {
  99     return $this->flush();
 100   }
 101
 102 }