1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Update
  7. \
  8. UpdateBackend

UpdateBackend

class UpdateBackend extends NullBackend (View source)

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.

Properties

protected CacheBackendInterface $backend

The regular runtime cache backend.

Methods

__construct(CacheBackendInterface $backend)

UpdateBackend constructor.

object|false
get(string $cid, bool $allow_invalid = FALSE)

Returns data from the persistent cache.

from  NullBackend
array
getMultiple(array $cids, bool $allow_invalid = FALSE)

Returns data from the persistent cache when given an array of cache IDs.

from  NullBackend
set(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])

Stores data in the persistent cache.

from  NullBackend
setMultiple(array $items = [])

Store multiple items in the persistent cache.

from  NullBackend
delete(string $cid)

Deletes an item from the cache.

deleteMultiple(array $cids)

Deletes multiple items from the cache.

deleteAll()

Deletes all cache items in a bin.

invalidate(string $cid)

Marks a cache item as invalid.

from  NullBackend
invalidateMultiple(array $cids)

Marks cache items as invalid.

from  NullBackend
invalidateAll()

Marks all cache items as invalid.

from  NullBackend
garbageCollection()

Performs garbage collection on a cache bin.

from  NullBackend
removeBin()

Remove a cache bin.

from  NullBackend

Details

at line 29
__construct(CacheBackendInterface $backend)

UpdateBackend constructor.

Parameters

CacheBackendInterface $backend

The regular runtime cache backend.

in NullBackend at line 31
object|false get(string $cid, bool $allow_invalid = FALSE)

Returns data from the persistent cache.

Parameters

string $cid

The cache ID of the data to retrieve.
bool $allow_invalid

(optional) If TRUE, a cache item may be returned even if it is expired or has been invalidated. Such items may sometimes be preferred, if the alternative is recalculating the value stored in the cache, especially if another concurrent request is already recalculating the same value. The "valid" property of the returned object indicates whether the item is valid or not. Defaults to FALSE.

Return Value

object|false

The cache item or FALSE on failure.

in NullBackend at line 38
array getMultiple(array $cids, bool $allow_invalid = FALSE)

Returns data from the persistent cache when given an array of cache IDs.

Parameters

array $cids

An array of cache IDs for the data to retrieve. This is passed by reference, and will have the IDs successfully returned from cache removed.
bool $allow_invalid

(optional) If TRUE, cache items may be returned even if they have expired or been invalidated. Such items may sometimes be preferred, if the alternative is recalculating the value stored in the cache, especially if another concurrent thread is already recalculating the same value. The "valid" property of the returned objects indicates whether the items are valid or not. Defaults to FALSE.

Return Value

array

An array of cache item objects indexed by cache ID.

in NullBackend at line 45
set(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])

Stores data in the persistent cache.

Core cache implementations set the created time on cache item with microtime(TRUE) rather than REQUEST_TIME_FLOAT, because the created time of cache items should match when they are created, not when the request started. Apart from being more accurate, this increases the chance an item will legitimately be considered valid.

Parameters

string $cid

The cache ID of the data to store.
mixed $data

The data to store in the cache. Some storage engines only allow objects up to a maximum of 1MB in size to be stored by default. When caching large arrays or similar, take care to ensure $data does not exceed this size.
int $expire

One of the following values:

  • CacheBackendInterface::CACHE_PERMANENT: Indicates that the item should not be removed unless it is deleted explicitly.
  • A Unix timestamp: Indicates that the item will be considered invalid after this time, i.e. it will not be returned by get() unless $allow_invalid has been set to TRUE. When the item has expired, it may be permanently deleted by the garbage collector at any time.
array $tags

An array of tags to be stored with the cache item. These should normally identify objects used to build the cache item, which should trigger cache invalidation when updated. For example if a cached item represents a node, both the node ID and the author's user ID might be passed in as tags. For example ['node:123', 'node:456', 'user:789'].

in NullBackend at line 50
setMultiple(array $items = [])

Store multiple items in the persistent cache.

Parameters

array $items

An array of cache items, keyed by cid. In the form: @code $items = array( $cid => array( // Required, will be automatically serialized if not a string. 'data' => $data, // Optional, defaults to CacheBackendInterface::CACHE_PERMANENT. 'expire' => CacheBackendInterface::CACHE_PERMANENT, // (optional) The cache tags for this item, see CacheBackendInterface::set(). 'tags' => array(), ), ); @endcode

at line 36
delete(string $cid)

Deletes an item from the cache.

If the cache item is being deleted because it is no longer "fresh", you may consider using invalidate() instead. This allows callers to retrieve the invalid item by calling get() with $allow_invalid set to TRUE. In some cases an invalid item may be acceptable rather than having to rebuild the cache.

Parameters

string $cid

The cache ID to delete.

at line 43
deleteMultiple(array $cids)

Deletes multiple items from the cache.

If the cache items are being deleted because they are no longer "fresh", you may consider using invalidateMultiple() instead. This allows callers to retrieve the invalid items by calling get() with $allow_invalid set to TRUE. In some cases an invalid item may be acceptable rather than having to rebuild the cache.

Parameters

array $cids

An array of cache IDs to delete.

at line 50
deleteAll()

Deletes all cache items in a bin.

in NullBackend at line 70
invalidate(string $cid)

Marks a cache item as invalid.

Invalid items may be returned in later calls to get(), if the $allow_invalid argument is TRUE.

Parameters

string $cid

The cache ID to invalidate.

in NullBackend at line 75
invalidateMultiple(array $cids)

Marks cache items as invalid.

Invalid items may be returned in later calls to get(), if the $allow_invalid argument is TRUE.

Parameters

array $cids

An array of cache IDs to invalidate.

in NullBackend at line 80
invalidateAll()

Marks all cache items as invalid.

Invalid items may be returned in later calls to get(), if the $allow_invalid argument is TRUE.

in NullBackend at line 85
garbageCollection()

Performs garbage collection on a cache bin.

The backend may choose to delete expired or invalidated items.

in NullBackend at line 90
removeBin()

Remove a cache bin.