src/Core/Cache/IMemoryCache.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   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;
  23
  24 /**
  25  * This interface defines methods for Memory-Caches only
  26  */
  27 interface IMemoryCache extends ICache
  28 {
  29         /**
  30          * Sets a value if it's not already stored
  31          *
  32          * @param string $key      The cache key
  33          * @param mixed  $value    The old value we know from the cache
  34          * @param int    $ttl      The cache lifespan, must be one of the Cache constants
  35          * @return bool
  36          */
  37         public function add($key, $value, $ttl = Duration::FIVE_MINUTES);
  38
  39         /**
  40          * Compares if the old value is set and sets the new value
  41          *
  42          * @param string $key         The cache key
  43          * @param mixed  $oldValue    The old value we know from the cache
  44          * @param mixed  $newValue    The new value we want to set
  45          * @param int    $ttl             The cache lifespan, must be one of the Cache constants
  46          *
  47          * @return bool
  48          */
  49         public function compareSet($key, $oldValue, $newValue, $ttl = Duration::FIVE_MINUTES);
  50
  51         /**
  52          * Compares if the old value is set and removes it
  53          *
  54          * @param string $key          The cache key
  55          * @param mixed  $value        The old value we know and want to delete
  56          * @return bool
  57          */
  58         public function compareDelete($key, $value);
  59 }