Класс ControllerTask
Класс задач для создания и обновления файлов контроллеров.
- AppShell
-
BakeTask
-
ControllerTask
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Console/Command/Task/ControllerTask.php
Краткое описание свойств
-
$pathpublicпуть к каталогу контроллеровarray -
$taskspublicЗадачи, которые должны быть загружены этой задачейarray
Наследуемые свойства
Краткое описание методов
- _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Массив значений для свойства.
all()source public
all( )
Создать все контроллеры сразу. Будут созданы только контроллеры для существующих моделей.
bake()source public
bake( string $controllerName , string $actions '' , array $helpers null , array $components null )
Собирает и записывает файл контроллера
Параметры
- строка
$controllerName - Имя контроллера, уже множественное и с правильным регистром.
- строка
$actionsoptional '' - Действия для добавления, или устанавливает весь контроллер для использования $scaffold (установите $actions в 'scaffold')
- массив
$helpersoptional null - Хелперы для использования в контроллере
- массив
$componentsoptional null - Компоненты для использования в контроллере
Возвращает
строкаСозданный контроллер
bakeActions()source public
bakeActions( string $controllerName , string $admin null , boolean $wannaUseSession true )
Создать действия шаблонного контроллера
Параметры
- строка
$controllerName - Имя контроллера
- строка
$adminoptional null - Админ маршрут для использования
- логическое значение
$wannaUseSessionoptional 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 )
Принуждает пользователя указать контроллер, который нужно создать, и возвращает выбранное имя контроллера.
Параметры
- строка
$useDbConfigoptional null - Имя подключения для получения имени контроллера.
Возвращает
строкаИмя контроллера
getOptionParser()source public
getOptionParser( )
Получает экземпляр парсера опций и настраивает его.
Возвращает
ConsoleOptionParserlistAll()source public
listAll( string $useDbConfig null )
Выводит и получает список возможных контроллеров из базы данных
Параметры
- строка
$useDbConfigнеобязательно null - Имя конфигурации базы данных
Возвращает
массивНабор контроллеров
Методы, унаследованные от BakeTask
getPath()source public
getPath( )
Получает путь для вывода. Проверяет свойство плагина и возвращает правильный путь.
Возвращает
строкаПуть вывода.
startup()source public
startup( )
Отключить кэширование и включить отладку для выпечки. Это принудительно использует самую последнюю схему базы данных.
Подробности свойств
$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