function UseCacheBackendTrait::cacheGet

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php \Drupal\Core\Cache\UseCacheBackendTrait::cacheGet()
  2. 10 core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php \Drupal\Core\Cache\UseCacheBackendTrait::cacheGet()
  3. 8.9.x core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php \Drupal\Core\Cache\UseCacheBackendTrait::cacheGet()

Fetches from the cache backend, respecting the use caches flag.

Parameters

string $cid: The cache ID of the data to retrieve.

Return value

object|false The cache item or FALSE on failure.

See also

\Drupal\Core\Cache\CacheBackendInterface::get()

File

core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php, line 35

Class

UseCacheBackendTrait
Provides methods to use a cache backend while respecting a 'use caches' flag.

Namespace

Drupal\Core\Cache

Code

protected function cacheGet($cid) {
  if ($this->useCaches && $this->cacheBackend) {
    return $this->cacheBackend
      ->get($cid);
  }
  return FALSE;
}

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