function KeyValueStoreExpirableInterface::setWithExpireIfNotExists
Same name in other branches
- 8.9.x core/lib/Drupal/Core/KeyValueStore/KeyValueStoreExpirableInterface.php \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface::setWithExpireIfNotExists()
- 10 core/lib/Drupal/Core/KeyValueStore/KeyValueStoreExpirableInterface.php \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface::setWithExpireIfNotExists()
- 11.x core/lib/Drupal/Core/KeyValueStore/KeyValueStoreExpirableInterface.php \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface::setWithExpireIfNotExists()
Sets a value for a given key with a time to live if it does not yet exist.
If a key is expired it also does not exists.
Parameters
string $key: The key of the data to store.
mixed $value: The data to store.
int $expire: The time to live for items, in seconds.
Return value
bool TRUE if the data was set, or FALSE if it already existed.
2 methods override KeyValueStoreExpirableInterface::setWithExpireIfNotExists()
- DatabaseStorageExpirable::setWithExpireIfNotExists in core/
lib/ Drupal/ Core/ KeyValueStore/ DatabaseStorageExpirable.php - Sets a value for a given key with a time to live if it does not yet exist.
- NullStorageExpirable::setWithExpireIfNotExists in core/
lib/ Drupal/ Core/ KeyValueStore/ NullStorageExpirable.php - Sets a value for a given key with a time to live if it does not yet exist.
File
-
core/
lib/ Drupal/ Core/ KeyValueStore/ KeyValueStoreExpirableInterface.php, line 37
Class
- KeyValueStoreExpirableInterface
- Defines the interface for expiring data in a key/value store.
Namespace
Drupal\Core\KeyValueStoreCode
public function setWithExpireIfNotExists($key, $value, $expire);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.