Yiisoft\View\Event\WebView\BeforeRender

Complexity

Total Complexity

6

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Test Coverage

Coverage

81.25%

Importance

Changes	1
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	isPropagationStopped()	0	3	1
A	getParameters()	0	3	1
A	stopPropagation()	0	3	1
A	getView()	0	3	1
A	getFile()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\View\Event\WebView;

use Psr\EventDispatcher\StoppableEventInterface;
use Yiisoft\View\WebView;

/**
 * `BeforeRender` event is triggered by {@see WebView::renderFile()} right before it renders a view file.
 */
class BeforeRender implements StoppableEventInterface
{
    private WebView $view;

    /**
     * @var string The view file being rendered.
     */
    private string $file;

    /**
     * @var array The parameters array passed to the {@see WebView::render()} or {@see WebView::renderFile()} method.
     */
    private array $parameters;

    private bool $stopPropagation = false;

    public function __construct(WebView $view, string $file, array $parameters)
    {
        $this->view = $view;
        $this->file = $file;
        $this->parameters = $parameters;
    }

    public function stopPropagation(): void
    {
        $this->stopPropagation = true;
    }

    public function isPropagationStopped(): bool
    {
        return $this->stopPropagation;
    }

    public function getView(): WebView
    {
        return $this->view;
    }

    public function getFile(): string
    {
        return $this->file;
    }

    public function getParameters(): array
    {
        return $this->parameters;
    }
}