KeyValueDatabaseFactory.php

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

Namespace

Drupal\Core\KeyValueStore

File

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

View source
<?php

namespace Drupal\Core\KeyValueStore;

use Drupal\Component\Serialization\SerializationInterface;
use Drupal\Core\Database\Connection;

/**
 * Defines the key/value store factory for the database backend.
 */
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);
    }

}

Classes

Title Deprecated Summary
KeyValueDatabaseFactory Defines the key/value store factory for the database backend.

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