Класс TemplateTask
Задача шаблона может генерировать шаблонный вывод, используемый в других задачах. Действует как упрощённый класс представления.
- AppShell
-
TemplateTask
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Console/Command/Task/TemplateTask.php
Краткое описание свойств
-
$templatePathspublicarrayПути для поиска шаблонов. Содержит список $theme => $path
-
$templateVarspublicпеременные для добавления в область видимости шаблонаarray
Краткое описание методов
- _findTemplate() protected
Поиск шаблона внутри каталога внутри пути. Будет сканировать все другие каталоги тем, если шаблон не найден в первом каталоге.
- _findThemes() protectedПоиск путей ко всем установленным темам оболочки в приложении.
- generate() publicВыполняет шаблон
- getThemePath() public
Поиск имени темы для текущей операции. Если в $templatePaths только одна тема, она будет использована. Если в аргументах командной строки есть параметр -theme, он будет использован. Если установлено более одной темы, произойдёт взаимодействие с пользователем
- initialize() publicОбратный вызов инициализации. Настройка путей для задачи шаблона.
- set() publicУстанавливает значения переменных в область видимости шаблона
Подробное описание методов
_findTemplate()source protected
_findTemplate( string $path , string $directory , string $filename )
Поиск шаблона внутри каталога внутри пути. Будет сканировать все другие каталоги тем, если шаблон не найден в первом каталоге.
Параметры
- string
$path - Начальный путь для поиска файла. Если он не найден, будут использоваться варианты.
- string
$directory - Подкаталог для поиска, например, 'views', 'objects'
- string
$filename - Имя файла в нижнем регистре с нижними подчеркиваниями, которое требуется.
Возвращаемое значение
stringИмя файла, программа завершится с ошибкой, если шаблон не найден.
_findThemes()source protected
_findThemes( )
Поиск путей ко всем установленным темам оболочки в приложении.
Темы Bake — это каталоги, не имеющие имени skel внутри каталога Console/Templates. Они перечислены в таком порядке: приложение -> плагин -> по умолчанию
Возвращаемое значение
arrayМассив установленных тем Bake.
generate()source public
generate( string $directory , string $filename , array $vars null )
Выполняет шаблон
Параметры
- string
$directory - каталог / тип того, что нужно
- string
$filename - имя шаблона
- array
$varsнеобязательно null - Дополнительные переменные для установки в область видимости шаблона.
Возвращаемое значение
stringсодержимое сгенерированного шаблона кода
getThemePath()source public
getThemePath( )
Поиск имени темы для текущей операции. Если в $templatePaths только одна тема, она будет использована. Если в аргументах командной строки есть параметр -theme, он будет использован. Если установлено более одной темы, произойдёт взаимодействие с пользователем
Возвращаемое значение
stringвозвращает путь к выбранной теме.
initialize()source public
initialize( )
Обратный вызов инициализации. Настройка путей для задачи шаблона.
set()source public
set( string|array $one , string|array $two null )
Устанавливает значения переменных в область видимости шаблона
Параметры
- string|array
$one - Строка или массив данных.
- string|array
$twoнеобязательно null Значение в случае, если $one является строкой (в этом случае строка работает как ключ). Не используется, если $one — ассоциативный массив, в противном случае служит значениями для ключей $one.
Подробное описание свойств
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-TemplateTask.html