class KeyValueDatabaseFactory

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

Defines the key/value store factory for the database backend.

Hierarchy

Expanded class hierarchy of KeyValueDatabaseFactory

1 string reference to 'KeyValueDatabaseFactory'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses KeyValueDatabaseFactory
keyvalue.database in core/core.services.yml
Drupal\Core\KeyValueStore\KeyValueDatabaseFactory

File

core/lib/Drupal/Core/KeyValueStore/KeyValueDatabaseFactory.php, line 11

Namespace

Drupal\Core\KeyValueStore
View source 
class KeyValueDatabaseFactory implements KeyValueFactoryInterface {
    
    /**
     * The serialization class to use.
     *
     * @var \Drupal\Component\Serialization\SerializationInterface
     */
    protected $serializer;
    
    /**
     * The database connection to use.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * Constructs this factory object.
     *
     * @param \Drupal\Component\Serialization\SerializationInterface $serializer
     *   The serialization class to use.
     * @param \Drupal\Core\Database\Connection $connection
     *   The Connection object containing the key-value tables.
     */
    public function __construct(SerializationInterface $serializer, Connection $connection) {
        $this->serializer = $serializer;
        $this->connection = $connection;
    }
    
    /**
     * {@inheritdoc}
     */
    public function get($collection) {
        return new DatabaseStorage($collection, $this->serializer, $this->connection);
    }

}

Members

Title Modifiers Object type Summary Overriden Title
KeyValueDatabaseFactory::$connection protected property The database connection to use.
KeyValueDatabaseFactory::$serializer protected property The serialization class to use.
KeyValueDatabaseFactory::get public function Constructs a new key/value store for a given collection name. Overrides KeyValueFactoryInterface::get
KeyValueDatabaseFactory::__construct public function Constructs this factory object.

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