eliashaeussler/typo3-badges

View on GitHub
src/Controller/CacheableResponseTrait.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

declare(strict_types=1);

/*
 * This file is part of the Symfony project "eliashaeussler/typo3-badges".
 *
 * Copyright (C) 2021-2024 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace App\Controller;

use DateTime;
use Symfony\Component\HttpFoundation\Response;

/**
 * CacheableResponseTrait.
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-3.0-or-later
 */
trait CacheableResponseTrait
{
    private function markResponseAsCacheable(Response $response, DateTime $cacheExpirationDate): void
    {
        $response->setPublic();
        $response->setExpires($cacheExpirationDate);
        $response->headers->addCacheControlDirective('must-revalidate');
    }
}