interface KeyValueExpirableFactoryInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/KeyValueStore/KeyValueExpirableFactoryInterface.php \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface
  2. 10 core/lib/Drupal/Core/KeyValueStore/KeyValueExpirableFactoryInterface.php \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface
  3. 11.x core/lib/Drupal/Core/KeyValueStore/KeyValueExpirableFactoryInterface.php \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface

Defines the expirable key/value store factory interface.

Hierarchy

Expanded class hierarchy of KeyValueExpirableFactoryInterface

All classes that implement KeyValueExpirableFactoryInterface

4 files declare their use of KeyValueExpirableFactoryInterface
DbUpdateController.php in core/modules/system/src/Controller/DbUpdateController.php
FormCache.php in core/lib/Drupal/Core/Form/FormCache.php
PrivateTempStoreFactory.php in core/lib/Drupal/Core/TempStore/PrivateTempStoreFactory.php
SharedTempStoreFactory.php in core/lib/Drupal/Core/TempStore/SharedTempStoreFactory.php

File

core/lib/Drupal/Core/KeyValueStore/KeyValueExpirableFactoryInterface.php, line 8

Namespace

Drupal\Core\KeyValueStore
View source 
interface KeyValueExpirableFactoryInterface {
    
    /**
     * Constructs a new expirable key/value store for a given collection name.
     *
     * @param string $collection
     *   The name of the collection holding key and value pairs.
     *
     * @return \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
     *   An expirable key/value store implementation for the given $collection.
     */
    public function get($collection);

}

Members

Title Modifiers Object type Summary Overrides
KeyValueExpirableFactoryInterface::get public function Constructs a new expirable key/value store for a given collection name. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.