Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 6.58 KB

API.md

File metadata and controls

83 lines (58 loc) · 6.58 KB
Raw

doctrine

Набор решений для работы с Doctrine2 на проектах ZF2

Данный модуль реализует:

  • Менеджер для получения ObjectManager'ов
  • Менеджер для создания сущностей Doctrine2 - EntityManager
  • Расширение для Doctrine2, позволяющее добавлять значения в DiscriminatorMap из сущностей потомков
  • Абстрактная фабрика для менеджера гидраторов, создающая \DoctrineModule\Stdlib\Hydrator\DoctrineObject

Обработчики общих событий

Идентификатор Имя события Описание
DoctrineManagerRegistry get.doctrineManagerRegistry Получение экземпляра \Nnx\Doctrine\ManagerRegistry\ManagerRegistry

#Сервисы

Сервис \Nnx\Doctrine\ObjectManager\ObjectManagerAutoDetectorInterface

Методы:

Метод Описание
getObjectManagerNameByClassName Получает имя используемого в модуле ObjectManager'a Doctrine, по имени любого класса модуля
hasObjectManagerNameByClassName Проверяет есть ли возможность по имени класса модуля, получить имя objectManager'a который используется в данном модуле
hasObjectManagerByClassName Проверяет есть ли возможность по имени класса модуля, получить objectManager'a который используется в данном модуле
getObjectManagerByClassName По имени класса модуля, получает objectManager'a который используется в данном модуле

Сервис \Nnx\Doctrine\Service\ObjectManagerServiceInterface

Методы:

Метод Описание
getRepository По имени сущности получает репозиторий для работы с ней
saveEntityObject Сохраняет сущность в хранилище
createEntityObject Создает новую сущность

Сервис \Nnx\Doctrine\ManagerRegistry\ManagerRegistry

Методы: @see \Doctrine\Common\Persistence\AbstractManagerRegistry

События бросаемые фабрикой \Nnx\Doctrine\ManagerRegistry\ManagerRegistryFactory при создание сервиса

Имя события Описание
managerRegistryFactory.buildListConnections Событие бросаемое когда необходимо получить список используемых соеденений
managerRegistryFactory.buildListObjectManagers Событие бросаемое когда необходимо получить список используемых ObjectManager'ов

События бросаемые самим сервисом:

Имя события Описание
resolveObjectManager.managerRegistryResource Событие бросаемое когда необходимо получить ObjectManager Doctrine по его имени
resolveConnectionManager.managerRegistryResource Событие бросаемое когда необходимо получить соеденение Doctrine по его имени

Plugin Managers

Имя плагин менеджера Имя секции в конфигурационных файлах приложения
\Nnx\Doctrine\ObjectManager\DoctrineObjectManagerInterface nnx_doctrine_object_manager
\Nnx\Doctrine\EntityManager\EntityManagerInterface nnx_entity_manager

Настройка модуля nnx_doctrine

Ключ Описание
entitySeparator Строка, используемая как разделитель в полном имени класса сущности(или интерфейса)
entityBodyNamePattern Паттерн по которому из имени интерфейса можно получить строку, являющеюся заготовкой для формирования имени сущности
entityNamePrefix Строка которая добавляется перед заготовкой имени сущности
entityNamePostfix Строка которая добавляется после заготовки имени сущности
entityMapDoctrineCache Имя сервиса, позволяющего получить объект кеша из модуля doctrine/cache, для сохранения карты сущностей
entityMapDoctrineCachePrefix Префикс используемый для генерации ключа кеширования карты сущностей doctrine
metadataReaderCache Имя сервиса, позволяющего получить объект кеша из модуля doctrine/cache для кеширования метаданных сущности
flagAutoBuildEntityMapDoctrineCache Флаг определяет, нужно ли автоматически собирать кеш карты сущностей
flagDisableUseEntityMapDoctrineCache Флаг блокирует использования системы кеширования (удобно устанавливать разработчикам, во время отладки)
excludeEntityManagerForAutoBuildEntityMap Список имен ObjectManager'ов, для которых в автоматическом режими (flagAutoBuildEntityMapDoctrineCache=true), никогда не строится карта сущностей
managerRegistry Настройки необходимые для создания экземпляра \Nnx\Doctrine\ManagerRegistry\ManagerRegistry