public function KeyValueStoreExpirableInterface::setWithExpireIfNotExists in Drupal 9

Same name and namespace in other branches

1. 8 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\KeyValueStore

Code

public function setWithExpireIfNotExists($key, $value, $expire);