Spec-Zone.ru › CakePHP 2.10

Класс ViewTask

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

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

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

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

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

  • $path public
    array
    Путь к директории представления
  • $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

Действия, используемые для создания каркаса

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

$taskssource

public array

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

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

$templatesource

public string

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

null

© 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

Spec-Zone.ru

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