Spec-Zone.ru › CakePHP 2.10

Класс ControllerTask

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

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

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

  • $path public
    array
    путь к каталогу контроллеров
  • $tasks public
    array
    Задачи, которые должны быть загружены этой задачей

Наследуемые свойства

  • connection, interactive, plugin

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

  • _askAboutMethods() protected
    Взаимодействие с пользователем и запрос о том, какие методы (админ или обычные) нужно создать
  • _doPropertyChoices() protected
    Общий код для обработки выбора свойств.
  • _interactive() protected
    Интерактивный
  • all() public
    Создать все контроллеры сразу. Будут созданы только контроллеры для существующих моделей.
  • bake() public
    Собирает и записывает файл контроллера
  • bakeActions() public
    Создать действия шаблонного контроллера
  • bakeTest() public
    Собирает и записывает файл unit-теста
  • confirmController() public
    Подтвердить создание контроллера с пользователем
  • doComponents() public
    Взаимодействие с пользователем и получение списка дополнительных компонентов
  • doHelpers() public
    Взаимодействие с пользователем и получение списка дополнительных хелперов
  • execute() public
    Метод выполнения, всегда используемый для задач
  • getName() public
    Принуждает пользователя указать контроллер, который нужно создать, и возвращает выбранное имя контроллера.
  • getOptionParser() public
    Получает экземпляр парсера опций и настраивает его.
  • initialize() public
    Переопределяет инициализацию
  • listAll() public
    Выводит и получает список возможных контроллеров из базы данных

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

_askAboutMethods()source protected

_askAboutMethods( )

Взаимодействие с пользователем и запрос о том, какие методы (админ или обычные) нужно создать

Возвращает

array
Массив, содержащий ответы (bakeRegular, bakeAdmin)

_doPropertyChoices()source protected

_doPropertyChoices( string $prompt , string $example )

Общий код для обработки выбора свойств.

Параметры

строка $prompt
Вопрос «да/нет» перед списком
строка $example
Вопрос о списке через запятую, с примерами.

Возвращает

array
Массив значений для свойства.

_interactive()source protected

_interactive( )

Интерактивный

all()source public

all( )

Создать все контроллеры сразу. Будут созданы только контроллеры для существующих моделей.

bake()source public

bake( string $controllerName , string $actions '' , array $helpers null , array $components null )

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

Параметры

строка $controllerName
Имя контроллера, уже множественное и с правильным регистром.
строка $actions optional ''
Действия для добавления, или устанавливает весь контроллер для использования $scaffold (установите $actions в 'scaffold')
массив $helpers optional null
Хелперы для использования в контроллере
массив $components optional null
Компоненты для использования в контроллере

Возвращает

строка
Созданный контроллер

bakeActions()source public

bakeActions( string $controllerName , string $admin null , boolean $wannaUseSession true )

Создать действия шаблонного контроллера

Параметры

строка $controllerName
Имя контроллера
строка $admin optional null
Админ маршрут для использования
логическое значение $wannaUseSession optional true
Установить в true для использования сессий, иначе false

Возвращает

строка
Созданные действия

bakeTest()source public

bakeTest( string $className )

Собирает и записывает файл unit-теста

Параметры

строка $className
Имя класса контроллера

Возвращает

строка
Созданный тест

confirmController()source public

confirmController( string $controllerName , string $useDynamicScaffold , array $helpers , array $components )

Подтвердить создание контроллера с пользователем

Параметры

строка $controllerName
Имя контроллера.
строка $useDynamicScaffold
Использовать ли динамичные шаблоны.
массив $helpers
Список хелперов для включения.
массив $components
Список компонентов для включения.

doComponents()source public

doComponents( )

Взаимодействие с пользователем и получение списка дополнительных компонентов

Возвращает

array
Компоненты, которые пользователь хочет использовать.

doHelpers()source public

doHelpers( )

Взаимодействие с пользователем и получение списка дополнительных хелперов

Возвращает

array
Хелперы, которые пользователь хочет использовать.

execute()source public

execute( )

Метод выполнения, всегда используемый для задач

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

BakeTask::execute()

getName()source public

getName( string $useDbConfig null )

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

Параметры

строка $useDbConfig optional null
Имя подключения для получения имени контроллера.

Возвращает

строка
Имя контроллера

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

initialize()source public

initialize( )

Переопределить initialize

listAll()source public

listAll( string $useDbConfig null )

Выводит и получает список возможных контроллеров из базы данных

Параметры

строка $useDbConfig необязательно null
Имя конфигурации базы данных

Возвращает

массив
Набор контроллеров

Методы, унаследованные от BakeTask

getPath()source public

getPath( )

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

Возвращает

строка
Путь вывода.

startup()source public

startup( )

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

Подробности свойств

$pathsource

public массив

путь к каталогу контроллеров

null

$taskssource

public массив

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

array('Model', 'Test', 'Template', 'DbConfig', 'Project')

© 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-ControllerTask.html

Spec-Zone.ru

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