RenderManager.php

<?php declare(strict_types=1);

namespace Computator\FrameworkUtils\PHPTemplate\UserApi;

use Computator\FrameworkUtils\PHPTemplate\RenderObjects;
use Computator\FrameworkUtils\PHPTemplate\Templates;

/**
 * Internal interface to a `Renderer`.
 *
 * These methods are meant for internal use to control the rendering process and
 * are not intended for use by end-users.
 *
 * @see RenderClient The end-user interface to a `Renderer` intended for public use.
 */
interface RenderManager {
	public function getTemplateAsProxy(string $template): RenderObjects\TemplateRenderProxy;

	public function getTemplateInstanceAsProxyById(int $orig_proxy_id): ?RenderObjects\TemplateRenderProxy;

	/** @param array<string,mixed> $context */
	public function renderProxiedTemplate(RenderObjects\TemplateRenderProxy $proxy, array $context): void;

	public function renderError(Templates\PHPString|Templates\Text|string $error): void;

	public function setParentForTemplate(Templates\Base $tpl, string $parent_template): void;

	public function startRenderingBlock(Templates\Base $tpl, string $block_name): void;

	public function endRenderingBlock(Templates\Base $tpl): void;

	public function renderChildBlock(Templates\Base $tpl, string $block_name): bool;

	public function renderChildContent(Templates\Base $tpl): void;

	public function setInsertionPoint(string $insert_name): void;

	public function startAppendingToInsertionPoint(string $insert_name): void;

	public function stopAppendingToInsertionPoint(): void;
}