CRM/Utils/Cache/ArrayCache.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  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   const DEFAULT_TIMEOUT = 3600;
  43
  44   /**
  45    * The cache storage container, an in memory array by default
  46    */
  47   protected $_cache;
  48
  49   protected $_expires;
  50
  51   /**
  52    * Constructor.
  53    *
  54    * @param array $config
  55    *   An array of configuration params.
  56    *
  57    * @return \CRM_Utils_Cache_Arraycache
  58    */
  59   public function __construct($config) {
  60     $this->_cache = array();
  61     $this->_expires = array();
  62   }
  63
  64   /**
  65    * @param string $key
  66    * @param mixed $value
  67    * @param null|int|\DateInterval $ttl
  68    * @return bool
  69    * @throws \Psr\SimpleCache\InvalidArgumentException
  70    */
  71   public function set($key, $value, $ttl = NULL) {
  72     CRM_Utils_Cache::assertValidKey($key);
  73     $this->_cache[$key] = $this->reobjectify($value);
  74     $this->_expires[$key] = CRM_Utils_Date::convertCacheTtlToExpires($ttl, self::DEFAULT_TIMEOUT);
  75     return TRUE;
  76   }
  77
  78   /**
  79    * @param string $key
  80    * @param mixed $default
  81    *
  82    * @return mixed
  83    * @throws \Psr\SimpleCache\InvalidArgumentException
  84    */
  85   public function get($key, $default = NULL) {
  86     CRM_Utils_Cache::assertValidKey($key);
  87     if (isset($this->_expires[$key]) && is_numeric($this->_expires[$key]) && $this->_expires[$key] <= time()) {
  88       return $default;
  89     }
  90     if (array_key_exists($key, $this->_cache)) {
  91       return $this->reobjectify($this->_cache[$key]);
  92     }
  93     return $default;
  94   }
  95
  96   /**
  97    * @param string $key
  98    * @return bool
  99    * @throws \Psr\SimpleCache\InvalidArgumentException
 100    */
 101   public function delete($key) {
 102     CRM_Utils_Cache::assertValidKey($key);
 103
 104     unset($this->_cache[$key]);
 105     unset($this->_expires[$key]);
 106     return TRUE;
 107   }
 108
 109   public function flush() {
 110     unset($this->_cache);
 111     unset($this->_expires);
 112     $this->_cache = array();
 113     return TRUE;
 114   }
 115
 116   public function clear() {
 117     return $this->flush();
 118   }
 119
 120   private function reobjectify($value) {
 121     if (is_object($value)) {
 122       return unserialize(serialize($value));
 123     }
 124     if (is_array($value)) {
 125       foreach ($value as $p) {
 126         if (is_object($p)) {
 127           return unserialize(serialize($value));
 128         }
 129       }
 130     }
 131     return $value;
 132   }
 133
 134   /**
 135    * @param string $key
 136    * @return int|null
 137    */
 138   public function getExpires($key) {
 139     return $this->_expires[$key] ?: NULL;
 140   }
 141
 142 }