Spec-Zone.ru › CakePHP 2.9

Класс ViewTask

Класс задач для создания и обновления файлов представлений.

AppShell
Extended by BakeTask
Extended by ViewTask
Пакет: Cake\Console\Command\Task
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Command/Task/ViewTask.php

Краткое описание свойств

  • $controllerName public
    string
    Имя контроллера, используемого в данный момент
  • $noTemplateActions public
    array

    Массив имён действий, не требующих шаблонов. Эти действия не будут генерировать ошибки при выполнении bakeActions()

  • $path public
    array
    путь к каталогу View
  • $scaffoldActions public
    array
    Действия для использования при создании каркаса
  • $tasks public
    array
    Задачи, которые должны загружаться этой задачей
  • $template public
    string
    Файл шаблона для использования

Наследованные свойства

  • connection, interactive, plugin

Краткое описание методов

  • _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
ассоциации

_interactive()source protected

_interactive( )

Обрабатывает интерактивное создание

_loadController()source protected

_loadController( )

Загружает контроллер и устанавливает переменные для шаблона Доступные переменные шаблона 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar', 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys', 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'

Возвращает

array
Возвращает переменные, которые будут доступны шаблону представления

_methodsToBake()source protected

_methodsToBake( )

Получает список действий, для которых могут/должны быть созданы представления.

Возвращает

array
Массив имён действий, которые должны быть созданы

all()source public

all( )

Создать все представления для всех контроллеров.

bake()source public

bake( string $action , string $content '' )

Собирает и записывает созданный файл представления.

Параметры

string $action
Действие для создания
string $content optional ''
Контент для записи

Возвращает

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 $vars optional null
передано для использования в шаблонах

Возвращает

string
контент из шаблона

getOptionParser()source public

getOptionParser( )

Получает экземпляр парсера опций и настраивает его.

Возвращает

ConsoleOptionParser

getTemplate()source public

getTemplate( string $action )

Получает имя шаблона на основе имени действия

Параметры

string $action
имя

Возвращает

string
имя шаблона

initialize()source public

initialize( )

Переопределяет initialize

Наследованные методы из BakeTask

getPath()source public

getPath( )

Получает путь для вывода. Проверяет свойство плагина и возвращает правильный путь.

Возвращает

string
Путь для вывода.
END_OF_DOCUMENT_MARKER

startup()source public

startup( )

Отключить кэширование и включить отладку для выпечки. Это заставляет использовать самую актуальную схему базы данных.

Подробное описание свойств

$controllerNamesource

public string

Имя используемого контроллера

null

$noTemplateActionssource

public array

Массив имён действий, не требующих шаблонов. Для этих действий не будут генерироваться ошибки при выполнении bakeActions()

array('delete')

$pathsource

public array

Путь к каталогу представления

null

$scaffoldActionssource

public array

Действия, используемые для scaffolding

array('index', 'view', 'add', 'edit')

$taskssource

public array

Задачи, которые должны быть загружены этой задачей

array('Project', 'Controller', 'DbConfig', 'Template')

$templatesource

public string

Используемый шаблон файла

null

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API