Class yii\smarty\ViewRenderer
| Inheritance | yii\smarty\ViewRenderer » yii\base\ViewRenderer » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-smarty/blob/master/ViewRenderer.php |
SmartyViewRenderer allows you to use Smarty templates in views.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $cachePath | string | The directory or path alias pointing to where Smarty cache will be stored. | yii\smarty\ViewRenderer |
| $compilePath | string | The directory or path alias pointing to where Smarty compiled templates will be stored. | yii\smarty\ViewRenderer |
| $extensionClass | string | Extension class name | yii\smarty\ViewRenderer |
| $imports | array | Class imports similar to the use tag | yii\smarty\ViewRenderer |
| $options | array | Additional Smarty options | yii\smarty\ViewRenderer |
| $pluginDirs | array | Add additional directories to Smarty's search path for plugins. | yii\smarty\ViewRenderer |
| $widgets | array | Widget declarations | yii\smarty\ViewRenderer |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $smarty | \Smarty | The Smarty object used for rendering | yii\smarty\ViewRenderer |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Mechanism to pass a widget's tag name to the callback function. | yii\smarty\ViewRenderer |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| aliasHandler() | Resolves Yii alias into file path | yii\smarty\ViewRenderer |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Instantiates and configures the Smarty object. | yii\smarty\ViewRenderer |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view file. | yii\smarty\ViewRenderer |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| resolveTemplateDir() | The directory can be specified in Yii's standard convention using @, // and / prefixes or no prefix for view relative directories. | yii\smarty\ViewRenderer |
Property Details
$cachePath public property
The directory or path alias pointing to where Smarty cache will be stored.
public string $cachePath = '@runtime/Smarty/cache'$compilePath public property
The directory or path alias pointing to where Smarty compiled templates will be stored.
public string $compilePath = '@runtime/Smarty/compile'$extensionClass public property
Extension class name
public string $extensionClass = '\yii\smarty\Extension'$imports public property
Class imports similar to the use tag
public array $imports = []$options public property
Additional Smarty options
See also http://www.smarty.net/docs/en/api.variables.tpl.
public array $options = []$pluginDirs public property
Add additional directories to Smarty's search path for plugins.
public array $pluginDirs = []$smarty protected property
The Smarty object used for rendering
protected \Smarty $smarty = null$widgets public property
Widget declarations
public array $widgets = ['functions' => [], 'blocks' => []]Method Details
__call() public method
Mechanism to pass a widget's tag name to the callback function.
Using a magic function call would not be necessary if Smarty would support closures. Smarty closure support is announced for 3.2, until its release magic function calls are used to pass the tag name to the callback.
| public string __call ( $method, $args ) | ||
|---|---|---|
| $method | string | |
| $args | array | |
| throws | yii\base\InvalidConfigException | |
| throws | BadMethodCallException | |
aliasHandler() public method
Resolves Yii alias into file path
| public boolean|string aliasHandler ( $type, $name, &$content, &$modified, \Smarty $smarty ) | ||
|---|---|---|
| $type | string | |
| $name | string | |
| $content | string | |
| $modified | string | |
| $smarty | \Smarty | |
| return | boolean|string | Path to file or false if it's not found |
init() public method
Instantiates and configures the Smarty object.
| public void init ( ) |
|---|
render() public method
Renders a view file.
This method is invoked by yii\web\View whenever it tries to render a view. Child classes must implement this method to render the given view file.
| public string render ( $view, $file, $params ) | ||
|---|---|---|
| $view | yii\web\View | The view object used for rendering the file. |
| $file | string | The view file. |
| $params | array | The parameters to be passed to the view file. |
| return | string | The rendering result |
resolveTemplateDir() protected method
The directory can be specified in Yii's standard convention using @, // and / prefixes or no prefix for view relative directories.
| protected string resolveTemplateDir ( $dir ) | ||
|---|---|---|
| $dir | string | Directory name to be resolved |
| return | string | The resolved directory name |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-smarty-viewrenderer.html