Класс ViewTask
Класс задачи для создания и обновления файлов представления.
- AppShell
-
BakeTask
-
ViewTask
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Command/Task/ViewTask.php
Краткое описание свойств
-
$controllerNamepublicИмя используемого контроллераstring -
$noTemplateActionspublicarrayМассив имён действий, не требующих шаблонов. Эти действия не будут генерировать ошибки при выполнении bakeActions()
-
$pathpublicПуть к директории представленияarray -
$scaffoldActionspublicДействия для использования в шаблонахarray -
$taskspublicЗадачи, которые должны быть загружены этой задачейarray -
$templatepublicФайл шаблона для использованияstring
Унаследованные свойства
Краткое описание методов
- _associations() protectedВозвращает ассоциации для моделей контроллеров.
- _interactive() protectedОбрабатывает интерактивное создание
- _loadController() protected
Загружает контроллер и устанавливает переменные для шаблона Доступные переменные шаблона 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar', 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys', 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'
- _methodsToBake() protectedПолучение списка действий, для которых могут/должны быть созданы представления.
- all() publicСоздаёт все представления для всех контроллеров.
- bake() publicСобирает и записывает создаваемый файл представления.
- bakeActions() publicСоздаёт файл представления для каждого из предоставленных действий
- customAction() publicОбработка создания файла представления для пользовательского действия
- execute() publicМетод выполнения, всегда используемый для задач
- getContent() publicСоздаёт содержимое из шаблона и переменных
- getOptionParser() publicПолучение экземпляра парсера опций и его настройка.
- getTemplate() publicПолучение имени шаблона на основе имени действия
- initialize() publicПереопределение initialize
Подробное описание методов
_associations()source protected
_associations( Model $model )
Возвращает ассоциации для моделей контроллеров.
Параметры
-
Model$model - Экземпляр модели.
Возвращаемое значение
arrayассоциации
_loadController()source protected
_loadController( )
Загружает контроллер и устанавливает переменные для шаблона Доступные переменные шаблона 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar', 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys', 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'
Возвращаемое значение
arrayВозвращает переменные, которые должны быть доступны шаблону представления
_methodsToBake()source protected
_methodsToBake( )
Получение списка действий, для которых могут/должны быть созданы представления.
Возвращаемое значение
arrayМассив имён действий, которые должны быть созданы
bake()source public
bake( string $action , string $content '' )
Собирает и записывает создаваемый файл представления.
Параметры
- string
$action - Действие для создания
- string
$contentoptional '' - Содержимое для записи
Возвращаемое значение
booleanУспешно
bakeActions()source public
bakeActions( array $actions , array $vars )
Создаёт файл представления для каждого из предоставленных действий
Параметры
- array
$actions - Массив действий для создания файлов.
- array
$vars - Переменные шаблона.
customAction()source public
customAction( )
Обработка создания файла представления для пользовательского действия
execute()source public
execute( )
Метод выполнения, всегда используемый для задач
Возвращаемое значение
mixedПереопределяет
BakeTask::execute() getContent()source public
getContent( string $action , array $vars null )
Создаёт содержимое из шаблона и переменных
Параметры
- string
$action - имя для создания содержимого
- array
$varsoptional null - переданные для использования в шаблонах
Возвращаемое значение
stringсодержимое из шаблона
getOptionParser()source public
getOptionParser( )
Получение экземпляра парсера опций и его настройка.
Возвращаемое значение
ConsoleOptionParsergetTemplate()source public
getTemplate( string $action )
Получение имени шаблона на основе имени действия
Параметры
- string
$action - имя
Возвращаемое значение
stringимя шаблона
Наследованные методы из BakeTask
getPath()source public
getPath( )
Получение пути для вывода. Проверяет свойство плагина и возвращает правильный путь.
Возвращаемое значение
stringПуть для вывода.
startup()source public
startup( )
Отключить кеширование и включить режим отладки для выпечки. Это принудительно использует самую последнюю схему базы данных.
Подробное описание свойств
$noTemplateActionssource
public array
Массив имён действий, для которых не требуются шаблоны. Для этих действий не будет генерироваться ошибок при выполнении bakeActions()
array('delete') $scaffoldActionssource
public array
Действия, используемые для создания каркаса
array('index', 'view', 'add', 'edit') $taskssource
public array
Задачи, которые нужно загрузить этой задачей
array('Project', 'Controller', 'DbConfig', 'Template')
© 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-ViewTask.html