CacheInstruction.php

Go to the documentation of this file.

<?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\Frontend\Cache;
 
final class ‪CacheInstruction
{
    private bool ‪$allowCaching = true;
    private array ‪$disabledCacheReasons = [];
 
    public function ‪disableCache(string $reason): void
    {
        if (empty($reason)) {
            throw new \RuntimeException(
                'A non-empty reason must be given to disable cache. At least mention the extension name that triggers it.',
                1701528694
            );
        }
        $this->allowCaching = false;
        $this->disabledCacheReasons[] = $reason;
    }
 
    public function ‪isCachingAllowed(): bool
    {
        return ‪$this->allowCaching;
    }
 
    public function ‪getDisabledCacheReasons(): array
    {
        return ‪$this->disabledCacheReasons;
    }
}