sonata-project / SonataNewsBundle

src/Action/CreateCommentAction.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\NewsBundle\Action;

use Sonata\NewsBundle\Event\FilterCommentResponseEvent;
use Sonata\NewsBundle\Event\FormEvent;
use Sonata\NewsBundle\Event\GetResponseCommentEvent;
use Sonata\NewsBundle\Form\Type\CommentType;
use Sonata\NewsBundle\Mailer\MailerInterface;
use Sonata\NewsBundle\Model\BlogInterface;
use Sonata\NewsBundle\Model\CommentInterface;
use Sonata\NewsBundle\Model\CommentManagerInterface;
use Sonata\NewsBundle\Model\PostInterface;
use Sonata\NewsBundle\Model\PostManagerInterface;
use Sonata\NewsBundle\SonataNewsEvents;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;

final class CreateCommentAction extends Controller

The class Symfony\Bundle\FrameworkBundle\Controller\Controller has been deprecated with message: since Symfony 4.2, use "Symfony\Bundle\FrameworkBundle\Controller\AbstractController" instead.

{
    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @var BlogInterface
     */
    private $blog;

    /**
     * @var PostManagerInterface
     */
    private $postManager;

    /**
     * @var CommentManagerInterface
     */
    private $commentManager;

    /**
     * @var FormFactoryInterface
     */
    private $formFactory;

    /**
     * @var MailerInterface
     */
    private $mailer;

    /**
     * @var EventDispatcherInterface|null
     */
    private $eventDispatcher;

    // NEXT_MAJOR: Make $eventDispatcher a required dependency
    public function __construct(
        RouterInterface $router,
        BlogInterface $blog,
        PostManagerInterface $postManager,
        CommentManagerInterface $commentManager,
        FormFactoryInterface $formFactory,
        MailerInterface $mailer,
        ?EventDispatcherInterface $eventDispatcher = null
    ) {
        $this->router = $router;
        $this->blog = $blog;
        $this->postManager = $postManager;
        $this->commentManager = $commentManager;
        $this->formFactory = $formFactory;
        $this->mailer = $mailer;
        $this->eventDispatcher = $eventDispatcher;

        if (null === $this->eventDispatcher) {
            @trigger_error(sprintf(

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

                'Not providing an event dispatcher to %s is deprecated since sonata-project/news-bundle 3.9',
                __CLASS__
            ), E_USER_DEPRECATED);
        }
    }

    /**
     * @param string $id
     *
     * @throws NotFoundHttpException
     *
     * @return Response
     */
    public function __invoke(Request $request, $id)
    {
        $post = $this->postManager->findOneBy([
            'id' => $id,
        ]);

        if (!$post instanceof PostInterface) {
            throw new NotFoundHttpException(sprintf('Post (%d) not found', $id));
        }

        if (!$post->isCommentable()) {
            // todo : add notice in event listener
            return new RedirectResponse($this->router->generate('sonata_news_view', [
                'permalink' => $this->blog->getPermalinkGenerator()->generate($post),
            ]));
        }

        $comment = $this->createComment($post);

        // NEXT_MAJOR: Remove the if code
        if (null !== $this->eventDispatcher) {
            $event = new GetResponseCommentEvent($comment, $request);
            $this->eventDispatcher->dispatch($event, SonataNewsEvents::COMMENT_INITIALIZE);

            if (null !== $event->getResponse()) {
                return $event->getResponse();
            }
        }

        $form = $this->getCommentForm($comment);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            // NEXT_MAJOR: Remove the if code
            if (null !== $this->eventDispatcher) {
                $event = new FormEvent($form, $request);
                $this->eventDispatcher->dispatch($event, SonataNewsEvents::COMMENT_SUCCESS);
            }

            $comment = $form->getData();

            $this->commentManager->save($comment);
            $this->mailer->sendCommentNotification($comment);

            // todo : add notice in event listener
            $response = new RedirectResponse($this->router->generate('sonata_news_view', [
                'permalink' => $this->blog->getPermalinkGenerator()->generate($post),
            ]));

            // NEXT_MAJOR: Remove the if code
            if (null !== $this->eventDispatcher) {
                $this->eventDispatcher->dispatch(
                    new FilterCommentResponseEvent($comment, $request, $response),
                    SonataNewsEvents::COMMENT_COMPLETED
                );
            }

            return $response;
        }

        return $this->render('@SonataNews/Post/view.html.twig', [
            'post' => $post,
            'form' => $form,
        ]);
    }

    private function getCommentForm(CommentInterface $comment): FormInterface
    {
        return $this->formFactory->createNamed('comment', CommentType::class, $comment, [
            'action' => $this->router->generate('sonata_news_add_comment', [
                'id' => $comment->getPost()->getId(),
            ]),
            'method' => 'POST',
        ]);
    }

    private function createComment(PostInterface $post): CommentInterface
    {
        $comment = $this->commentManager->create();
        $comment->setPost($post);
        $comment->setStatus($post->getCommentsDefaultStatus());

        return $comment;
    }
}