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