src/Core/Cache/Capability/ICanCacheInMemory.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\Capability;
  23
  24 use Friendica\Core\Cache\Enum\Duration;
  25 use Friendica\Core\Cache\Exception\CachePersistenceException;
  26
  27 /**
  28  * This interface defines methods for Memory-Caches only
  29  */
  30 interface ICanCacheInMemory extends ICanCache
  31 {
  32         /**
  33          * Sets a value if it's not already stored
  34          *
  35          * @param string $key   The cache key
  36          * @param mixed  $value The old value we know from the cache
  37          * @param int    $ttl   The cache lifespan, must be one of the Cache constants
  38          *
  39          * @return bool
  40          *
  41          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  42          */
  43         public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool;
  44
  45         /**
  46          * Compares if the old value is set and sets the new value
  47          *
  48          * @param string $key      The cache key
  49          * @param mixed  $oldValue The old value we know from the cache
  50          * @param mixed  $newValue The new value we want to set
  51          * @param int    $ttl      The cache lifespan, must be one of the Cache constants
  52          *
  53          * @return bool
  54          *
  55          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  56          */
  57         public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool;
  58
  59         /**
  60          * Compares if the old value is set and removes it
  61          *
  62          * @param string $key   The cache key
  63          * @param mixed  $value The old value we know and want to delete
  64          *
  65          * @return bool
  66          *
  67          * @throws CachePersistenceException In case the underlying cache driver has errors during persistence
  68          */
  69         public function compareDelete(string $key, $value): bool;
  70 }