interface KeyValueStoreExpirableInterface

Defines the interface for expiring data in a key/value store.

Hierarchy

Expanded class hierarchy of KeyValueStoreExpirableInterface

All classes that implement KeyValueStoreExpirableInterface

1 file declares its use of KeyValueStoreExpirableInterface
TempStore.php in drupal/core/modules/user/lib/Drupal/user/TempStore.php
Contains Drupal\user\TempStore.

File

drupal/core/lib/Drupal/Core/KeyValueStore/KeyValueStoreExpirableInterface.php, line 13
Contains Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface.

Namespace

Drupal\Core\KeyValueStore
View source
interface KeyValueStoreExpirableInterface extends KeyValueStoreInterface {

  /**
   * Saves a value for a given key with a time to live.
   *
   * @param string $key
   *   The key of the data to store.
   * @param mixed $value
   *   The data to store.
   * @param int $expire
   *   The time to live for items, in seconds.
   */
  function setWithExpire($key, $value, $expire);

  /**
   * Sets a value for a given key with a time to live if it does not yet exist.
   *
   * @param string $key
   *   The key of the data to store.
   * @param mixed $value
   *   The data to store.
   * @param int $expire
   *   The time to live for items, in seconds.
   *
   * @return bool
   *   TRUE if the data was set, or FALSE if it already existed.
   */
  function setWithExpireIfNotExists($key, $value, $expire);

  /**
   * Saves an array of values with a time to live.
   *
   * @param array $data
   *   An array of data to store.
   * @param int $expire
   *   The time to live for items, in seconds.
   */
  function setMultipleWithExpire(array $data, $expire);

}

Members

Namesort descending Modifiers Type Description Overrides
KeyValueStoreExpirableInterface::setMultipleWithExpire function Saves an array of values with a time to live. 2
KeyValueStoreExpirableInterface::setWithExpire function Saves a value for a given key with a time to live. 2
KeyValueStoreExpirableInterface::setWithExpireIfNotExists function Sets a value for a given key with a time to live if it does not yet exist. 2
KeyValueStoreInterface::delete public function Deletes an item from the key/value store. 2
KeyValueStoreInterface::deleteAll public function Deletes all items from the key/value store. 3
KeyValueStoreInterface::deleteMultiple public function Deletes multiple items from the key/value store. 3
KeyValueStoreInterface::get public function Returns the stored value for a given key. 2
KeyValueStoreInterface::getAll public function Returns all stored key/value pairs in the collection. 3
KeyValueStoreInterface::getCollectionName public function Returns the name of this collection. 2
KeyValueStoreInterface::getMultiple public function Returns the stored key/value pairs for a given set of keys. 3
KeyValueStoreInterface::set public function Saves a value for a given key. 3
KeyValueStoreInterface::setIfNotExists public function Saves a value for a given key if it does not exist yet. 3
KeyValueStoreInterface::setMultiple public function Saves key/value pairs. 2