Класс yii\twig\ViewRenderer
| Наследование | yii\twig\ViewRenderer » yii\base\ViewRenderer » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-twig/blob/master/ViewRenderer.php |
TwigViewRenderer позволяет использовать шаблоны Twig в представлениях.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений | yii\base\Component |
| $cachePath | string | Директория или псевдоним пути к месту хранения кэша Twig. | yii\twig\ViewRenderer |
| $extensions | array | Пользовательские расширения. | yii\twig\ViewRenderer |
| $filters | array | Пользовательские фильтры. | yii\twig\ViewRenderer |
| $functions | array | Пользовательские функции. | yii\twig\ViewRenderer |
| $globals | array | Глобальные переменные. | yii\twig\ViewRenderer |
| $lexerOptions | array | Параметры разборчика Twig. | yii\twig\ViewRenderer |
| $options | array | Параметры Twig. | yii\twig\ViewRenderer |
| $twig | \Twig_Environment | Объект среды Twig, который рендерит шаблоны Twig. | yii\twig\ViewRenderer |
| $twigFallbackPaths | array | Пути обратной загрузки Twig. | yii\twig\ViewRenderer |
| $twigModulesNamespace | string | Пространство имён Twig для использования в шаблонах модулей. | yii\twig\ViewRenderer |
| $twigViewsNamespace | string | Пространство имён Twig для использования в шаблонах. | yii\twig\ViewRenderer |
| $twigWidgetsNamespace | string | Пространство имён Twig для использования в шаблонах виджетов. | yii\twig\ViewRenderer |
| $uses | array | Пространства имён и классы для импорта. | yii\twig\ViewRenderer |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызов метода, который не является методом класса. | yii\base\Object |
| __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 |
| addExtensions() | Добавляет пользовательские расширения | yii\twig\ViewRenderer |
| addFilters() | Добавляет пользовательские фильтры | yii\twig\ViewRenderer |
| addFunctions() | Добавляет пользовательские функции | yii\twig\ViewRenderer |
| addGlobals() | Добавляет глобальные объекты или статические классы | yii\twig\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() | yii\twig\ViewRenderer | |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Отображает файл представления. | yii\twig\ViewRenderer |
| setLexerOptions() | Устанавливает параметры Twig-лексера для изменения синтаксиса шаблонов | yii\twig\ViewRenderer |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| addAliases() | Добавляет псевдонимы | yii\twig\ViewRenderer |
| addFallbackPaths() | Добавляет пути к резервным шаблонам для загрузчика twig | yii\twig\ViewRenderer |
Подробное описание свойств
$cachePath общедоступное свойство
Директория или псевдоним пути к месту хранения кэша Twig. Установите в false, чтобы отключить кэширование шаблонов.
public string $cachePath = '@runtime/Twig/cache'
$extensions общедоступное свойство
Пользовательские расширения. Пример: ['Twig_Extension_Sandbox', new \Twig_Extension_Text()]
public array $extensions = []
$filters общедоступное свойство
Пользовательские фильтры. Ключи массива — имена для вызова в шаблоне, значения — имена функций или статических методов какого-либо класса. Пример: ['rot13' => 'str_rot13', 'jsonEncode' => '\yii\helpers\Json::encode']. В шаблоне можно использовать его так: {{ 'test'|rot13 }} или {{ model|jsonEncode }}.
public array $filters = []
$functions общедоступное свойство
Пользовательские функции. Ключи массива — имена для вызова в шаблоне, значения — имена функций или статических методов какого-либо класса. Пример: ['rot13' => 'str_rot13', 'a' => '\yii\helpers\Html::a']. В шаблоне можно использовать его так: {{ rot13('test') }} или {{ a('Login', 'site/login') | raw }}.
public array $functions = []
$globals общедоступное свойство
Глобальные переменные. Ключи массива — имена для вызова в шаблоне, значения — скаляры, объекты или имена статических классов. Пример: ['html' => ['class' => '\yii\helpers\Html'], 'debug' => YII_DEBUG]. В шаблоне можно использовать его так: {{ html.a('Login', 'site/login') | raw }}.
public array $globals = []
$lexerOptions общедоступное только для записи свойство
Параметры Twig-лексера.
Пример: синтаксис по типу Smarty: `php [
'tag_comment' => ['{*', '*}'],
'tag_block' => ['{', '}'],
'tag_variable' => ['{$', '}']
] `
См. также http://twig.sensiolabs.org/doc/recipes.html#customizing-the-syntax.
public void setLexerOptions ( $options )
$options общедоступное свойство
Параметры Twig.
См. также http://twig.sensiolabs.org/doc/api.html#environment-options.
public array $options = []
$twig общедоступное свойство
Объект среды Twig, который отображает twig-шаблоны
public \Twig_Environment $twig = null
$twigFallbackPaths общедоступное свойство (доступно начиная с версии 2.0.5)
Пути к резервным шаблонам Twig
public array $twigFallbackPaths = []
$twigModulesNamespace общедоступное свойство (доступно начиная с версии 2.0.5)
Пространство имён Twig для использования в шаблонах модулей
public string $twigModulesNamespace = 'modules'
$twigViewsNamespace общедоступное свойство (доступно начиная с версии 2.0.5)
Пространство имён Twig для использования в шаблонах
public string $twigViewsNamespace = \Twig_Loader_Filesystem::MAIN_NAMESPACE
$twigWidgetsNamespace общедоступное свойство (доступно начиная с версии 2.0.5)
Пространство имён Twig для использования в шаблонах виджетов
public string $twigWidgetsNamespace = 'widgets'
$uses общедоступное свойство
Пространства имён и классы для импорта.
Пример:
[
'yii\bootstrap',
'app\assets',
\yii\bootstrap\NavBar::className(),
]
public array $uses = []
Подробное описание методов
addAliases() protected method
Добавляет псевдонимы
| protected void addAliases ( $loader, $aliases ) | ||
|---|---|---|
| $loader | \Twig_Loader_Filesystem | |
| $aliases | массив | |
addExtensions() public method
Добавляет пользовательские расширения
| public void addExtensions ( $extensions ) | ||
|---|---|---|
| $extensions | массив |
@see self::$extensions |
addFallbackPaths() protected method (доступно начиная с версии 2.0.5)
Добавляет пути по умолчанию для загрузчика twig
| protected void addFallbackPaths ( $loader, $theme ) | ||
|---|---|---|
| $loader | \Twig_Loader_Filesystem | |
| $theme | yii\base\Theme|null | |
addFilters() public method
Добавляет пользовательские фильтры
| public void addFilters ( $filters ) | ||
|---|---|---|
| $filters | массив |
@see self::$filters |
addFunctions() public method
Добавляет пользовательские функции
| public void addFunctions ( $functions ) | ||
|---|---|---|
| $functions | массив |
@see self::$functions |
addGlobals() public method
Добавляет глобальные объекты или статические классы
| public void addGlobals ( $globals ) | ||
|---|---|---|
| $globals | массив |
@see self::$globals |
init() public method
| public void init ( ) |
|---|
render() public method
Отображает файл представления.
Этот метод вызывается классом yii\base\View всякий раз, когда он пытается отобразить представление. Подклассы должны реализовать этот метод для отображения заданного файла представления.
| public строка render ( $view, $file, $params ) | ||
|---|---|---|
| $view | yii\base\View |
Объект представления, используемый для отображения файла. |
| $file | строка |
Файл представления. |
| $params | массив |
Параметры, которые должны быть переданы в файл представления. |
| return | строка |
Результат отображения |
setLexerOptions() public method
Устанавливает параметры Twig lexer для изменения синтаксиса шаблонов
| public void setLexerOptions ( $options ) | ||
|---|---|---|
| $options | массив |
@see self::$lexerOptions |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-twig-viewrenderer.html