annotate core/lib/Drupal/Component/FileCache/FileCacheBackendInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Component\FileCache;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines an interface inspired by APCu for FileCache backends.
Chris@0 7 */
Chris@0 8 interface FileCacheBackendInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Fetches data from the cache backend.
Chris@0 12 *
Chris@0 13 * @param array $cids
Chris@0 14 * The cache IDs to fetch.
Chris@0 15 *
Chris@0 16 * @return array
Chris@0 17 * An array containing cache entries keyed by cache ID.
Chris@0 18 */
Chris@0 19 public function fetch(array $cids);
Chris@0 20
Chris@0 21 /**
Chris@0 22 * Stores data into a cache backend.
Chris@0 23 *
Chris@0 24 * @param string $cid
Chris@0 25 * The cache ID to store data to.
Chris@0 26 * @param mixed $data
Chris@0 27 * The data to store.
Chris@0 28 */
Chris@0 29 public function store($cid, $data);
Chris@0 30
Chris@0 31 /**
Chris@0 32 * Deletes data from a cache backend.
Chris@0 33 *
Chris@0 34 * @param string $cid
Chris@0 35 * The cache ID to delete.
Chris@0 36 */
Chris@0 37 public function delete($cid);
Chris@0 38
Chris@0 39 }