Trait yii\base\DynamicContentAwareTrait
| Implemented by | yii\filters\PageCache, yii\widgets\FragmentCache |
|---|---|
| Available since version | 2.0.14 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/base/DynamicContentAwareTrait.php |
DynamicContentAwareTrait implements common methods for classes which support a yii\base\View dynamic content feature.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| addDynamicPlaceholder() | Adds a placeholder for dynamic content. | yii\base\DynamicContentAwareTrait |
| getDynamicPlaceholders() | Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature. | yii\base\DynamicContentAwareTrait |
| setDynamicPlaceholders() | Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature. | yii\base\DynamicContentAwareTrait |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| getView() | Returns the view object that can be used to render views or view files using dynamic contents. | yii\base\DynamicContentAwareTrait |
| updateDynamicContent() | Replaces placeholders in $content with results of evaluated dynamic statements. | yii\base\DynamicContentAwareTrait |
Method Details
Adds a placeholder for dynamic content.
This method is used internally to implement the content caching feature.
| public void addDynamicPlaceholder ( $name, $statements ) | ||
| $name | string | The placeholder name. |
| $statements | string | The PHP statements for generating the dynamic content. |
Returns a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.
| public array getDynamicPlaceholders ( ) | ||
| return | array | A list of placeholders. |
|---|---|---|
Returns the view object that can be used to render views or view files using dynamic contents.
| protected abstract yii\base\View getView ( ) | ||
| return | yii\base\View | The view object that can be used to render views or view files. |
|---|---|---|
Sets a list of placeholders for dynamic content. This method is used internally to implement the content caching feature.
| public void setDynamicPlaceholders ( $placeholders ) | ||
| $placeholders | array | A list of placeholders. |
Replaces placeholders in $content with results of evaluated dynamic statements.
| protected string updateDynamicContent ( $content, $placeholders, $isRestoredFromCache = false ) | ||
| $content | string | Content to be parsed. |
| $placeholders | string[] | Placeholders and their values. |
| $isRestoredFromCache | boolean | Whether content is going to be restored from cache. |
| return | string | Final content. |
|---|---|---|