You are here

function cache_get in Memcache API and Integration 6

Same name in this branch
  1. 6 memcache.db.inc \cache_get()
  2. 6 memcache.inc \cache_get()
Same name and namespace in other branches
  1. 5.2 memcache.db.inc \cache_get()
  2. 5.2 memcache.inc \cache_get()
  3. 5 memcache.db.inc \cache_get()
  4. 5 memcache.inc \cache_get()

Return data from the persistent cache. Data may be stored as either plain text or as serialized data. cache_get will automatically return unserialized objects and arrays.

Parameters

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

$table: The table $table to store the data in. Valid core values are 'cache_filter', 'cache_menu', 'cache_page', or 'cache' for the default cache.

6 calls to cache_get()
MemCacheSavingCase::checkVariable in tests/memcache.test
MemCacheSavingCase::testObject in tests/memcache.test
Test the saving and restoring of an object.
MemcacheTestCase::assertCacheRemoved in tests/memcache.test
Assert or a cache entry has been removed.
MemcacheTestCase::checkCacheExists in tests/memcache.test
Check whether or not a cache entry exists.
memcache_requirements in ./memcache.install
Implements hook_requirements().

... See full list

File

./memcache.db.inc, line 24
Implementation of cache.inc with memcache logic included.

Code

function cache_get($cid, $table = 'cache') {
  global $user;
  global $memcache_online;

  // Garbage collection necessary when enforcing a minimum cache lifetime
  $cache_flush = variable_get('cache_flush_' . $table, 0);
  if ($cache_flush && $cache_flush + variable_get('cache_lifetime', 0) <= $_SERVER['REQUEST_TIME']) {

    // Reset the variable immediately to prevent a meltdown in heavy load situations.
    variable_set('cache_flush_' . $table, 0);

    // Time to flush old cache data
    db_query("DELETE FROM {" . $table . "} WHERE expire != %d AND expire <= %d", CACHE_PERMANENT, $cache_flush);
  }

  // If we have a memcache hit for this, return it.
  if ($memcache_online !== FALSE && ($cache = dmemcache_get($cid, $table))) {
    return $cache;
  }

  // Look for a database cache hit.
  if ($cache = db_fetch_object(db_query("SELECT data, created, headers, expire, serialized FROM {" . $table . "} WHERE cid = '%s'", $cid))) {
    if (isset($cache->data)) {

      // If the data is permanent or we're not enforcing a minimum cache lifetime
      // always return the cached data.
      if ($cache->expire == CACHE_PERMANENT || !variable_get('cache_lifetime', 0)) {
        $cache->data = db_decode_blob($cache->data);
        if ($cache->serialized) {
          $cache->data = unserialize($cache->data);
        }
      }
      else {
        if ($user->cache > $cache->created) {

          // This cache data is too old and thus not valid for us, ignore it.
          return 0;
        }
        else {
          $cache->data = db_decode_blob($cache->data);
          if ($cache->serialized) {
            $cache->data = unserialize($cache->data);
          }
        }
      }
    }

    // By calling cache_set with an extra paramater to signify no db storage,
    // we can lazy instantiate memcache that just comes online.
    if ($memcache_online) {
      cache_set($cid, $cache->data, $table, $cache->expire, $cache->headers, FALSE);
    }
    return $cache;
  }
  return 0;
}