Yiisoft\View\View

Complexity

Total Complexity

6

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	createAfterRenderEvent()	0	6	1
A	createBeforeRenderEvent()	0	3	1
A	endPage()	0	5	1
A	beginPage()	0	5	1
A	withClearedState()	0	6	1
A	__construct()	0	8	1

<?php

declare(strict_types=1);

namespace Yiisoft\View;

use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\EventDispatcher\StoppableEventInterface;
use Yiisoft\View\Event\AfterRenderEventInterface;
use Yiisoft\View\Event\View\AfterRender;
use Yiisoft\View\Event\View\BeforeRender;
use Yiisoft\View\Event\View\PageBegin;
use Yiisoft\View\Event\View\PageEnd;
use Yiisoft\View\State\LocaleState;
use Yiisoft\View\State\ThemeState;
use Yiisoft\View\State\ViewState;

use function ob_end_flush;
use function ob_implicit_flush;
use function ob_start;

/**
 * `View` represents an instance of a view for use in an any environment.
 *
 * `View` provides a set of methods (e.g. {@see View::render()}) for rendering purpose.
 */
final class View implements ViewInterface
{
    use ViewTrait;

    private ViewState $state;
    private LocaleState $localeState;
    private ThemeState $themeState;

    /**
     * @param string $basePath The full path to the base directory of views.
     * @param EventDispatcherInterface $eventDispatcher The event dispatcher instance.
     */
    public function __construct(string $basePath, EventDispatcherInterface $eventDispatcher)
    {
        $this->basePath = $basePath;
        $this->state = new ViewState();
        $this->localeState = new LocaleState();
        $this->themeState = new ThemeState();
        $this->eventDispatcher = $eventDispatcher;
        $this->setPlaceholderSalt(__DIR__);
    }

    /**
     * Returns a new instance with cleared state (blocks, parameters, etc.)
     */
    public function withClearedState(): static
    {
        $new = clone $this;
        $new->state = new ViewState();
        $new->localeState = new LocaleState();
        return $new;
    }

    /**
     * Marks the beginning of a view.
     */
    public function beginPage(): void
    {
        ob_start();
        ob_implicit_flush(false);
        $this->eventDispatcher->dispatch(new PageBegin($this));
    }

    /**
     * Marks the ending of a view.
     */
    public function endPage(): void
    {
        $this->eventDispatcher->dispatch(new PageEnd($this));

        ob_end_flush();
    }

    protected function createBeforeRenderEvent(string $viewFile, array $parameters): StoppableEventInterface
    {
        return new BeforeRender($this, $viewFile, $parameters);
    }

    protected function createAfterRenderEvent(
        string $viewFile,
        array $parameters,
        string $result
    ): AfterRenderEventInterface {
        return new AfterRender($this, $viewFile, $parameters, $result);
    }
}