class DatabaseBackendFactory in Drupal 9

Hierarchy

• class \Drupal\Core\Cache\DatabaseBackendFactory implements CacheFactoryInterface

2 files declare their use of DatabaseBackendFactory

DatabaseBackendFactoryTest.php in core/tests/Drupal/Tests/Core/Cache/DatabaseBackendFactoryTest.php

EndOfTransactionQueriesTest.php in core/tests/Drupal/KernelTests/Core/Cache/EndOfTransactionQueriesTest.php

1 string reference to 'DatabaseBackendFactory'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses DatabaseBackendFactory

cache.backend.database in core/core.services.yml

Drupal\Core\Cache\DatabaseBackendFactory

File

core/lib/Drupal/Core/Cache/DatabaseBackendFactory.php, line 8

Namespace

Drupal\Core\Cache

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;

  /**
   * The site settings.
   *
   * @var \Drupal\Core\Site\Settings
   */
  protected $settings;

  /**
   * 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.
   *
   * @throws \BadMethodCallException
   */
  public function __construct(Connection $connection, CacheTagsChecksumInterface $checksum_provider, Settings $settings = NULL) {
    $this->connection = $connection;
    $this->checksumProvider = $checksum_provider;
    $this->settings = $settings ?: Settings::getInstance();
  }

  /**
   * 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, $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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DatabaseBackendFactory::$checksumProvider	protected	property	The cache tags checksum provider.
DatabaseBackendFactory::$connection	protected	property	The database connection.
DatabaseBackendFactory::$settings	protected	property	The site settings.
DatabaseBackendFactory::get	public	function	Gets DatabaseBackend for the specified cache bin. Overrides CacheFactoryInterface::get
DatabaseBackendFactory::getMaxRowsForBin	protected	function	Gets the max rows for the specified cache bin.
DatabaseBackendFactory::__construct	public	function	Constructs the DatabaseBackendFactory object.