DynamicContentAwareTrait

API reference › yii › base › DynamicContentAwareTrait

trait	yii\base\DynamicContentAwareTrait
Since	2.0.14
Source	framework/base/DynamicContentAwareTrait.php

Used by 2 types

• yii\filters\PageCache
• yii\widgets\FragmentCache

DynamicContentAwareTrait implements common methods for classes which support a View dynamic content feature.

Methods

Method	Description	Defined by
addDynamicPlaceholder()	Adds a placeholder for dynamic content.	DynamicContentAwareTrait
getDynamicPlaceholders()	Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.	DynamicContentAwareTrait
setDynamicPlaceholders()	Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.	DynamicContentAwareTrait
getView() protected abstract	Returns the view object that can be used to render views or view files using dynamic contents.	DynamicContentAwareTrait
updateDynamicContent() protected	Replaces placeholders in $content with results of evaluated dynamic statements.	DynamicContentAwareTrait

Method details

addDynamicPlaceholder()

public function addDynamicPlaceholder(mixed $name, mixed $statements): mixed

Adds a placeholder for dynamic content.

This method is used internally to implement the content caching feature.

Parameters

Parameter	Type	Description
$name	mixed	The placeholder name.
$statements	mixed	The PHP statements for generating the dynamic content.

Returns

mixed

getDynamicPlaceholders()

public function getDynamicPlaceholders(): array

Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.

Returns

array: A list of placeholders.

setDynamicPlaceholders()

public function setDynamicPlaceholders(mixed $placeholders): mixed

Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.

Parameters

Parameter	Type	Description
$placeholders	mixed	A list of placeholders.

Returns

mixed

getView()

abstract protected function getView(): yii\base\View

Returns the view object that can be used to render views or view files using dynamic contents.

Returns

View: The view object that can be used to render views or view files.

updateDynamicContent()

protected function updateDynamicContent(string $content, string[] $placeholders, bool $isRestoredFromCache = false): string

Replaces placeholders in $content with results of evaluated dynamic statements.

Parameters

Parameter	Type	Description
$content	string	Content to be parsed.
$placeholders	string[]	Placeholders and their values.
$isRestoredFromCache	bool	Whether content is going to be restored from cache.

Returns

string: Final content.