74 lines
2.4 KiB
PHP
74 lines
2.4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of CodeIgniter 4 framework.
|
|
*
|
|
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
|
*
|
|
* For the full copyright and license information, please view
|
|
* the LICENSE file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace CodeIgniter\View;
|
|
|
|
/**
|
|
* Interface RendererInterface
|
|
*
|
|
* The interface used for displaying Views and/or theme files.
|
|
*/
|
|
interface RendererInterface
|
|
{
|
|
/**
|
|
* Builds the output based upon a file name and any
|
|
* data that has already been set.
|
|
*
|
|
* @param array $options Reserved for 3rd-party uses since
|
|
* it might be needed to pass additional info
|
|
* to other template engines.
|
|
* @param bool $saveData Whether to save data for subsequent calls
|
|
*/
|
|
public function render(string $view, ?array $options = null, bool $saveData = false): string;
|
|
|
|
/**
|
|
* Builds the output based upon a string and any
|
|
* data that has already been set.
|
|
*
|
|
* @param string $view The view contents
|
|
* @param array $options Reserved for 3rd-party uses since
|
|
* it might be needed to pass additional info
|
|
* to other template engines.
|
|
* @param bool $saveData Whether to save data for subsequent calls
|
|
*/
|
|
public function renderString(string $view, ?array $options = null, bool $saveData = false): string;
|
|
|
|
/**
|
|
* Sets several pieces of view data at once.
|
|
*
|
|
* @param string $context The context to escape it for: html, css, js, url
|
|
* If 'raw', no escaping will happen
|
|
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
|
|
*
|
|
* @return RendererInterface
|
|
*/
|
|
public function setData(array $data = [], ?string $context = null);
|
|
|
|
/**
|
|
* Sets a single piece of view data.
|
|
*
|
|
* @param mixed $value
|
|
* @param string $context The context to escape it for: html, css, js, url
|
|
* If 'raw' no escaping will happen
|
|
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
|
|
*
|
|
* @return RendererInterface
|
|
*/
|
|
public function setVar(string $name, $value = null, ?string $context = null);
|
|
|
|
/**
|
|
* Removes all of the view data from the system.
|
|
*
|
|
* @return RendererInterface
|
|
*/
|
|
public function resetData();
|
|
}
|