Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler

Complexity

Total Complexity

5

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

60.61%

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	__invoke()	0	39	3

<?php

namespace Webfactory\ShortcodeBundle\Handler;

use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel\Controller\ControllerReference;
use Symfony\Component\HttpKernel\Fragment\FragmentHandler;
use Thunder\Shortcode\Shortcode\ShortcodeInterface;

/**
 * Handler for thunderer\Shortcode that embeds the configured renderer for a shortcode.
 *
 * The attributes of the shortcode will be passed on as parameters to the controller.
 */
class EmbeddedShortcodeHandler
{
    /** @var FragmentHandler */
    private $fragmentHandler;

    /** @var string */
    private $controllerName;

    /** @var string */
    private $renderer;

    /** @var LoggerInterface */
    private $logger;

    /** @var RequestStack */
    private $requestStack;

    /**
     * @param FragmentHandler $fragmentHandler
     * @param string          $controllerName
     * @param string          $renderer
     * @param LoggerInterface $logger
     * @param RequestStack    $requestStack
     */
    public function __construct(
        FragmentHandler $fragmentHandler,
        $controllerName,
        $renderer,
        RequestStack $requestStack,
        LoggerInterface $logger = null
    ) {
        $this->fragmentHandler = $fragmentHandler;
        $this->controllerName = $controllerName;
        $this->renderer = $renderer;
        $this->requestStack = $requestStack;
        $this->logger = $logger ?: new NullLogger();
    }

    /**
     * @param ShortcodeInterface $shortcode
     *
     * @return string|null
     */
    public function __invoke(ShortcodeInterface $shortcode)
    {
        $this->logger->notice(
            'Request {controllerName} with parameters {parameters} and renderer {renderer} to resolve shortcode {shortcode}, triggered by a request to {url}.',
            [
                'controllerName' => $this->controllerName,
                'parameters' => json_encode($shortcode->getParameters()),
                'renderer' => $this->renderer,
                'shortcode' => $shortcode->getName(),
                'url' => $this->requestStack->getMasterRequest()->getRequestUri(),
            ]
        );

        try {
            return $this->fragmentHandler->render(
                new ControllerReference(
                    $this->controllerName,
                    array_merge(['request' => $this->requestStack->getCurrentRequest()], $shortcode->getParameters())
                ),
                $this->renderer
            );
        } catch (\InvalidArgumentException $exception) {
            if ('esi' === $this->renderer) {
                throw new \InvalidArgumentException(
                    'An InvalidArgumentException occured while trying to render the shortcode '
                    .$shortcode->getShortcodeText().'. You\'ve probably tried to use the ESI rendering  strategy for '

The method getShortcodeText() does not exist on Thunder\Shortcode\Shortcode\ShortcodeInterface. It seems like you code against a sub-type of Thunder\Shortcode\Shortcode\ShortcodeInterface such as Thunder\Shortcode\Shortcode\ProcessedShortcode.

                    .'your shortcodes while handling a request that contained non-scalar values as part of URI '
                    .'attributes. This can happen e.g. when using Param Converters for your original controller '
                    .'action, as the request (containing the conversion result) is automatically passed to the call of '
                    .'the shortcode controller to allow context sensitive shortcodes. You could use '
                    .'Webfactory\ShortcodeBundle\Handler\EmbeddedShortcodeHandler.inline as parent in your '
                    .'shortcode\'s service defintion, so that the inline instead of ESI rendering strategy will be '
                    .'used.',
                    0,
                    $exception
                );
            }

            throw $exception;
        }
    }
}