Класс yii\smarty\ViewRenderer
| Наследование | yii\smarty\ViewRenderer » yii\base\ViewRenderer » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-smarty/blob/master/ViewRenderer.php |
SmartyViewRenderer позволяет использовать шаблоны Smarty в представлениях.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединённых к данному компоненту поведений | yii\base\Component |
| $cachePath | строка | Директория или псевдоним пути, указывающий, где будет храниться кэш Smarty. | yii\smarty\ViewRenderer |
| $compilePath | строка | Директория или псевдоним пути, указывающий, где будут храниться скомпилированные шаблоны Smarty. | yii\smarty\ViewRenderer |
| $extensionClass | строка | Имя класса расширения | yii\smarty\ViewRenderer |
| $imports | массив | Импорты классов, аналогичные тегу use | yii\smarty\ViewRenderer |
| $options | массив | Дополнительные параметры Smarty | yii\smarty\ViewRenderer |
| $pluginDirs | массив | Добавление дополнительных директорий в путь поиска плагинов Smarty. | yii\smarty\ViewRenderer |
| $widgets | массив | Объявления виджетов | yii\smarty\ViewRenderer |
Защищённые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $smarty | \Smarty | Объект Smarty, используемый для рендеринга | yii\smarty\ViewRenderer |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Механизм для передачи имени тега виджета в функцию обратного вызова. | yii\smarty\ViewRenderer |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| aliasHandler() | Разрешает псевдоним Yii в путь к файлу | yii\smarty\ViewRenderer |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к заданному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует и настраивает объект Smarty. | yii\smarty\ViewRenderer |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Отображает файл представления. | yii\smarty\ViewRenderer |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| resolveTemplateDir() | Директория может быть указана с помощью стандартной конвенции Yii с использованием префиксов @, // и / или без префикса для относительных директорий представлений. | yii\smarty\ViewRenderer |
Подробности свойств
$cachePath общедоступное свойство
Директория или псевдоним пути, указывающий, где будет храниться кэш Smarty.
public string $cachePath = '@runtime/Smarty/cache'
$compilePath общедоступное свойство
Директория или псевдоним пути, указывающий, где будут храниться скомпилированные шаблоны Smarty.
public string $compilePath = '@runtime/Smarty/compile'
$extensionClass общедоступное свойство
Имя класса расширения
public string $extensionClass = '\yii\smarty\Extension'
$imports общедоступное свойство
Импорты классов, аналогичные тегу use
public array $imports = []
$options общедоступное свойство
Дополнительные параметры Smarty
См. также http://www.smarty.net/docs/en/api.variables.tpl.
public array $options = []
$pluginDirs общественное свойство
Добавление дополнительных каталогов в путь поиска плагинов Smarty.
public array $pluginDirs = []
$smarty защищенное свойство
Объект Smarty, используемый для рендеринга
protected \Smarty $smarty = null
$widgets общественное свойство
Объявления виджетов
public array $widgets = ['functions' => [], 'blocks' => []]
Подробное описание методов
__call() общественный метод
Механизм передачи имени тега виджета в функцию обратного вызова.
Использование магической функции вызова не потребовалось бы, если бы Smarty поддерживал замыкания. Поддержка замыканий Smarty анонсирована для версии 3.2, до её выхода используются магические вызовы функций для передачи имени тега в обратный вызов.
| public строка __call ( $method, $args ) | ||
|---|---|---|
| $method | строка | |
| $args | массив | |
| throws | yii\base\InvalidConfigException | |
| throws | BadMethodCallException | |
aliasHandler() общественный метод
Разрешает псевдоним Yii в путь к файлу
| public boolean|строка aliasHandler ( $type, $name, &$content, &$modified, \Smarty $smarty ) | ||
|---|---|---|
| $type | строка | |
| $name | строка | |
| $content | строка | |
| $modified | строка | |
| $smarty | \Smarty | |
| return | boolean|строка |
Путь к файлу или false, если он не найден |
init() общественный метод
Инициализирует и настраивает объект Smarty.
| public void init ( ) |
|---|
render() общественный метод
Отображает файл представления.
Этот метод вызывается yii\web\View всякий раз, когда он пытается отобразить представление. Дочерние классы должны реализовывать этот метод для отображения указанного файла представления.
| public строка render ( $view, $file, $params ) | ||
|---|---|---|
| $view | yii\web\View |
Объект представления, используемый для отображения файла. |
| $file | строка |
Файл представления. |
| $params | массив |
Параметры, которые необходимо передать в файл представления. |
| return | строка |
Результат рендеринга |
resolveTemplateDir() защищенный метод
Каталог можно указать в соответствии со стандартной конвенцией Yii, используя префиксы @, // и /, или без префикса для каталогов, относительных к представлению.
| protected строка resolveTemplateDir ( $dir ) | ||
|---|---|---|
| $dir | строка |
Имя каталога, подлежащее разрешению |
| return | строка |
Разрешенное имя каталога |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-smarty-viewrenderer.html
