Spec-Zone.ru › CakePHP 2.10

Класс ModelTask

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

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

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

  • $_modelNames protected
    array
    Хранит имена моделей
  • $_tables protected
    array
    Хранит таблицы, найденные в соединении.
  • $_validations protected
    array
    Хранит карту методов валидации.
  • $path public
    string
    Путь к каталогу моделей
  • $skipTables public
    array
    Таблицы, которые следует пропустить при выполнении all()
  • $tasks public
    array
    Задачи

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

  • connection, interactive, plugin

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

  • _generatePossibleKeys() protected
    Ищет все возможные ключи для использования в пользовательских ассоциациях.
  • _getModelObject() protected
    Получает объект модели для имени класса.
  • _interactive() protected
    Обрабатывает интерактивное создание.
  • _printAssociation() protected
    Выводит все ассоциации определенного типа.
  • all() public
    Создает все модели сразу.
  • bake() public
    Собирает и записывает файл модели.
  • bakeFixture() public
    Взаимодействует с FixtureTask для автоматического создания фикстур при создании моделей.
  • bakeTest() public
    Собирает и записывает файл теста.
  • 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 )

Получает объект модели для имени класса.

Параметры

string $className
Имя класса, для которого требуется модель.
string $table необязательно null
Имя таблицы

Возвращает

Model
Экземпляр модели

_interactive()source protected

_interactive( )

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

Возвращает

boolean

_printAssociation()source protected

_printAssociation( string $modelName , string $type , string $associations )

Выводит все ассоциации определенного типа.

Параметры

string $modelName
Имя модели, к которой относятся отношения.
string $type
Имя ассоциации, которую вы хотите увидеть. Например, 'belongsTo'.
string $associations
Коллекция ассоциаций.

all()source public

all( )

Создает все модели сразу.

bake()source public

bake( string|object $name , array|boolean $data array() )

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

Параметры

string|object $name
Имя модели или объект
array|boolean $data необязательно array()
Если массив и $name не объект, предполагается данные для создания, в противном случае boolean.

Возвращает

string

bakeFixture()source public

bakeFixture( string $className , string $useTable null )

Взаимодействует с FixtureTask для автоматического создания фикстур при создании моделей.

Параметры

string $className
Имя класса для создания фикстуры
string $useTable необязательно null
Необязательное имя таблицы для использования фикстурой.

См. также

FixtureTask::bake
END_OF_DOCUMENT_MARKER

bakeTest()source public

bakeTest( string $className )

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

Параметры

string $className
Имя класса модели

Возвращает

string

confirmAssociations()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 $primaryKey optional '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 $useDbConfig optional null
Имя подключения для сканирования.

Возвращает

array
Массив таблиц в базе данных.

getName()source public

getName( string $useDbConfig null )

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

Параметры

string $useDbConfig optional null
Имя конфигурации базы данных

Возвращает

string
Имя модели

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

getTable()source public

getTable( string $modelName , string $useDbConfig null )

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

Параметры

string $modelName
Имя модели, для которой требуется таблица.
string $useDbConfig optional null
Имя конфигурации базы данных, из которой необходимо получить таблицы.

Возвращает

string
Имя таблицы

inOptions()source public

inOptions( array $options , string $prompt null , integer $default null )

Генерирует список параметров со значениями и подсказку.

Параметры

array $options
Массив параметров для выбора. Индексы должны начинаться с 0
string $prompt optional null
Подсказка для использования в списке параметров.
integer $default optional null
Параметр по умолчанию для данной подсказки.

Возвращает

integer
Результат выбора пользователя.

initValidations()source public

initValidations( )

Заполняет массив _validations

initialize()source public

initialize( )

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

END_OF_DOCUMENT_MARKER

listAll()source public

listAll( string $useDbConfig null )

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

Параметры

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

Возвращает

массив

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

getPath()source public

getPath( )

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

Возвращает

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

startup()source public

startup( )

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

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

$_modelNamessource

protected массив

Хранит имена моделей

array()

$_tablessource

protected массив

Хранит таблицы, найденные при подключении.

array()

$_validationssource

protected массив

Хранит карту методов валидации.

array()

$pathsource

public строка

путь к каталогу моделей

null

$skipTablessource

public массив

Таблицы, которые следует пропустить при запуске all()

array('i18n')

$taskssource

public массив

задачи

array('DbConfig', 'Fixture', 'Test', 'Template')

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

Spec-Zone.ru

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