eliashaeussler/typo3-warming

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS extension "warming".
 *
 * 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 2 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 EliasHaeussler\Typo3Warming\Event;

use EliasHaeussler\CacheWarmup;
use EliasHaeussler\Typo3Warming\ValueObject;

/**
 * BeforeCacheWarmupEvent
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-2.0-or-later
 */
final class BeforeCacheWarmupEvent
{
    /**
     * @param list<ValueObject\Request\SiteWarmupRequest> $sites
     * @param list<ValueObject\Request\PageWarmupRequest> $pages
     */
    public function __construct(
        private readonly array $sites,
        private readonly array $pages,
        private readonly ?CacheWarmup\Crawler\Strategy\CrawlingStrategy $crawlingStrategy,
        private readonly CacheWarmup\Crawler\Crawler $crawler,
        private readonly CacheWarmup\CacheWarmer $cacheWarmer,
    ) {}

    /**
     * @return list<ValueObject\Request\SiteWarmupRequest>
     */
    public function getSites(): array
    {
        return $this->sites;
    }

    /**
     * @return list<ValueObject\Request\PageWarmupRequest>
     */
    public function getPages(): array
    {
        return $this->pages;
    }

    public function getCrawlingStrategy(): ?CacheWarmup\Crawler\Strategy\CrawlingStrategy
    {
        return $this->crawlingStrategy;
    }

    public function getCrawler(): CacheWarmup\Crawler\Crawler
    {
        return $this->crawler;
    }

    public function getCacheWarmer(): CacheWarmup\CacheWarmer
    {
        return $this->cacheWarmer;
    }
}