Класс ModelTask
Класс задач для создания и обновления файлов моделей.
- AppShell
-
BakeTask -
ModelTask
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Command/Task/ModelTask.php
Краткое описание свойств
-
$_modelNamesprotectedСодержит имена моделейarray -
$_tablesprotectedСодержит таблицы, найденные в подключении.array -
$_validationsprotectedСодержит карту методов валидации.array -
$pathpublicПуть к каталогу моделейstring -
$skipTablespublicТаблицы, которые нужно пропустить при выполнении all()array -
$taskspublicЗадачиarray
Унаследованные свойства
Краткое описание методов
- _generatePossibleKeys() protectedНаходит все возможные ключи для использования в пользовательских ассоциациях.
- _getModelObject() protectedПолучает объект модели для имени класса.
- _interactive() protectedОбрабатывает интерактивное создание
- _printAssociation() protectedВыводит все ассоциации определенного типа
- all() publicСоздает все модели сразу.
- bake() publicСобирает и записывает файл модели.
- bakeFixture() publicВзаимодействует с FixtureTask для автоматического создания фикстур при создании моделей.
- bakeTest() publicСобирает и записывает файл unit-теста
- confirmAssociations() publicВзаимодействует с пользователем и подтверждает ассоциации.
- doActsAs() publicОбрабатывает поведения
- doAssociations() publicОбрабатывает ассоциации
- doMoreAssociations() publicВзаимодействует с пользователем и генерирует дополнительные нестандартные ассоциации
- doValidation() publicОбрабатывает создание и взаимодействие с пользователем для создания валидации.
- execute() publicМетод выполнения, всегда используется для задач
- fieldValidation() publicОбрабатывает отдельную валидацию полей.
- findBelongsTo() publicНаходит связи belongsTo и добавляет их в список ассоциаций.
- findDisplayField() publicВзаимодействует с пользователем для поиска значения displayField для модели.
- findHasAndBelongsToMany() publicНаходит связи hasAndBelongsToMany и добавляет их в список ассоциаций
- findHasOneAndMany() publicНаходит связи hasOne и hasMany и добавляет их в список ассоциаций
- findPrimaryKey() publicНаходит первичный ключ в списке полей.
- getAllTables() public
Возвращает массив всех таблиц в предоставленном подключении, завершит выполнение скрипта, если таблицы не найдены.
- getName() publicПринуждает пользователя указать модель, которую он хочет создать, и возвращает выбранное имя модели.
- getOptionParser() publicПолучает экземпляр анализатора опций и настраивает его.
- getTable() publicВзаимодействует с пользователем, чтобы определить имя таблицы конкретной модели
- inOptions() publicСоздаёт список опций и запрос.
- initValidations() publicЗаполняет массив _validations
- initialize() publicПереопределяет initialize
- listAll() publicВыводит список возможных моделей или контроллеров из базы данных
Подробное описание методов
_generatePossibleKeys()source protected
_generatePossibleKeys( )
Находит все возможные ключи для использования в пользовательских ассоциациях.
Возвращает
arrayМассив таблиц и возможных ключей
_getModelObject()source protected
_getModelObject( string $className , string $table null )
Получает объект модели для имени класса.
Параметры
- строка
$className - Имя класса, для которого требуется модель.
- строка
$tableнеобязательно null - Имя таблицы
Возвращает
ModelЭкземпляр модели
_interactive()source protected
_interactive( )
Обрабатывает интерактивное создание
Возвращает
boolean_printAssociation()source protected
_printAssociation( string $modelName , string $type , string $associations )
Выводит все ассоциации определенного типа
Параметры
- строка
$modelName - Имя модели, к которой относятся отношения.
- строка
$type - Имя ассоциации, которую вы хотите увидеть. Например, 'belongsTo'
- строка
$associations - Коллекция ассоциаций.
bake()source public
bake( string|object $name , array|boolean $data array() )
Собирает и записывает файл модели.
Параметры
- строка|объект
$name - Имя модели или объект
- массив|булево
$dataнеобязательно массив() - если массив и $name не является объектом, предположите данные для bake, в противном случае булево.
Возвращает
строкаbakeFixture()source public
bakeFixture( string $className , string $useTable null )
Взаимодействует с FixtureTask для автоматического создания фикстур при создании моделей.
Параметры
- строка
$className - Имя класса, для которого нужно создать фикстуру
- строка
$useTableнеобязательно null - Необязательное имя таблицы для использования фикстурой.
См. также
FixtureTask::bakebakeTest()source public
bakeTest( string $className )
Создаёт и записывает файл unit-теста
Параметры
- string
$className - Имя класса модели
Возвращаемое значение
stringconfirmAssociations()source public
confirmAssociations( Model $model , array $associations )
Взаимодействие с пользователем для подтверждения ассоциаций.
Параметры
-
Model$model - Временный экземпляр модели.
- array
$associations - Массив ассоциаций для подтверждения.
Возвращаемое значение
arrayМассив подтверждённых ассоциаций
doActsAs()source public
doActsAs( Model $model )
Обработка поведений
Параметры
-
Model$model - Объект модели.
Возвращаемое значение
arrayПоведения
doAssociations()source public
doAssociations( Model $model )
Обработка ассоциаций
Параметры
-
Model$model - Объект модели
Возвращаемое значение
arrayАссоциации
doMoreAssociations()source public
doMoreAssociations( Model $model , array $associations )
Взаимодействие с пользователем для создания дополнительных нестандартных ассоциаций
Параметры
-
Model$model - Временный экземпляр модели
- array
$associations - Массив ассоциаций.
Возвращаемое значение
arrayМассив ассоциаций.
doValidation()source public
doValidation( Model $model )
Обработка генерации и взаимодействия с пользователем для создания валидации.
Параметры
-
Model$model - Модель, для которой будут сгенерированы валидации.
Возвращаемое значение
arrayМассив выбранных пользователем валидаций.
execute()source public
execute( )
Метод выполнения, всегда используемый для задач
Переопределяет
BakeTask::execute() fieldValidation()source public
fieldValidation( string $fieldName , array $metaData , string $primaryKey 'id' )
Обработка валидации отдельных полей.
Параметры
- string
$fieldName - Имя поля для валидации.
- array
$metaData - Метаданные для поля
- string
$primaryKeyoptional 'id' - Поле первичного ключа.
Возвращаемое значение
arrayМассив валидации для поля.
findBelongsTo()source public
findBelongsTo( Model $model , array $associations )
Поиск отношений belongsTo и добавление их в список ассоциаций.
Параметры
-
Model$model - Экземпляр модели, которая генерируется.
- array
$associations - Массив текущих ассоциаций
Возвращаемое значение
arrayАссоциации с добавленными belongsTo.
findDisplayField()source public
findDisplayField( array $fields )
Взаимодействие с пользователем для поиска значения displayField для модели.
Параметры
- array
$fields - Массив полей для поиска и выбора в качестве displayField
Возвращаемое значение
mixedИмя поля для использования в displayField или false, если пользователь отказывается выбирать
findHasAndBelongsToMany()source public
findHasAndBelongsToMany( Model $model , array $associations )
Поиск отношений hasAndBelongsToMany и добавление их в список ассоциаций
Параметры
-
Model$model - Экземпляр генерируемой модели
- array
$associations - Массив текущих ассоциаций
Возвращаемое значение
arrayАссоциации с добавленными hasAndBelongsToMany.
findHasOneAndMany()source public
findHasOneAndMany( Model $model , array $associations )
Поиск отношений hasOne и hasMany и добавление их в список ассоциаций
Параметры
-
Model$model - Экземпляр генерируемой модели
- array
$associations - Массив текущих ассоциаций
Возвращаемое значение
arrayАссоциации с добавленными hasOne и hasMany.
findPrimaryKey()source public
findPrimaryKey( array $fields )
Находит первичный ключ в списке полей.
Параметры
- array
$fields - Массив полей, которые могут содержать первичный ключ.
Возвращаемое значение
stringИмя поля, являющегося первичным ключом.
getAllTables()source public
getAllTables( string $useDbConfig null )
Получение массива всех таблиц в заданном соединении, прерывает скрипт, если таблицы не найдены.
Параметры
- string
$useDbConfigoptional null - Имя подключения для сканирования.
Возвращаемое значение
arrayМассив таблиц в базе данных.
getName()source public
getName( string $useDbConfig null )
Заставляет пользователя указать модель, которую он хочет создать, и возвращает выбранное имя модели.
Параметры
- string
$useDbConfigoptional null - Имя конфигурации базы данных
Возвращаемое значение
stringИмя модели
getOptionParser()source public
getOptionParser( )
Получает экземпляр парсера опций и настраивает его.
Возвращаемое значение
ConsoleOptionParsergetTable()source public
getTable( string $modelName , string $useDbConfig null )
Взаимодействие с пользователем для определения имени таблицы конкретной модели
Параметры
- string
$modelName - Имя модели, для которой требуется таблица.
- string
$useDbConfigoptional null - Имя конфигурации базы данных для получения таблиц.
Возвращаемое значение
stringИмя таблицы
inOptions()source public
inOptions( array $options , string $prompt null , integer $default null )
Генерирует список опций и запрос.
Параметры
- array
$options - Массив опций для использования при выборе. Индексы должны начинаться с 0
- string
$promptoptional null - Подсказка для списка опций.
- integer
$defaultoptional null - Опция по умолчанию для данного запроса.
Возвращаемое значение
integerРезультат выбора пользователя.
listAll()source public
listAll( string $useDbConfig null )
выводит список возможных моделей или контроллеров из базы данных
Параметры
- строка
$useDbConfigнеобязательно null - Имя конфигурации базы данных
Возвращает
массивМетоды, унаследованные от BakeTask
getPath()source public
getPath( )
Получает путь для вывода. Проверяет свойство плагина и возвращает правильный путь.
Возвращает
строкаПуть для вывода.
startup()source public
startup( )
Отключает кэширование и включает отладку для создания. Это заставляет использовать самую последнюю схему базы данных.
Подробное описание свойств
$skipTablessource
public массив
Таблицы, которые нужно пропустить при выполнении all()
array('i18n')
© 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-ModelTask.html