[TASK] Streamline return tags in phpdocs
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / Core / Cache / FluidTemplateCache.php
1 <?php
2 namespace TYPO3\CMS\Fluid\Core\Cache;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Cache\Exception\InvalidDataException;
18 use TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
19 use TYPO3Fluid\Fluid\Core\Cache\FluidCacheInterface;
20 use TYPO3Fluid\Fluid\Core\Cache\FluidCacheWarmerInterface;
21 use TYPO3Fluid\Fluid\Core\Cache\StandardCacheWarmer;
22
23 /**
24 * Class FluidTemplateCache
25 *
26 * Connector class that enables the TYPO3 cache called "fluid_template" to be operated with the
27 * interface appropriate for the Fluid engine.
28 */
29 class FluidTemplateCache extends PhpFrontend implements FluidCacheInterface
30 {
31 /**
32 * @param null $name
33 */
34 public function flush($name = null)
35 {
36 parent::flush();
37 }
38
39 /**
40 * @param string $entryIdentifier
41 * @return mixed
42 */
43 public function get($entryIdentifier)
44 {
45 return $this->requireOnce($entryIdentifier);
46 }
47
48 /**
49 * @param string $entryIdentifier
50 * @param string $sourceCode
51 * @param array $tags
52 * @param int $lifetime
53 * @throws InvalidDataException
54 */
55 public function set($entryIdentifier, $sourceCode, array $tags = [], $lifetime = null)
56 {
57 if (strpos($sourceCode, '<?php') === 0) {
58 // Remove opening PHP tag; it is added by the cache backend to which
59 // we delegate and would be duplicated if not removed.
60 $sourceCode = substr($sourceCode, 6);
61 }
62 parent::set($entryIdentifier, $sourceCode, $tags, time() + 86400);
63 }
64
65 /**
66 * @return FluidCacheWarmerInterface
67 */
68 public function getCacheWarmer()
69 {
70 return new StandardCacheWarmer();
71 }
72 }