nystudio107\crafttwigsandbox\web\SandboxView

Complexity

Total Complexity

8

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Importance

Changes	9
Bugs	0	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	renderString()	0	10	2
A	init()	0	8	2
A	renderObjectTemplate()	0	10	2
A	renderTemplate()	0	10	2

<?php

namespace nystudio107\crafttwigsandbox\web;

use Craft;
use craft\web\View;
use nystudio107\crafttwigsandbox\console\SandboxErrorHandler as ConsoleSandboxErrorHandler;
use nystudio107\crafttwigsandbox\twig\BlacklistSecurityPolicy;
use nystudio107\crafttwigsandbox\web\SandboxErrorHandler as WebSandboxErrorHandler;
use Throwable;
use Twig\Extension\SandboxExtension;
use Twig\Sandbox\SecurityPolicyInterface;

class SandboxView extends View
{
    // Public Properties
    // =========================================================================

    /**
     * @var SecurityPolicyInterface|null The security policy to use for the SandboxView
     */
    public ?SecurityPolicyInterface $securityPolicy = null;

    // Protected Properties
    // =========================================================================

    /**
     * @var WebSandboxErrorHandler|ConsoleSandboxErrorHandler|null The error handler to use for the SandboxView
     */
    protected WebSandboxErrorHandler|ConsoleSandboxErrorHandler|null $sandboxErrorHandler = null;

    // Public Methods
    // =========================================================================

    /**
     * @inheritDoc
     */
    public function init(): void
    {
        parent::init();
        $this->sandboxErrorHandler = Craft::$app->getRequest()->getIsConsoleRequest() ? new ConsoleSandboxErrorHandler() : new WebSandboxErrorHandler();
        // Use the passed in SecurityPolicy, or create a default security policy
        $this->securityPolicy = $this->securityPolicy ?? new BlacklistSecurityPolicy();
        // Add the SandboxExtension with our SecurityPolicy lazily via ::registerTwigExtension()
        $this->registerTwigExtension(new SandboxExtension($this->securityPolicy, true));

It seems like $this->securityPolicy can also be of type null; however, parameter $policy of Twig\Extension\SandboxExtension::__construct() does only seem to accept Twig\Sandbox\SecurityPolicyInterface, maybe add an additional type check?

    }

    /**
     * @inheritDoc
     */
    public function renderObjectTemplate(string $template, mixed $object, array $variables = [], string $templateMode = self::TEMPLATE_MODE_SITE): string
    {
        $result = '';

The assignment to $result is dead and can be removed.

        try {
            $result = parent::renderObjectTemplate($template, $object, $variables, $templateMode);
        } catch (Throwable $e) {
            $this->sandboxErrorHandler->handleException($e);

The method handleException() does not exist on null.

        }

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function renderString(string $template, array $variables = [], string $templateMode = self::TEMPLATE_MODE_SITE, bool $escapeHtml = false): string
    {
        $result = '';

The assignment to $result is dead and can be removed.

        try {
            $result = parent::renderString($template, $variables, $templateMode, $escapeHtml);
        } catch (Throwable $e) {
            $this->sandboxErrorHandler->handleException($e);
        }

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function renderTemplate(string $template, array $variables = [], ?string $templateMode = null): string
    {
        $result = '';

The assignment to $result is dead and can be removed.

        try {
            $result = parent::renderTemplate($template, $variables, $templateMode);
        } catch (Throwable $e) {
            $this->sandboxErrorHandler->handleException($e);
        }

        return $result;
    }
}