Trait Yiisoft\View\ViewTrait

                public function addToParameter(string $id, mixed ...$value): static
{
    $this->state->addToParameter($id, ...$value);
    return $this;
}

            

                public function clear(): void
{
    $this->viewFiles = [];
    $this->state->clear();
    $this->localeState = new LocaleState();
    $this->themeState = new ThemeState();
}

            

                abstract protected function createAfterRenderEvent(
    string $viewFile,
    array $parameters,
    string $result,
): AfterRenderEventInterface;

            

                abstract protected function createBeforeRenderEvent(string $viewFile, array $parameters): StoppableEventInterface;

            

                public function getBasePath(): string
{
    if ($this->basePath === null) {
        throw new LogicException('The base path is not set.');
    }
    return $this->basePath;
}

            

                public function getBlock(string $id): string
{
    return $this->state->getBlock($id);
}

            

                public function getFallbackExtensions(): array
{
    return $this->fallbackExtensions;
}

            

                public function getLocale(): string
{
    return $this->localeState->getLocale();
}

            

                public function getParameter(string $id, mixed ...$default): mixed
{
    return $this->state->getParameter($id, ...$default);
}

            

                public function getPlaceholderSignature(): string
{
    return $this->placeholderSignature;
}

            

                public function getTheme(): ?Theme
{
    return $this->themeState->getTheme();
}

            

                public function getViewFile(): ?string
{
    /** @psalm-suppress InvalidArrayOffset */
    return empty($this->viewFiles) ? null : end($this->viewFiles)['resolved'];
}

            

                public function hasBlock(string $id): bool
{
    return $this->state->hasBlock($id);
}

            

                public function hasParameter(string $id): bool
{
    return $this->state->hasParameter($id);
}

            

                public function localize(string $file, ?string $locale = null, ?string $sourceLocale = null): string
{
    $locale ??= $this->localeState->getLocale();
    $sourceLocale ??= $this->sourceLocale;
    if ($locale === $sourceLocale) {
        return $file;
    }
    $desiredFile = dirname($file) . DIRECTORY_SEPARATOR . $locale . DIRECTORY_SEPARATOR . basename($file);
    if (is_file($desiredFile)) {
        return $desiredFile;
    }
    $locale = substr($locale, 0, 2);
    if ($locale === $sourceLocale) {
        return $file;
    }
    $desiredFile = dirname($file) . DIRECTORY_SEPARATOR . $locale . DIRECTORY_SEPARATOR . basename($file);
    return is_file($desiredFile) ? $desiredFile : $file;
}

            

                public function removeBlock(string $id): static
{
    $this->state->removeBlock($id);
    return $this;
}

            

                public function removeParameter(string $id): static
{
    $this->state->removeParameter($id);
    return $this;
}

            

                public function render(string $view, array $parameters = []): string
{
    $viewFile = $this->findTemplateFile($view);
    $parameters = array_merge($this->state->getParameters(), $parameters);
    // TODO: these two match now
    $requestedFile = $viewFile;
    $theme = $this->getTheme();
    if ($theme !== null) {
        $viewFile = $theme->applyTo($viewFile);
    }
    if (is_file($viewFile)) {
        $viewFile = $this->localize($viewFile);
    } else {
        throw new ViewNotFoundException("The view file \"$viewFile\" does not exist.");
    }
    $output = '';
    $this->viewFiles[] = [
        'resolved' => $viewFile,
        'requested' => $requestedFile,
    ];
    if ($this->beforeRender($viewFile, $parameters)) {
        $output = $this->getRenderer($viewFile)->render($this, $viewFile, $parameters);
        $output = $this->afterRender($viewFile, $parameters, $output);
    }
    array_pop($this->viewFiles);
    return $output;
}

            

                public function setBlock(string $id, string $content): static
{
    $this->state->setBlock($id, $content);
    return $this;
}

            

                public function setLocale(string $locale): static
{
    $this->localeState->setLocale($locale);
    return $this;
}

            

                public function setParameter(string $id, mixed $value): static
{
    $this->state->setParameter($id, $value);
    return $this;
}

            

                public function setParameters(array $parameters): static
{
    $this->state->setParameters($parameters);
    return $this;
}

            

                public function setTheme(?Theme $theme): static
{
    $this->themeState->setTheme($theme);
    return $this;
}

            

                public function withBasePath(?string $basePath): static
{
    $new = clone $this;
    $new->basePath = $basePath;
    return $new;
}

            

                public function withContext(?ViewContextInterface $context): static
{
    $new = clone $this;
    $new->context = $context;
    $new->viewFiles = [];
    return $new;
}

            

                public function withContextPath(string $path): static
{
    return $this->withContext(new ViewContext($path));
}

            

                public function withFallbackExtension(string $fallbackExtension, string ...$otherFallbacks): static
{
    $new = clone $this;
    $new->fallbackExtensions = [$fallbackExtension, ...array_values($otherFallbacks)];
    return $new;
}

            

                public function withLocale(string $locale): static
{
    $new = clone $this;
    $new->localeState = new LocaleState($locale);
    return $new;
}

            

                public function withPlaceholderSalt(string $salt): static
{
    $new = clone $this;
    $new->setPlaceholderSalt($salt);
    return $new;
}

            

                public function withRenderers(array $renderers): static
{
    foreach ($renderers as $extension => $renderer) {
        /** @psalm-suppress DocblockTypeContradiction */
        if (!is_string($extension)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Extension must be a non-empty string, %s provided for %s.',
                    get_debug_type($extension),
                    $renderer::class,
                ),
            );
        }
        $rendererType = get_debug_type($renderer);
        if ($extension === '') {
            throw new InvalidArgumentException(
                sprintf(
                    'Empty extension is not supported. Please add extension for %s.',
                    $rendererType,
                ),
            );
        }
        /** @psalm-suppress DocblockTypeContradiction */
        if (!is_object($renderer) || !$renderer instanceof TemplateRendererInterface) {
            throw new InvalidArgumentException(
                sprintf(
                    'Renderer %s is not an instance of %s.',
                    $rendererType,
                    TemplateRendererInterface::class,
                ),
            );
        }
    }
    uksort(
        $renderers,
        static fn(string $a, string $b): int => strlen($b) <=> strlen($a),
    );
    $new = clone $this;
    $new->renderers = $renderers;
    return $new;
}

            

                public function withSourceLocale(string $locale): static
{
    $new = clone $this;
    $new->sourceLocale = $locale;
    return $new;
}

            

                public function withTheme(?Theme $theme): static
{
    $new = clone $this;
    $new->themeState = new ThemeState($theme);
    return $new;
}