class UpdateBackend

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Update/UpdateBackend.php \Drupal\Core\Update\UpdateBackend
  2. 10 core/lib/Drupal/Core/Update/UpdateBackend.php \Drupal\Core\Update\UpdateBackend
  3. 11.x core/lib/Drupal/Core/Update/UpdateBackend.php \Drupal\Core\Update\UpdateBackend

Defines a cache backend for use during Drupal database updates.

Passes on deletes to another backend while extending the NullBackend to avoid using anything cached prior to running updates.

Hierarchy

Expanded class hierarchy of UpdateBackend

File

core/lib/Drupal/Core/Update/UpdateBackend.php, line 14

Namespace

Drupal\Core\Update
View source 
class UpdateBackend extends NullBackend {
    
    /**
     * The regular runtime cache backend.
     *
     * @var \Drupal\Core\Cache\CacheBackendInterface
     */
    protected $backend;
    
    /**
     * UpdateBackend constructor.
     *
     * @param \Drupal\Core\Cache\CacheBackendInterface $backend
     *   The regular runtime cache backend.
     */
    public function __construct(CacheBackendInterface $backend) {
        $this->backend = $backend;
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete($cid) {
        $this->backend
            ->delete($cid);
    }
    
    /**
     * {@inheritdoc}
     */
    public function deleteMultiple(array $cids) {
        $this->backend
            ->deleteMultiple($cids);
    }
    
    /**
     * {@inheritdoc}
     */
    public function deleteAll() {
        $this->backend
            ->deleteAll();
    }

}

Members

Title Modifiers Object type Summary Overriden Title
CacheBackendInterface::CACHE_PERMANENT constant Indicates that the item should never be removed unless explicitly deleted.
NullBackend::garbageCollection public function Performs garbage collection on a cache bin. Overrides CacheBackendInterface::garbageCollection
NullBackend::get public function Returns data from the persistent cache. Overrides CacheBackendInterface::get
NullBackend::getMultiple public function Returns data from the persistent cache when given an array of cache IDs. Overrides CacheBackendInterface::getMultiple
NullBackend::invalidate public function Marks a cache item as invalid. Overrides CacheBackendInterface::invalidate
NullBackend::invalidateAll public function Marks all cache items as invalid. Overrides CacheBackendInterface::invalidateAll
NullBackend::invalidateMultiple public function Marks cache items as invalid. Overrides CacheBackendInterface::invalidateMultiple
NullBackend::removeBin public function Remove a cache bin. Overrides CacheBackendInterface::removeBin
NullBackend::set public function Stores data in the persistent cache. Overrides CacheBackendInterface::set
NullBackend::setMultiple public function Store multiple items in the persistent cache. Overrides CacheBackendInterface::setMultiple
UpdateBackend::$backend protected property The regular runtime cache backend.
UpdateBackend::delete public function Deletes an item from the cache. Overrides NullBackend::delete
UpdateBackend::deleteAll public function Deletes all cache items in a bin. Overrides NullBackend::deleteAll
UpdateBackend::deleteMultiple public function Deletes multiple items from the cache. Overrides NullBackend::deleteMultiple
UpdateBackend::__construct public function UpdateBackend constructor. Overrides NullBackend::__construct

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