class NullStorageExpirable
Same name in other branches
- 8.9.x core/lib/Drupal/Core/KeyValueStore/NullStorageExpirable.php \Drupal\Core\KeyValueStore\NullStorageExpirable
- 10 core/lib/Drupal/Core/KeyValueStore/NullStorageExpirable.php \Drupal\Core\KeyValueStore\NullStorageExpirable
- 11.x core/lib/Drupal/Core/KeyValueStore/NullStorageExpirable.php \Drupal\Core\KeyValueStore\NullStorageExpirable
Defines a null key/value store implementation.
Hierarchy
- class \Drupal\Core\KeyValueStore\NullStorageExpirable implements \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
Expanded class hierarchy of NullStorageExpirable
File
-
core/
lib/ Drupal/ Core/ KeyValueStore/ NullStorageExpirable.php, line 8
Namespace
Drupal\Core\KeyValueStoreView source
class NullStorageExpirable implements KeyValueStoreExpirableInterface {
/**
* The actual storage of key-value pairs.
*
* @var array
*/
protected $data = [];
/**
* The name of the collection holding key and value pairs.
*
* @var string
*/
protected $collection;
/**
* Creates a new expirable null key/value store.
*/
public function __construct($collection) {
$this->collection = $collection;
}
/**
* {@inheritdoc}
*/
public function has($key) {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function get($key, $default = NULL) {
return NULL;
}
/**
* {@inheritdoc}
*/
public function getMultiple(array $keys) {
return [];
}
/**
* {@inheritdoc}
*/
public function getAll() {
return [];
}
/**
* {@inheritdoc}
*/
public function set($key, $value) {
}
/**
* {@inheritdoc}
*/
public function setIfNotExists($key, $value) {
}
/**
* {@inheritdoc}
*/
public function setMultiple(array $data) {
}
/**
* {@inheritdoc}
*/
public function rename($key, $new_key) {
}
/**
* {@inheritdoc}
*/
public function delete($key) {
}
/**
* {@inheritdoc}
*/
public function deleteMultiple(array $keys) {
}
/**
* {@inheritdoc}
*/
public function deleteAll() {
}
/**
* {@inheritdoc}
*/
public function getCollectionName() {
return $this->collection;
}
/**
* {@inheritdoc}
*/
public function setMultipleWithExpire(array $data, $expire) {
}
/**
* {@inheritdoc}
*/
public function setWithExpire($key, $value, $expire) {
}
/**
* {@inheritdoc}
*/
public function setWithExpireIfNotExists($key, $value, $expire) {
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
NullStorageExpirable::$collection | protected | property | The name of the collection holding key and value pairs. | |
NullStorageExpirable::$data | protected | property | The actual storage of key-value pairs. | |
NullStorageExpirable::delete | public | function | Deletes an item from the key/value store. | Overrides KeyValueStoreInterface::delete |
NullStorageExpirable::deleteAll | public | function | Deletes all items from the key/value store. | Overrides KeyValueStoreInterface::deleteAll |
NullStorageExpirable::deleteMultiple | public | function | Deletes multiple items from the key/value store. | Overrides KeyValueStoreInterface::deleteMultiple |
NullStorageExpirable::get | public | function | Returns the stored value for a given key. | Overrides KeyValueStoreInterface::get |
NullStorageExpirable::getAll | public | function | Returns all stored key/value pairs in the collection. | Overrides KeyValueStoreInterface::getAll |
NullStorageExpirable::getCollectionName | public | function | Returns the name of this collection. | Overrides KeyValueStoreInterface::getCollectionName |
NullStorageExpirable::getMultiple | public | function | Returns the stored key/value pairs for a given set of keys. | Overrides KeyValueStoreInterface::getMultiple |
NullStorageExpirable::has | public | function | Returns whether a given key exists in the store. | Overrides KeyValueStoreInterface::has |
NullStorageExpirable::rename | public | function | Renames a key. | Overrides KeyValueStoreInterface::rename |
NullStorageExpirable::set | public | function | Saves a value for a given key. | Overrides KeyValueStoreInterface::set |
NullStorageExpirable::setIfNotExists | public | function | Saves a value for a given key if it does not exist yet. | Overrides KeyValueStoreInterface::setIfNotExists |
NullStorageExpirable::setMultiple | public | function | Saves key/value pairs. | Overrides KeyValueStoreInterface::setMultiple |
NullStorageExpirable::setMultipleWithExpire | public | function | Saves an array of values with a time to live. | Overrides KeyValueStoreExpirableInterface::setMultipleWithExpire |
NullStorageExpirable::setWithExpire | public | function | Saves a value for a given key with a time to live. | Overrides KeyValueStoreExpirableInterface::setWithExpire |
NullStorageExpirable::setWithExpireIfNotExists | public | function | Sets a value for a given key with a time to live if it does not yet exist. | Overrides KeyValueStoreExpirableInterface::setWithExpireIfNotExists |
NullStorageExpirable::__construct | public | function | Creates a new expirable null key/value store. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.