Класс TemplateTask
Задача шаблона может генерировать шаблонный вывод, используемый в других задачах. Ведёт себя как упрощённый класс View.
- AppShell
-
TemplateTask
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: 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 )
Поиск шаблона внутри каталога внутри пути. Будет сканировать все другие каталоги тем, если шаблон не найден в первом каталоге.
Параметры
- строка
$path - Начальный путь для поиска файла. Если он не найден, будут использоваться резервные варианты.
- строка
$directory - Подкаталог для поиска, например, 'views', 'objects'
- строка
$filename - имя файла в формате нижнего регистра с подчеркиваниями, которое нужно.
Возвращает
строкаИмя файла, программа завершит работу, если шаблон не найден.
_findThemes()source protected
_findThemes( )
Находит пути ко всем установленным темам оболочки в приложении.
Тематика Bake — это каталоги, не имеющие имени skel внутри пути Console/Templates. Они перечислены в таком порядке: приложение -> плагин -> по умолчанию
Возвращает
массивМассив установленных тем Bake.
generate()source public
generate( string $directory , string $filename , array $vars null )
Выполняет шаблон
Параметры
- строка
$directory - каталог / тип того, что вы хотите
- строка
$filename - имя шаблона
- массив
$varsнеобязательно null - Дополнительные переменные для установки в область видимости шаблона.
Возвращает
строкасодержимое сгенерированного шаблона кода
getThemePath()source public
getThemePath( )
Находит имя темы для текущей операции. Если в $templatePaths есть только одна тема, она будет использоваться. Если в аргументах командной строки есть параметр -theme, он будет использоваться. Если установлено более одной темы, будет происходить взаимодействие с пользователем
Возвращает
строкавозвращает путь к выбранной теме.
initialize()source public
initialize( )
Обратный вызов инициализации. Настройка путей для задачи шаблона.
set()source public
set( string|array $one , string|array $two null )
Устанавливает значения переменных в область видимости шаблона
Параметры
- строка|массив
$one - Строка или массив данных.
- строка|массив
$twoнеобязательно null Значение в случае, если $one — строка (в этом случае строка используется в качестве ключа). Не используется, если $one — ассоциативный массив, в противном случае используется в качестве значений ключей $one.
Подробное описание свойств
$templatePathssource
public массив
Пути для поиска шаблонов. Содержит список $theme => $path
array()
© 2005–2016 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.9/class-TemplateTask.html