Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Component/FileCache/FileCacheInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Component\FileCache\FileCacheInterface.
6	*/
7
8	namespace Drupal\Component\FileCache;
9
10	/**
11	* Interface for objects that allow caching file data.
12	*
13	* Parsing YAML, annotations or similar data out of files can be a
14	* time-consuming process, especially since those files usually don't change
15	* and identical data is parsed over and over again.
16	*
17	* File cache is a self-contained caching layer for such processing, that relies
18	* on the file modification to ensure that cached data is still up to date and
19	* does not need to be invalidated externally.
20	*/
21	interface FileCacheInterface {
22
23	/**
24	* Gets data based on a filename.
25	*
26	* @param string $filepath
27	* Path of the file that the cached data is based on.
28	*
29	* @return mixed\|null
30	* The data that was persisted with set() or NULL if there is no data
31	* or the file has been modified.
32	*/
33	public function get($filepath);
34
35	/**
36	* Gets data based on filenames.
37	*
38	* @param string[] $filepaths
39	* List of file paths used as cache identifiers.
40	*
41	* @return array
42	* List of cached data keyed by the passed in file paths.
43	*/
44	public function getMultiple(array $filepaths);
45
46	/**
47	* Stores data based on a filename.
48	*
49	* @param string $filepath
50	* Path of the file that the cached data is based on.
51	* @param mixed $data
52	* The data that should be cached.
53	*/
54	public function set($filepath, $data);
55
56	/**
57	* Deletes data from the cache.
58	*
59	* @param string $filepath
60	* Path of the file that the cached data is based on.
61	*/
62	public function delete($filepath);
63
64	}