StringFrontend.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Core\Cache\Frontend;
 
/*
 * 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!
 */
 
use ‪TYPO3\CMS\Core\Cache\Backend\BackendInterface;
use ‪TYPO3\CMS\Core\Cache\Exception\InvalidDataException;
 
class ‪StringFrontend extends ‪AbstractFrontend
{
    public function ‪__construct(‪$identifier, ‪BackendInterface ‪$backend)
    {
        trigger_error(
            sprintf(
                'Usage of class %s will be removed in TYPO3 v10.0, use %s instead',
                static::class,
                VariableFrontend::class
            ),
            E_USER_DEPRECATED
        );
        parent::__construct(‪$identifier, ‪$backend);
    }
 
    public function set($entryIdentifier, $string, array $tags = [], $lifetime = null)
    {
        if (!$this->‪isValidEntryIdentifier($entryIdentifier)) {
            throw new \InvalidArgumentException('"' . $entryIdentifier . '" is not a valid cache entry identifier.', 1233057566);
        }
        if (!is_string($string)) {
            throw new ‪InvalidDataException('Given data is of type "' . gettype($string) . '", but a string is expected for string cache.', 1222808333);
        }
        foreach ($tags as $tag) {
            if (!$this->‪isValidTag($tag)) {
                throw new \InvalidArgumentException('"' . $tag . '" is not a valid tag for a cache entry.', 1233057512);
            }
        }
        $this->backend->set($entryIdentifier, $string, $tags, $lifetime);
    }
 
    public function get($entryIdentifier)
    {
        if (!$this->‪isValidEntryIdentifier($entryIdentifier)) {
            throw new \InvalidArgumentException('"' . $entryIdentifier . '" is not a valid cache entry identifier.', 1233057752);
        }
        return $this->backend->get($entryIdentifier);
    }
 
    public function ‪getByTag($tag)
    {
        trigger_error('StringFrontend->getByTag() will be removed in TYPO3 v10.0. Avoid using this method since it is not compliant to PSR-6.', E_USER_DEPRECATED);
        if (!$this->‪isValidTag($tag)) {
            throw new \InvalidArgumentException('"' . $tag . '" is not a valid tag for a cache entry.', 1233057772);
        }
        $entries = [];
        $identifiers = $this->backend->findIdentifiersByTag($tag);
        foreach ($identifiers as ‪$identifier) {
            $entries[] = $this->backend->get(‪$identifier);
        }
        return $entries;
    }
}