src/Core/Cache/Type/ArrayCache.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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         use CompareDeleteTrait;
  33
  34         /** @var array Array with the cached data */
  35         protected $cachedData = [];
  36
  37         /**
  38          * (@inheritdoc)
  39          */
  40         public function getAllKeys(?string $prefix = null): array
  41         {
  42                 return $this->filterArrayKeysByPrefix(array_keys($this->cachedData), $prefix);
  43         }
  44
  45         /**
  46          * (@inheritdoc)
  47          */
  48         public function get(string $key)
  49         {
  50                 if (isset($this->cachedData[$key])) {
  51                         return $this->cachedData[$key];
  52                 }
  53                 return null;
  54         }
  55
  56         /**
  57          * (@inheritdoc)
  58          */
  59         public function set(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool
  60         {
  61                 $this->cachedData[$key] = $value;
  62                 return true;
  63         }
  64
  65         /**
  66          * (@inheritdoc)
  67          */
  68         public function delete(string $key): bool
  69         {
  70                 unset($this->cachedData[$key]);
  71                 return true;
  72         }
  73
  74         /**
  75          * (@inheritdoc)
  76          */
  77         public function clear(bool $outdated = true): bool
  78         {
  79                 // Array doesn't support TTL so just don't delete something
  80                 if ($outdated) {
  81                         return true;
  82                 }
  83
  84                 $this->cachedData = [];
  85                 return true;
  86         }
  87
  88         /**
  89          * (@inheritdoc)
  90          */
  91         public function add(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool
  92         {
  93                 if (isset($this->cachedData[$key])) {
  94                         return false;
  95                 } else {
  96                         return $this->set($key, $value, $ttl);
  97                 }
  98         }
  99
 100         /**
 101          * (@inheritdoc)
 102          */
 103         public function compareSet(string $key, $oldValue, $newValue, int $ttl = Enum\Duration::FIVE_MINUTES): bool
 104         {
 105                 if ($this->get($key) === $oldValue) {
 106                         return $this->set($key, $newValue);
 107                 } else {
 108                         return false;
 109                 }
 110         }
 111
 112         /**
 113          * {@inheritDoc}
 114          */
 115         public function getName(): string
 116         {
 117                 return Enum\Type::ARRAY;
 118         }
 119 }