public function FileSystemBackend::set in File Cache 8

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'].

Overrides CacheBackendInterface::set

File

src/Cache/FileSystemBackend.php, line 127

Class

FileSystemBackend: A cache backend that stores cache items as files on the file system.

Namespace

Drupal\filecache\Cache

Code

public function set($cid, $data, $expire = Cache::PERMANENT, array $tags = []) {
  $this
    ->ensureCacheFolderExists();
  $filename = $this
    ->getFilename($cid);

  // Validate cache tags and remove duplicates.
  assert(Inspector::assertAllStrings($tags), 'Cache Tags must be strings.');
  $tags = array_unique($tags);
  sort($tags);
  $item = (object) [
    'cid' => $cid,
    'data' => $data,
    'expire' => $expire,
    'tags' => $tags,
    'created' => round(microtime(TRUE), 3),
    'checksum' => $this->checksumProvider
      ->getCurrentChecksum($tags),
  ];
  if (file_put_contents($filename, serialize($item)) === FALSE) {
    throw new \Exception('Cache entry could not be created.');
  }
}

You are here