src/Core/Cache/Type/ArrayCache.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Cache\Type;
  23
  24 use Friendica\Core\Cache\Capability\ICanCacheInMemory;
  25 use Friendica\Core\Cache\Enum;
  26
  27 /**
  28  * Implementation of the IMemoryCache mainly for testing purpose
  29  */
  30 class ArrayCache extends AbstractCache implements ICanCacheInMemory
  31 {
  32         public static $NAME = 'array';
  33
  34         use CompareDeleteTrait;
  35
  36         /** @var array Array with the cached data */
  37         protected $cachedData = [];
  38
  39         /**
  40          * (@inheritdoc)
  41          */
  42         public function getAllKeys(?string $prefix = null): array
  43         {
  44                 return $this->filterArrayKeysByPrefix(array_keys($this->cachedData), $prefix);
  45         }
  46
  47         /**
  48          * (@inheritdoc)
  49          */
  50         public function get(string $key)
  51         {
  52                 if (isset($this->cachedData[$key])) {
  53                         return $this->cachedData[$key];
  54                 }
  55                 return null;
  56         }
  57
  58         /**
  59          * (@inheritdoc)
  60          */
  61         public function set(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool
  62         {
  63                 $this->cachedData[$key] = $value;
  64                 return true;
  65         }
  66
  67         /**
  68          * (@inheritdoc)
  69          */
  70         public function delete(string $key): bool
  71         {
  72                 unset($this->cachedData[$key]);
  73                 return true;
  74         }
  75
  76         /**
  77          * (@inheritdoc)
  78          */
  79         public function clear(bool $outdated = true): bool
  80         {
  81                 // Array doesn't support TTL so just don't delete something
  82                 if ($outdated) {
  83                         return true;
  84                 }
  85
  86                 $this->cachedData = [];
  87                 return true;
  88         }
  89
  90         /**
  91          * (@inheritdoc)
  92          */
  93         public function add(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool
  94         {
  95                 if (isset($this->cachedData[$key])) {
  96                         return false;
  97                 } else {
  98                         return $this->set($key, $value, $ttl);
  99                 }
 100         }
 101
 102         /**
 103          * (@inheritdoc)
 104          */
 105         public function compareSet(string $key, $oldValue, $newValue, int $ttl = Enum\Duration::FIVE_MINUTES): bool
 106         {
 107                 if ($this->get($key) === $oldValue) {
 108                         return $this->set($key, $newValue);
 109                 } else {
 110                         return false;
 111                 }
 112         }
 113 }