public array $blocks = null

public array $cacheStack = []

public yii\base\ViewContextInterface $context = null

public string $defaultExtension = 'php'

public array $dynamicPlaceholders = []

public mixed $params = []

[
    'tpl' => ['class' => 'yii\smarty\ViewRenderer'],
    'twig' => ['class' => 'yii\twig\ViewRenderer'],
]

public array $renderers = null

public yii\base\Theme|array|string $theme = null

public string|boolean getViewFile ( )

addDynamicPlaceholder() public method

Adds a placeholder for dynamic content.

This method is internally used.

public void addDynamicPlaceholder ( $placeholder, $statements )
$placeholder	string	The placeholder name
$statements	string	The PHP statements for generating the dynamic content

afterRender() public method

This method is invoked right after renderFile() renders a view file.

The default implementation will trigger the EVENT_AFTER_RENDER event. If you override this method, make sure you call the parent implementation first.

public void afterRender ( $viewFile, $params, &$output )
$viewFile	string	The view file being rendered.
$params	array	The parameter array passed to the render() method.
$output	string	The rendering result of the view file. Updates to this parameter will be passed back and returned by renderFile().

beforeRender() public method

This method is invoked right before renderFile() renders a view file.

The default implementation will trigger the EVENT_BEFORE_RENDER event. If you override this method, make sure you call the parent implementation first.

public boolean beforeRender ( $viewFile, $params )
$viewFile	string	The view file to be rendered.
$params	array	The parameter array passed to the render() method.
return	boolean	Whether to continue rendering the view file.

beginBlock() public method

Begins recording a block.

This method is a shortcut to beginning yii\widgets\Block

public yii\widgets\Block beginBlock ( $id, $renderInPlace = false )
$id	string	The block ID.
$renderInPlace	boolean	Whether to render the block content in place. Defaults to false, meaning the captured block will not be displayed.
return	yii\widgets\Block	The Block widget instance

beginCache() public method

Begins fragment caching.

This method will display cached content if it is available. If not, it will start caching and would expect an endCache() call to end the cache and save the content into cache. A typical usage of fragment caching is as follows,

if ($this->beginCache($id)) {
    // ...generate content here
    $this->endCache();
}

public boolean beginCache ( $id, $properties = [] )
$id	string	A unique ID identifying the fragment to be cached.
$properties	array	Initial property values for yii\widgets\FragmentCache
return	boolean	Whether you should generate the content for caching. False if the cached version is available.

beginContent() public method

Begins the rendering of content that is to be decorated by the specified view.

This method can be used to implement nested layout. For example, a layout can be embedded in another layout file specified as '@app/views/layouts/base.php' like the following:

<?php $this->beginContent('@app/views/layouts/base.php'); ?>
//...layout content here...
<?php $this->endContent(); ?>

See also yii\widgets\ContentDecorator.

public yii\widgets\ContentDecorator beginContent ( $viewFile, $params = [] )
$viewFile	string	The view file that will be used to decorate the content enclosed by this widget. This can be specified as either the view file path or path alias.
$params	array	The variables (name => value) to be extracted and made available in the decorative view.
return	yii\widgets\ContentDecorator	The ContentDecorator widget instance

beginPage() public method

Marks the beginning of a page.

public void beginPage ( )

endBlock() public method

Ends recording a block.

public void endBlock ( )

endCache() public method

Ends fragment caching.

public void endCache ( )

endContent() public method

Ends the rendering of content.

public void endContent ( )

endPage() public method

Marks the ending of a page.

public void endPage ( )

evaluateDynamicContent() public method

Evaluates the given PHP statements.

This method is mainly used internally to implement dynamic content feature.

public mixed evaluateDynamicContent ( $statements )
$statements	string	The PHP statements to be evaluated.
return	mixed	The return value of the PHP statements.

findViewFile() protected method

Finds the view file based on the given view name.

protected string findViewFile ( $view, $context = null )
$view	string	The view name or the path alias of the view file. Please refer to render() on how to specify this parameter.
$context	object	The context to be assigned to the view and can later be accessed via $context in the view. If the context implements yii\base\ViewContextInterface, it may also be used to locate the view file corresponding to a relative view name.
return	string	The view file path. Note that the file may not exist.
throws	yii\base\InvalidCallException	if a relative view name is given while there is no active context to determine the corresponding view file.

getViewFile() public method

public string|boolean getViewFile ( )
return	string|boolean	The view file currently being rendered. False if no view file is being rendered.

init() public method

Initializes the view component.

public void init ( )

render() public method

Renders a view.

The view to be rendered can be specified in one of the following formats:

• path alias (e.g. "@app/views/site/index");
• absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the view path of the application.
• absolute path within current module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the view path of the current module.
• relative view (e.g. "index"): the view name does not start with @ or /. The corresponding view file will be looked for under the view path of the view $context. If $context is not given, it will be looked for under the directory containing the view currently being rendered (i.e., this happens when rendering a view within another view).

See also renderFile().

public string render ( $view, $params = [], $context = null )
$view	string	The view name.
$params	array	The parameters (name-value pairs) that will be extracted and made available in the view file.
$context	object	The context to be assigned to the view and can later be accessed via $context in the view. If the context implements yii\base\ViewContextInterface, it may also be used to locate the view file corresponding to a relative view name.
return	string	The rendering result
throws	yii\base\ViewNotFoundException	if the view file does not exist.
throws	yii\base\InvalidCallException	if the view cannot be resolved.

renderDynamic() public method

Renders dynamic content returned by the given PHP statements.

This method is mainly used together with content caching (fragment caching and page caching) when some portions of the content (called dynamic content) should not be cached. The dynamic content must be returned by some PHP statements.

public string renderDynamic ( $statements )
$statements	string	The PHP statements for generating the dynamic content.
return	string	The placeholder of the dynamic content, or the dynamic content if there is no active content cache currently.

renderFile() public method

Renders a view file.

If $theme is enabled (not null), it will try to render the themed version of the view file as long as it is available.

The method will call yii\helpers\FileHelper::localize() to localize the view file.

If renderer is enabled (not null), the method will use it to render the view file. Otherwise, it will simply include the view file as a normal PHP file, capture its output and return it as a string.

public string renderFile ( $viewFile, $params = [], $context = null )
$viewFile	string	The view file. This can be either an absolute file path or an alias of it.
$params	array	The parameters (name-value pairs) that will be extracted and made available in the view file.
$context	object	The context that the view should use for rendering the view. If null, existing $context will be used.
return	string	The rendering result
throws	yii\base\ViewNotFoundException	if the view file does not exist

renderPhpFile() public method

Renders a view file as a PHP script.

This method treats the view file as a PHP script and includes the file. It extracts the given parameters and makes them available in the view file. The method captures the output of the included view file and returns it as a string.

This method should mainly be called by view renderer or renderFile().

public string renderPhpFile ( $_file_, $_params_ = [] )
$_file_	string	The view file.
$_params_	array	The parameters (name-value pairs) that will be extracted and made available in the view file.
return	string	The rendering result