class DatabaseCacheTagsChecksum in Drupal 8
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php \Drupal\Core\Cache\DatabaseCacheTagsChecksum
- 10 core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php \Drupal\Core\Cache\DatabaseCacheTagsChecksum
Cache tags invalidations checksum implementation that uses the database.
Hierarchy
- class \Drupal\Core\Cache\DatabaseCacheTagsChecksum implements CacheTagsChecksumInterface, CacheTagsInvalidatorInterface uses CacheTagsChecksumTrait
Expanded class hierarchy of DatabaseCacheTagsChecksum
1 string reference to 'DatabaseCacheTagsChecksum'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses DatabaseCacheTagsChecksum
File
- core/
lib/ Drupal/ Core/ Cache/ DatabaseCacheTagsChecksum.php, line 11
Namespace
Drupal\Core\CacheView source
class DatabaseCacheTagsChecksum implements CacheTagsChecksumInterface, CacheTagsInvalidatorInterface {
use CacheTagsChecksumTrait;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Constructs a DatabaseCacheTagsChecksum object.
*
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
*/
public function __construct(Connection $connection) {
$this->connection = $connection;
}
/**
* {@inheritdoc}
*/
protected function doInvalidateTags(array $tags) {
try {
foreach ($tags as $tag) {
$this->connection
->merge('cachetags')
->insertFields([
'invalidations' => 1,
])
->expression('invalidations', 'invalidations + 1')
->key('tag', $tag)
->execute();
}
} catch (\Exception $e) {
// Create the cache table, which will be empty. This fixes cases during
// core install where cache tags are invalidated before the table is
// created.
if (!$this
->ensureTableExists()) {
$this
->catchException($e);
}
}
}
/**
* {@inheritdoc}
*/
protected function getTagInvalidationCounts(array $tags) {
try {
return $this->connection
->query('SELECT tag, invalidations FROM {cachetags} WHERE tag IN ( :tags[] )', [
':tags[]' => $tags,
])
->fetchAllKeyed();
} catch (\Exception $e) {
// If the table does not exist yet, create.
if (!$this
->ensureTableExists()) {
$this
->catchException($e);
}
}
return [];
}
/**
* Check if the cache tags table exists and create it if not.
*/
protected function ensureTableExists() {
try {
$database_schema = $this->connection
->schema();
// Create the cache tags table if it does not exist.
if (!$database_schema
->tableExists('cachetags')) {
$schema_definition = $this
->schemaDefinition();
$database_schema
->createTable('cachetags', $schema_definition);
return TRUE;
}
} catch (DatabaseException $e) {
return TRUE;
}
return FALSE;
}
/**
* Defines the schema for the {cachetags} table.
*
* @internal
*/
public function schemaDefinition() {
$schema = [
'description' => 'Cache table for tracking cache tag invalidations.',
'fields' => [
'tag' => [
'description' => 'Namespace-prefixed tag string.',
'type' => 'varchar_ascii',
'length' => 255,
'not null' => TRUE,
'default' => '',
],
'invalidations' => [
'description' => 'Number incremented when the tag is invalidated.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
],
],
'primary key' => [
'tag',
],
];
return $schema;
}
/**
* Act on an exception when cache might be stale.
*
* If the {cachetags} table does not yet exist, that's fine but if the table
* exists and yet the query failed, then the cache is stale and the
* exception needs to propagate.
*
* @param \Exception $e
* The exception.
*
* @throws \Exception
*/
protected function catchException(\Exception $e) {
if ($this->connection
->schema()
->tableExists('cachetags')) {
throw $e;
}
}
/**
* {@inheritdoc}
*/
public function getDatabaseConnection() {
return $this->connection;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheTagsChecksumInterface:: |
constant | The invalid checksum returned if a database transaction is in progress. | ||
CacheTagsChecksumTrait:: |
protected | property | The set of cache tags whose invalidation is delayed. | |
CacheTagsChecksumTrait:: |
protected | property | A list of tags that have already been invalidated in this request. | |
CacheTagsChecksumTrait:: |
protected | property | Contains already loaded tag invalidation counts from the storage. | |
CacheTagsChecksumTrait:: |
protected | function | Calculates the current checksum for a given set of tags. | |
CacheTagsChecksumTrait:: |
public | function | Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::getCurrentChecksum() | |
CacheTagsChecksumTrait:: |
public | function | Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::invalidateTags() | |
CacheTagsChecksumTrait:: |
public | function | Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid() | |
CacheTagsChecksumTrait:: |
public | function | Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::reset() | |
CacheTagsChecksumTrait:: |
public | function | Callback to be invoked just after a database transaction gets committed. | |
DatabaseCacheTagsChecksum:: |
protected | property | The database connection. | |
DatabaseCacheTagsChecksum:: |
protected | function | Act on an exception when cache might be stale. | |
DatabaseCacheTagsChecksum:: |
protected | function |
Marks cache items with any of the specified tags as invalid. Overrides CacheTagsChecksumTrait:: |
|
DatabaseCacheTagsChecksum:: |
protected | function | Check if the cache tags table exists and create it if not. | |
DatabaseCacheTagsChecksum:: |
public | function |
Returns the database connection. Overrides CacheTagsChecksumTrait:: |
|
DatabaseCacheTagsChecksum:: |
protected | function |
Fetches invalidation counts for cache tags. Overrides CacheTagsChecksumTrait:: |
|
DatabaseCacheTagsChecksum:: |
public | function | Defines the schema for the {cachetags} table. | |
DatabaseCacheTagsChecksum:: |
public | function | Constructs a DatabaseCacheTagsChecksum object. |