Класс ViewTask
Класс задач для создания и обновления файлов представлений.
- AppShell
-
BakeTask -
ViewTask
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Command/Task/ViewTask.php
Краткое описание свойств
-
$controllerNamepublicИмя контроллера, используемого в данный моментstring -
$noTemplateActionspublicarrayМассив имён действий, не требующих шаблонов. Эти действия не будут генерировать ошибки при выполнении bakeActions()
-
$pathpublicпуть к каталогу Viewarray -
$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
Действия, используемые для scaffolding
array('index', 'view', 'add', 'edit') $taskssource
public array
Задачи, которые должны быть загружены этой задачей
array('Project', 'Controller', 'DbConfig', 'Template')
© 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-ViewTask.html