Files

95 lines
3.7 KiB
PHP

<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Core\Cache\Frontend;
use TYPO3\CMS\Core\Cache\Backend\TransientBackendInterface;
use TYPO3\CMS\Core\Crypto\HashService;
use TYPO3\CMS\Core\Serializer\AuthenticatedMessageDeserializer;
use TYPO3\CMS\Core\Serializer\DeserializationService;
use TYPO3\CMS\Core\Serializer\Exception\DeserializerException;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* A cache frontend for any kinds of PHP variables
*/
class VariableFrontend extends AbstractFrontend
{
/**
* Saves the value of a PHP variable in the cache. Note that the variable
* will be serialized if necessary.
*
* @param int|null $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
*/
public function set(string $entryIdentifier, mixed $data, array $tags = [], ?int $lifetime = null): void
{
if (!$this->isValidEntryIdentifier($entryIdentifier)) {
throw new \InvalidArgumentException(
'"' . $entryIdentifier . '" is not a valid cache entry identifier.',
1233058264
);
}
foreach ($tags as $tag) {
if (!$this->isValidTag($tag)) {
throw new \InvalidArgumentException('"' . $tag . '" is not a valid tag for a cache entry.', 1233058269);
}
}
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/cache/frontend/class.t3lib_cache_frontend_variablefrontend.php']['set'] ?? [] as $_funcRef) {
$params = [
'entryIdentifier' => &$entryIdentifier,
'variable' => &$data,
'tags' => &$tags,
'lifetime' => &$lifetime,
];
GeneralUtility::callUserFunction($_funcRef, $params, $this);
}
if (!$this->backend instanceof TransientBackendInterface) {
// No DI/GeneralUtility::makeInstance usage, since caching needs to operate prior to DI container setup.
$deserializer = new AuthenticatedMessageDeserializer(new HashService(), new DeserializationService());
$data = $deserializer->serialize($data, VariableFrontend::class);
}
$this->backend->set($entryIdentifier, $data, $tags, $lifetime);
}
/**
* Finds and returns a variable value from the cache.
*/
public function get(string $entryIdentifier): mixed
{
if (!$this->isValidEntryIdentifier($entryIdentifier)) {
throw new \InvalidArgumentException(
'"' . $entryIdentifier . '" is not a valid cache entry identifier.',
1233058294
);
}
$rawResult = $this->backend->get($entryIdentifier);
if ($rawResult === false) {
return false;
}
if ($this->backend instanceof TransientBackendInterface) {
return $rawResult;
}
try {
// No DI/GeneralUtility::makeInstance usage, since caching needs to operate prior to DI container setup.
$deserializer = new AuthenticatedMessageDeserializer(new HashService(), new DeserializationService());
return $deserializer->deserialize($rawResult, VariableFrontend::class);
} catch (DeserializerException) {
return false;
}
}
}