App\ViewRenderer\CsrfInjection

Complexity

Total Complexity

7

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	withParameter()	0	5	1
A	withMetaAttribute()	0	5	1
A	getCsrfToken()	0	6	2
A	withRequestAttribute()	0	5	1
A	getParams()	0	13	1

<?php

declare(strict_types=1);

namespace App\ViewRenderer;

use Yiisoft\Router\UrlMatcherInterface;
use Yiisoft\View\WebView;
use Yiisoft\Yii\Web\Middleware\Csrf;

class CsrfInjection implements InjectionInterface
{
    public const DEFAULT_META_ATTRIBUTE = 'csrf';
    public const DEFAULT_PARAMETER = 'csrf';

    private UrlMatcherInterface $urlMatcher;
    private WebView $view;

    private string $requestAttribute = Csrf::REQUEST_NAME;
    private string $metaAttribute = self::DEFAULT_META_ATTRIBUTE;
    private string $parameter = self::DEFAULT_PARAMETER;

    public function __construct(
        UrlMatcherInterface $urlMatcher,
        WebView $view
    ) {
        $this->urlMatcher = $urlMatcher;
        $this->view = $view;
    }

    public function withRequestAttribute(string $requestAttribute): self
    {
        $clone = clone $this;
        $clone->requestAttribute = $requestAttribute;
        return $clone;
    }

    public function withParameter(string $parameter): self
    {
        $clone = clone $this;
        $clone->parameter = $parameter;
        return $clone;
    }

    public function withMetaAttribute(string $metaAttribute): self
    {
        $clone = clone $this;
        $clone->metaAttribute = $metaAttribute;
        return $clone;
    }

    public function getParams(): array
    {
        $csrfToken = $this->getCsrfToken();

        $this->view->registerMetaTag(
            [
                'name' => $this->metaAttribute,
                'content' => $this->csrfToken,
            ],
            'csrf_meta_tags'
        );

        return [$this->parameter => $csrfToken];
    }

    private ?string $csrfToken = null;

    private function getCsrfToken(): string
    {
        if ($this->csrfToken === null) {
            $this->csrfToken = $this->urlMatcher->getLastMatchedRequest()->getAttribute($this->requestAttribute);
        }
        return $this->csrfToken;

The expression return $this->csrfToken could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }
}