AbstractBackend.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Backend;
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractBackend implements ‪BackendInterface, LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    public const ‪DATETIME_EXPIRYTIME_UNLIMITED = '9999-12-31T23:59:59+0000';
    public const ‪UNLIMITED_LIFETIME = 0;
 
    protected ‪$cache;
 
    protected ‪$cacheIdentifier;
 
    protected ‪$context;
 
    protected ‪$defaultLifetime = 3600;
 
    public function ‪__construct(‪$context, array $options = [])
    {
        $this->context = ‪$context;
        foreach ($options as $optionKey => $optionValue) {
            $methodName = 'set' . ucfirst($optionKey);
            if (method_exists($this, $methodName)) {
                $this->{$methodName}($optionValue);
            } else {
                throw new \InvalidArgumentException('Invalid cache backend option "' . $optionKey . '" for backend of type "' . static::class . '"', 1231267498);
            }
        }
        if ($this->logger === null) {
            $this->setLogger(
                GeneralUtility::makeInstance(LogManager::class)
                    ->getLogger(static::class)
            );
        }
    }
 
    public function ‪setCache(‪FrontendInterface ‪$cache)
    {
        $this->cache = ‪$cache;
        $this->cacheIdentifier = $this->cache->‪getIdentifier();
    }
 
    public function ‪setDefaultLifetime(‪$defaultLifetime)
    {
        if (!is_int(‪$defaultLifetime) || ‪$defaultLifetime < 0) {
            throw new \InvalidArgumentException('The default lifetime must be given as a positive integer.', 1233072774);
        }
        $this->defaultLifetime = ‪$defaultLifetime;
    }
 
    public function ‪flushByTags(array $tags)
    {
        // todo: flushByTag is not necessarily implemented since it's neither defined of the interface, nor defined in
        //       this class as abstract method. Therefore this potentially triggers a fatal error during runtime.
        array_walk($tags, $this->flushByTag(...));
    }
 
    protected function ‪calculateExpiryTime($lifetime = null)
    {
        if ($lifetime === self::UNLIMITED_LIFETIME || $lifetime === null && $this->defaultLifetime === self::UNLIMITED_LIFETIME) {
            $expiryTime = new \DateTime(self::DATETIME_EXPIRYTIME_UNLIMITED, new \DateTimeZone('UTC'));
        } else {
            if ($lifetime === null) {
                $lifetime = ‪$this->defaultLifetime;
            }
            $expiryTime = new \DateTime('now +' . $lifetime . ' seconds', new \DateTimeZone('UTC'));
        }
        return $expiryTime;
    }
}