DatabaseBackendFactory.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Cache/DatabaseBackendFactory.php
  2. 8.9.x core/lib/Drupal/Core/Cache/DatabaseBackendFactory.php
  3. 11.x core/lib/Drupal/Core/Cache/DatabaseBackendFactory.php

Namespace

Drupal\Core\Cache

File

core/lib/Drupal/Core/Cache/DatabaseBackendFactory.php

View source
<?php

namespace Drupal\Core\Cache;

use Drupal\Component\Datetime\TimeInterface;
use Drupal\Component\Serialization\ObjectAwareSerializationInterface;
use Drupal\Core\Database\Connection;
use Drupal\Core\Site\Settings;
class DatabaseBackendFactory implements CacheFactoryInterface {
    
    /**
     * The database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * The cache tags checksum provider.
     *
     * @var \Drupal\Core\Cache\CacheTagsChecksumInterface
     */
    protected $checksumProvider;
    
    /**
     * Constructs the DatabaseBackendFactory object.
     *
     * @param \Drupal\Core\Database\Connection $connection
     *   Database connection
     * @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
     *   The cache tags checksum provider.
     * @param \Drupal\Core\Site\Settings $settings
     *   (optional) The site settings.
     * @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|null $serializer
     *   (optional) The serializer to use.
     * @param \Drupal\Component\Datetime\TimeInterface|null $time
     *   The time service.
     *
     * @throws \BadMethodCallException
     */
    public function __construct(Connection $connection, CacheTagsChecksumInterface $checksum_provider, ?Settings $settings = NULL, ?ObjectAwareSerializationInterface $serializer = NULL, ?TimeInterface $time = NULL) {
        $this->connection = $connection;
        $this->checksumProvider = $checksum_provider;
        if ($this->settings === NULL) {
            @trigger_error('Calling ' . __METHOD__ . ' without the $settings argument is deprecated in drupal:10.3.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3014684', E_USER_DEPRECATED);
            $this->settings = Settings::getInstance();
        }
        if ($this->serializer === NULL) {
            @trigger_error('Calling ' . __METHOD__ . ' without the $serializer argument is deprecated in drupal:10.3.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3014684', E_USER_DEPRECATED);
            $this->serializer = \Drupal::service('serialization.phpserialize');
        }
        if ($this->time === NULL) {
            @trigger_error('Calling ' . __METHOD__ . '() without the $time argument is deprecated in drupal:10.3.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3387233', E_USER_DEPRECATED);
            $this->time = \Drupal::service(TimeInterface::class);
        }
    }
    
    /**
     * Gets DatabaseBackend for the specified cache bin.
     *
     * @param $bin
     *   The cache bin for which the object is created.
     *
     * @return \Drupal\Core\Cache\DatabaseBackend
     *   The cache backend object for the specified cache bin.
     */
    public function get($bin) {
        $max_rows = $this->getMaxRowsForBin($bin);
        return new DatabaseBackend($this->connection, $this->checksumProvider, $bin, $this->serializer, $this->time, $max_rows);
    }
    
    /**
     * Gets the max rows for the specified cache bin.
     *
     * @param string $bin
     *   The cache bin for which the object is created.
     *
     * @return int
     *   The maximum number of rows for the given bin. Defaults to
     *   DatabaseBackend::DEFAULT_MAX_ROWS.
     */
    protected function getMaxRowsForBin($bin) {
        $max_rows_settings = $this->settings
            ->get('database_cache_max_rows');
        // First, look for a cache bin specific setting.
        if (isset($max_rows_settings['bins'][$bin])) {
            $max_rows = $max_rows_settings['bins'][$bin];
        }
        elseif (isset($max_rows_settings['default'])) {
            $max_rows = $max_rows_settings['default'];
        }
        else {
            // Fall back to the default max rows if nothing else is configured.
            $max_rows = DatabaseBackend::DEFAULT_MAX_ROWS;
        }
        return $max_rows;
    }

}

Classes

Title Deprecated Summary
DatabaseBackendFactory

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