GalleryCreatorNewsController.php

<?php

declare(strict_types=1);

/*
 * This file is part of Gallery Creator Bundle.
 *
 * (c) Marko Cupic 2022 <m.cupic@gmx.ch>
 * @license GPL-3.0-or-later
 * For the full copyright and license information,
 * please view the LICENSE file that was distributed with this source code.
 * @link https://github.com/markocupic/gallery-creator-bundle
 */

namespace Markocupic\GalleryCreatorBundle\Controller\ContentElement;

use Contao\ContentModel;
use Contao\CoreBundle\ServiceAnnotation\ContentElement;
use Contao\PageModel;
use Contao\Template;
use Doctrine\DBAL\Driver\Exception as DoctrineDBALDriverException;
use Doctrine\DBAL\Exception as DoctrineDBALException;
use Markocupic\GalleryCreatorBundle\Model\GalleryCreatorAlbumsModel;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Twig\Environment as TwigEnvironment;

/**
 * @ContentElement(GalleryCreatorNewsController::TYPE, category="gallery_creator_elements", template="ce_gallery_creator_news")
 */
class GalleryCreatorNewsController extends AbstractGalleryCreatorController
{
    public const TYPE = 'gallery_creator_news';

    protected TwigEnvironment $twig;
    protected ?GalleryCreatorAlbumsModel $activeAlbum = null;
    protected ?ContentModel $model = null;
    protected ?PageModel $pageModel = null;

    public function __construct(DependencyAggregate $dependencyAggregate, TwigEnvironment $twig)
    {
        $this->twig = $twig;

        parent::__construct($dependencyAggregate);
    }

    public function __invoke(Request $request, ContentModel $model, string $section, array $classes = null, PageModel $pageModel = null): Response
    {
        // Do not parse the content element in the backend
        if ($this->scopeMatcher->isBackendRequest($request)) {
            return new Response(
                $this->twig->render('@MarkocupicGalleryCreator/Backend/backend_element_view.html.twig', [])
            );
        }

        $this->model = $model;
        $this->pageModel = $pageModel;

        if (!$this->model->gcPublishSingleAlbum) {
            return new Response('', Response::HTTP_NO_CONTENT);
        }

        $this->activeAlbum = GalleryCreatorAlbumsModel::findOneBy(
            ['tl_gallery_creator_albums.id = ? AND tl_gallery_creator_albums.published = ?'],
            [$this->model->gcPublishSingleAlbum, '1']
        );

        // Return empty response if the album doesn't exist
        if (null === $this->activeAlbum) {
            return new Response('', Response::HTTP_NO_CONTENT);
        }

        // Check permission for protected albums
        if (!$this->securityUtil->isAuthorized($this->activeAlbum)) {
            return new Response('', Response::HTTP_NO_CONTENT);
        }

        return parent::__invoke($request, $this->model, $section, $classes);
    }

    /**
     * @throws DoctrineDBALDriverException
     * @throws DoctrineDBALException
     *
     * @return Response|null
     */
    protected function getResponse(Template $template, ContentModel $model, Request $request): Response
    {
        // Add the picture collection and the pagination to the template.
        $this->addAlbumPicturesToTemplate($this->activeAlbum, $this->model, $template, $this->pageModel);

        // Augment template with more properties.
        $this->addAlbumToTemplate($this->activeAlbum, $model, $template, $this->pageModel);

        // Count views
        $this->albumUtil->countAlbumViews($this->activeAlbum);

        // Add content model to template.
        $template->content = $model->row();

        // Add meta tags to the page header.
        $this->addMetaTagsToPage($this->pageModel, $this->activeAlbum);

        // Trigger gcGenerateFrontendTemplateHook
        $this->triggerGenerateFrontendTemplateHook($template, $this->activeAlbum);

        return $template->getResponse();
    }

    /**
     * Augment template with some more properties of the active album.
     */
    protected function addAlbumToTemplate(GalleryCreatorAlbumsModel $albumModel, ContentModel $contentModel, Template $template, PageModel $pageModel): void
    {
        parent::addAlbumToTemplate($albumModel, $contentModel, $template, $pageModel);
    }
}