KeyValueFactoryInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/KeyValueStore/KeyValueFactoryInterface.php
  2. 10 core/lib/Drupal/Core/KeyValueStore/KeyValueFactoryInterface.php
  3. 11.x core/lib/Drupal/Core/KeyValueStore/KeyValueFactoryInterface.php

Namespace

Drupal\Core\KeyValueStore

File

core/lib/Drupal/Core/KeyValueStore/KeyValueFactoryInterface.php

View source
<?php

namespace Drupal\Core\KeyValueStore;


/**
 * Defines the key/value store factory interface.
 */
interface KeyValueFactoryInterface {
    
    /**
     * Constructs a new 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\KeyValueStoreInterface
     *   A key/value store implementation for the given $collection.
     */
    public function get($collection);

}

Interfaces

Title Deprecated Summary
KeyValueFactoryInterface Defines the key/value store factory interface.

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