Version 1

[yaffs-website] / web / modules / contrib / devel / webprofiler / src / Cache / CacheBackendWrapper.php

diff --git a/web/modules/contrib/devel/webprofiler/src/Cache/CacheBackendWrapper.php b/web/modules/contrib/devel/webprofiler/src/Cache/CacheBackendWrapper.php
new file mode 100644 (file)
index 0000000..725e4cf
--- /dev/null
+++ b/web/modules/contrib/devel/webprofiler/src/Cache/CacheBackendWrapper.php
@@ -0,0 +1,176 @@
+<?php
+
+namespace Drupal\webprofiler\Cache;
+
+use Drupal\Core\Cache\Cache;
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
+use Drupal\webprofiler\DataCollector\CacheDataCollector;
+
+/**
+ * Wraps an existing cache backend to track calls to the cache backend.
+ */
+class CacheBackendWrapper implements CacheBackendInterface, CacheTagsInvalidatorInterface {
+
+  /**
+   * The data collector to register the calls.
+   *
+   * @var \Drupal\webprofiler\DataCollector\CacheDataCollector
+   */
+  protected $cacheDataCollector;
+
+  /**
+   * The wrapped cache backend.
+   *
+   * @var \Drupal\Core\Cache\CacheBackendInterface
+   */
+  protected $cacheBackend;
+
+  /**
+   * The name of the wrapped cache bin.
+   *
+   * @var string
+   */
+  protected $bin;
+
+  /**
+   * Constructs a new CacheBackendWrapper.
+   *
+   * @param \Drupal\webprofiler\DataCollector\CacheDataCollector $cacheDataCollector
+   *   The cache data collector to inform about cache get calls.
+   * @param \Drupal\Core\Cache\CacheBackendInterface $cacheBackend
+   *   The wrapped cache backend.
+   * @param string $bin
+   *   The name of the wrapped cache bin.
+   */
+  public function __construct(CacheDataCollector $cacheDataCollector, CacheBackendInterface $cacheBackend, $bin) {
+    $this->cacheDataCollector = $cacheDataCollector;
+    $this->cacheBackend = $cacheBackend;
+    $this->bin = $bin;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function get($cid, $allow_invalid = FALSE) {
+    $cache = $this->cacheBackend->get($cid, $allow_invalid);
+
+    if ($cache) {
+      $cacheCopy = new \StdClass();
+      $cacheCopy->cid = $cache->cid;
+      $cacheCopy->expire = $cache->expire;
+      $cacheCopy->tags = $cache->tags;
+
+      $this->cacheDataCollector->registerCacheHit($this->bin, $cacheCopy);
+    }
+    else {
+      $this->cacheDataCollector->registerCacheMiss($this->bin, $cid);
+    }
+
+    return $cache;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getMultiple(&$cids, $allow_invalid = FALSE) {
+    $cidsCopy = $cids;
+    $cache = $this->cacheBackend->getMultiple($cids, $allow_invalid);
+
+    foreach ($cidsCopy as $cid) {
+      if (in_array($cid, $cids)) {
+        $this->cacheDataCollector->registerCacheMiss($this->bin, $cid);
+      }
+      else {
+        $cacheCopy = new \StdClass();
+        $cacheCopy->cid = $cache[$cid]->cid;
+        $cacheCopy->expire = $cache[$cid]->expire;
+        $cacheCopy->tags = $cache[$cid]->tags;
+
+        $this->cacheDataCollector->registerCacheHit($this->bin, $cacheCopy);
+      }
+    }
+
+    return $cache;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function set($cid, $data, $expire = Cache::PERMANENT, array $tags = []) {
+    return $this->cacheBackend->set($cid, $data, $expire, $tags);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setMultiple(array $items) {
+    return $this->cacheBackend->setMultiple($items);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function delete($cid) {
+    return $this->cacheBackend->delete($cid);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function deleteMultiple(array $cids) {
+    return $this->cacheBackend->deleteMultiple($cids);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function deleteAll() {
+    return $this->cacheBackend->deleteAll();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function invalidate($cid) {
+    return $this->cacheBackend->invalidate($cid);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function invalidateMultiple(array $cids) {
+    return $this->cacheBackend->invalidateMultiple($cids);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function invalidateTags(array $tags) {
+    if ($this->cacheBackend instanceof CacheTagsInvalidatorInterface) {
+      $this->cacheBackend->invalidateTags($tags);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function invalidateAll() {
+    return $this->cacheBackend->invalidateAll();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function garbageCollection() {
+    return $this->cacheBackend->garbageCollection();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function removeBin() {
+    return $this->cacheBackend->removeBin();
+  }
+
+}