public function register(Application $app)
{
$app['orm.em.paths'] = $app->share(function () {
return array();
});
$app['orm.event_manager'] = $app->share(function () use($app) {
return new EventManager();
});
$app['orm.config'] = $app->share(function () use($app) {
return Setup::createConfiguration($app['debug']);
});
$app['orm.anotation_reader'] = $app->share(function () use($app) {
$annotationReader = new AnnotationReader();
$cache = $app['orm.config']->getMetadataCacheImpl();
return new CachedReader($annotationReader, $cache);
});
$app['orm.default_anotation_driver'] = $app->share(function () use($app) {
AnnotationRegistry::registerFile($app['vendor_dir'] . '/doctrine/orm/lib/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php');
return new AnnotationDriver($app['orm.anotation_reader'], $app['orm.em.paths']);
});
$app['orm.em'] = $app->share(function () use($app) {
$annotationReader = $app['orm.anotation_reader'];
$eventManager = $app['orm.event_manager'];
$driverChain = new MappingDriverChain();
$driverChain->setDefaultDriver($app['orm.default_anotation_driver']);
DoctrineExtensions::registerMappingIntoDriverChainORM($driverChain, $annotationReader);
$loggableListener = new LoggableListener();
$loggableListener->setAnnotationReader($annotationReader);
$loggableListener->setUsername('admin');
$eventManager->addEventSubscriber($loggableListener);
$config = $app['orm.config'];
$config->setMetadataDriverImpl($driverChain);
return EntityManager::create($app['db.default_options'], $config, $eventManager);
});
}
/**
* @param EventManager $manager
* @param EntityManagerInterface $em
* @param Reader $reader
*/
public function addSubscribers(EventManager $manager, EntityManagerInterface $em, Reader $reader = null)
{
$subscriber = new LoggableListener();
if ($this->guard->check()) {
$subscriber->setUsername($this->guard->user());
}
$this->addSubscriber($subscriber, $manager, $reader);
}
protected function setUp()
{
parent::setUp();
$evm = new EventManager();
$loggableListener = new LoggableListener();
$loggableListener->setUsername('jules');
$evm->addEventSubscriber($loggableListener);
$this->getMockDocumentManager($evm);
}
/**
* Create service
*
* @param ServiceLocatorInterface $serviceLocator
*
* @return mixed
*/
public function createService(ServiceLocatorInterface $serviceLocator)
{
/**
* @@type AuthenticationService $authService
*/
$authService = $serviceLocator->get('zfcuser_auth_service');
$loggableListener = new LoggableListener();
$loggableListener->setUsername($authService->getIdentity()->getDisplayName());
return $loggableListener;
}
public function testLoggableMetadata()
{
$meta = $this->em->getClassMetadata('Mapping\\Fixture\\Xml\\Loggable');
$config = $this->loggable->getConfiguration($this->em, $meta->name);
$this->assertArrayHasKey('logEntryClass', $config);
$this->assertEquals('Gedmo\\Loggable\\Entity\\LogEntry', $config['logEntryClass']);
$this->assertArrayHasKey('loggable', $config);
$this->assertEquals(true, $config['loggable']);
$this->assertArrayHasKey('versioned', $config);
$this->assertEquals(2, count($config['versioned']));
$this->assertTrue(in_array('title', $config['versioned']));
$this->assertTrue(in_array('status', $config['versioned']));
}
protected function getLogEntryClass(LoggableAdapter $ea, $class)
{
$class = parent::getLogEntryClass($ea, $class);
if ($class === 'Gedmo\\Loggable\\Entity\\LogEntry') {
return 'Stof\\DoctrineExtensionsBundle\\Entity\\LogEntry';
} elseif ($class === 'Gedmo\\Loggable\\Document\\LogEntry') {
return 'Stof\\DoctrineExtensionsBundle\\Document\\LogEntry';
}
return $class;
}
/**
* {@inheritDoc}
*/
protected function getEventAdapter(\Doctrine\Common\EventArgs $args)
{
parent::getEventAdapter($args);
$class = get_class($args);
if (preg_match('@Doctrine\\\\([^\\\\]+)@', $class, $m) && $m[1] == 'ORM') {
$this->adapters[$m[1]] = new ORM();
$this->adapters[$m[1]]->setEventArgs($args);
}
if (isset($this->adapters[$m[1]])) {
return $this->adapters[$m[1]];
} else {
throw new LoggableListenerException('Event mapper does not support event arg class: ' . $class);
}
}
/**
* Returns the doctrine entity manager
* @return \Doctrine\ORM\EntityManager
*/
public function getEntityManager()
{
if ($this->em) {
return $this->em;
}
$config = new \Doctrine\ORM\Configuration();
//$config->setResultCacheImpl($this->cacheDriver);
$config->setMetadataCacheImpl($this->cacheDriver);
$config->setQueryCacheImpl($this->cacheDriver);
$config->setProxyDir(ASCMS_MODEL_PROXIES_PATH);
$config->setProxyNamespace('Cx\\Model\\Proxies');
/**
* This should be set to true if workbench is present and active.
* Just checking for workbench.config is not really a good solution.
* Since ConfigurationFactory used by EM caches auto generation
* config value, there's no possibility to set this later.
*/
$config->setAutoGenerateProxyClasses(file_exists(ASCMS_DOCUMENT_ROOT . '/workbench.config'));
$connectionOptions = array('pdo' => $this->getPdoConnection(), 'dbname' => $this->db->getName());
$evm = new \Doctrine\Common\EventManager();
$chainDriverImpl = new \Doctrine\ORM\Mapping\Driver\DriverChain();
$driverImpl = new \Cx\Core\Model\Controller\YamlDriver(array(ASCMS_CORE_PATH . '/Core' . '/Model/Yaml'));
$chainDriverImpl->addDriver($driverImpl, 'Cx');
//loggable stuff
$loggableDriverImpl = $config->newDefaultAnnotationDriver(ASCMS_LIBRARY_PATH . '/doctrine/Gedmo/Loggable/Entity');
$chainDriverImpl->addDriver($loggableDriverImpl, 'Gedmo\\Loggable');
$this->loggableListener = new \Cx\Core\Model\Model\Event\LoggableListener();
$this->loggableListener->setUsername('currently_loggedin_user');
// in real world app the username should be loaded from session, example:
// Session::getInstance()->read('user')->getUsername();
$evm->addEventSubscriber($this->loggableListener);
$cx = \Cx\Core\Core\Controller\Cx::instanciate();
$sluggableDriverImpl = $config->newDefaultAnnotationDriver($cx->getCodeBaseLibraryPath() . '/doctrine/Gedmo/Sluggable');
$chainDriverImpl->addDriver($sluggableDriverImpl, 'Gedmo\\Sluggable');
$sluggableListener = new \Gedmo\Sluggable\SluggableListener();
// you should set the used annotation reader to listener,
// to avoid creating new one for mapping drivers
//$sluggableListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($sluggableListener);
$timestampableDriverImpl = $config->newDefaultAnnotationDriver($cx->getCodeBaseLibraryPath() . '/doctrine/Gedmo/Timestampable');
$chainDriverImpl->addDriver($timestampableDriverImpl, 'Gedmo\\Timestampable');
$timestampableListener = new \Gedmo\Timestampable\TimestampableListener();
//$timestampableListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($timestampableListener);
// Note that LANG_ID and other language constants/variables
// have not been set yet!
// $langCode = \FWLanguage::getLanguageCodeById(LANG_ID);
// \DBG::log("LANG_ID ".LANG_ID.", language code: $langCode");
// -> LOG: LANG_ID LANG_ID, language code:
$translatableDriverImpl = $config->newDefaultAnnotationDriver($cx->getCodeBaseLibraryPath() . '/doctrine/Gedmo/Translatable/Entity');
$chainDriverImpl->addDriver($translatableDriverImpl, 'Gedmo\\Translatable');
// RK: Note:
// This might have been renamed in newer versions:
//$translationListener = new \Gedmo\Translatable\TranslatableListener();
// In this Doctrine version, it is present as:
$this->translationListener = new \Gedmo\Translatable\TranslationListener();
// current translation locale should be set from session
// or hook later into the listener,
// but *before the entity manager is flushed*
// TODO: Set default locale from the default language?
//$this->translationListener->setDefaultLocale('de_ch');
// Set the current locale (e.g. from the active language)
// wherever that's required.
//$translationListener->setTranslatableLocale('de_ch');
//$translationListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($this->translationListener);
// RK: Note:
// This is apparently not yet present in this Doctrine version:
//$sortableListener = new \Gedmo\Sortable\SortableListener();
//$sortableListener->setAnnotationReader($cachedAnnotationReader);
//$evm->addEventSubscriber($sortableListener);
//tree stuff
$treeListener = new \Gedmo\Tree\TreeListener();
$evm->addEventSubscriber($treeListener);
$config->setMetadataDriverImpl($chainDriverImpl);
//table prefix
$prefixListener = new \DoctrineExtension\TablePrefixListener($this->db->getTablePrefix());
$evm->addEventListener(\Doctrine\ORM\Events::loadClassMetadata, $prefixListener);
$config->setSqlLogger(new \Cx\Lib\DBG\DoctrineSQLLogger());
$em = \Cx\Core\Model\Controller\EntityManager::create($connectionOptions, $config, $evm);
//resolve enum, set errors
$conn = $em->getConnection();
$conn->setCharset($this->db->getCharset());
$conn->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
$conn->getDatabasePlatform()->registerDoctrineTypeMapping('set', 'string');
$this->em = $em;
return $this->em;
}
/**
* Returns the doctrine entity manager
* @return \Doctrine\ORM\EntityManager
*/
public function getEntityManager()
{
if ($this->em) {
return $this->em;
}
global $objCache;
$config = new \Doctrine\ORM\Configuration();
$userCacheEngine = $objCache->getUserCacheEngine();
if (!$objCache->getUserCacheActive()) {
$userCacheEngine = \Cx\Core_Modules\Cache\Controller\Cache::CACHE_ENGINE_OFF;
}
$arrayCache = new \Doctrine\Common\Cache\ArrayCache();
switch ($userCacheEngine) {
case \Cx\Core_Modules\Cache\Controller\Cache::CACHE_ENGINE_APC:
$cache = new \Doctrine\Common\Cache\ApcCache();
$cache->setNamespace($this->db->getName() . '.' . $this->db->getTablePrefix());
break;
case \Cx\Core_Modules\Cache\Controller\Cache::CACHE_ENGINE_MEMCACHE:
$memcache = $objCache->getMemcache();
if ($memcache instanceof \Memcache) {
$cache = new \Doctrine\Common\Cache\MemcacheCache();
$cache->setMemcache($memcache);
} elseif ($memcache instanceof \Memcached) {
$cache = new \Doctrine\Common\Cache\MemcachedCache();
$cache->setMemcache($memcache);
}
$cache->setNamespace($this->db->getName() . '.' . $this->db->getTablePrefix());
break;
case \Cx\Core_Modules\Cache\Controller\Cache::CACHE_ENGINE_XCACHE:
$cache = new \Doctrine\Common\Cache\XcacheCache();
$cache->setNamespace($this->db->getName() . '.' . $this->db->getTablePrefix());
break;
case \Cx\Core_Modules\Cache\Controller\Cache::CACHE_ENGINE_FILESYSTEM:
$cache = new \Cx\Core_Modules\Cache\Controller\Doctrine\CacheDriver\FileSystemCache(ASCMS_CACHE_PATH);
break;
default:
$cache = $arrayCache;
break;
}
\Env::set('cache', $cache);
//$config->setResultCacheImpl($cache);
$config->setMetadataCacheImpl($cache);
$config->setQueryCacheImpl($cache);
$config->setProxyDir(ASCMS_MODEL_PROXIES_PATH);
$config->setProxyNamespace('Cx\\Model\\Proxies');
/**
* This should be set to true if workbench is present and active.
* Just checking for workbench.config is not really a good solution.
* Since ConfigurationFactory used by EM caches auto generation
* config value, there's no possibility to set this later.
*/
$config->setAutoGenerateProxyClasses(file_exists(ASCMS_DOCUMENT_ROOT . '/workbench.config'));
$connectionOptions = array('pdo' => $this->getPdoConnection(), 'dbname' => $this->db->getName());
$evm = new \Doctrine\Common\EventManager();
$chainDriverImpl = new \Doctrine\ORM\Mapping\Driver\DriverChain();
$driverImpl = new \Cx\Core\Model\Controller\YamlDriver(array(ASCMS_CORE_PATH . '/Core' . '/Model/Yaml'));
$chainDriverImpl->addDriver($driverImpl, 'Cx');
//loggable stuff
$loggableDriverImpl = $config->newDefaultAnnotationDriver(ASCMS_LIBRARY_PATH . '/doctrine/Gedmo/Loggable/Entity');
$chainDriverImpl->addDriver($loggableDriverImpl, 'Gedmo\\Loggable');
$this->loggableListener = new \Cx\Core\Model\Model\Event\LoggableListener();
$this->loggableListener->setUsername('currently_loggedin_user');
// in real world app the username should be loaded from session, example:
// Session::getInstance()->read('user')->getUsername();
$evm->addEventSubscriber($this->loggableListener);
//tree stuff
$treeListener = new \Gedmo\Tree\TreeListener();
$evm->addEventSubscriber($treeListener);
$config->setMetadataDriverImpl($chainDriverImpl);
//table prefix
$prefixListener = new \DoctrineExtension\TablePrefixListener($this->db->getTablePrefix());
$evm->addEventListener(\Doctrine\ORM\Events::loadClassMetadata, $prefixListener);
$config->setSqlLogger(new \Cx\Lib\DBG\DoctrineSQLLogger());
$em = \Cx\Core\Model\Controller\EntityManager::create($connectionOptions, $config, $evm);
//resolve enum, set errors
$conn = $em->getConnection();
$conn->setCharset($this->db->getCharset());
$conn->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
$conn->getDatabasePlatform()->registerDoctrineTypeMapping('set', 'string');
$this->em = $em;
return $this->em;
}
/**
* @param string|TokenInterface|object $username
*/
public function setUsername($username)
{
parent::setUsername($username);
if (!$username instanceof TokenInterface) {
return;
}
if (!($originalToken = $this->getOriginalToken($username))) {
return;
}
$this->sourceUsername = $originalToken->getUsername();
}
/**
*
* @return EntityManager
*/
public function getEntityManager()
{
$cache = new DoctrineCache\ArrayCache();
$annotationReader = new AnnotationReader();
$cachedAnnotationReader = new CachedReader($annotationReader, $cache);
// create a driver chain for metadata reading
$driverChain = new MappingDriverChain();
// load superclass metadata mapping only, into driver chain
// also registers Gedmo annotations.NOTE: you can personalize it
Gedmo\DoctrineExtensions::registerAbstractMappingIntoDriverChainORM($driverChain, $cachedAnnotationReader);
// now we want to register our application entities,
// for that we need another metadata driver used for Entity namespace
$annotationDriver = new AnnotationDriver($cachedAnnotationReader, $this->paths);
$driverChain->addDriver($annotationDriver, $this->namespace);
// general ORM configuration
$isDevMode = $this->env != "production";
$config = DoctrineSetup::createAnnotationMetadataConfiguration($this->paths, $isDevMode);
$config->setMetadataCacheImpl($cache);
$config->setQueryCacheImpl($cache);
$config->setMetadataDriverImpl($driverChain);
$config->setProxyDir($this->proxy_path);
$config->setProxyNamespace($this->namespace . '\\Proxy');
$config->setAutoGenerateProxyClasses($isDevMode);
// Third, create event manager and hook prefered extension listeners
$evm = new EventManager();
// gedmo extension listeners
// sluggable
$sluggableListener = new Gedmo\Sluggable\SluggableListener();
// you should set the used annotation reader to listener, to avoid creating new one for mapping drivers
$sluggableListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($sluggableListener);
// tree
$treeListener = new Gedmo\Tree\TreeListener();
$treeListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($treeListener);
// loggable, not used in example
$loggableListener = new Gedmo\Loggable\LoggableListener();
$loggableListener->setAnnotationReader($cachedAnnotationReader);
$loggableListener->setUsername('unknown');
$evm->addEventSubscriber($loggableListener);
// timestampable
$timestampableListener = new Gedmo\Timestampable\TimestampableListener();
$timestampableListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($timestampableListener);
// blameable
$blameableListener = new Gedmo\Blameable\BlameableListener();
$blameableListener->setAnnotationReader($cachedAnnotationReader);
$blameableListener->setUserValue('unknown');
// determine from your environment
$evm->addEventSubscriber($blameableListener);
// translatable - buggy !!!
/*
$translatableListener = new Gedmo\Translatable\TranslatableListener();
// current translation locale should be set from session or hook later into the listener
// most important, before entity manager is flushed
$translatableListener->setTranslatableLocale('en');
$translatableListener->setDefaultLocale('en');
$translatableListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($translatableListener);
*/
// sortable, not used in example
$sortableListener = new Gedmo\Sortable\SortableListener();
$sortableListener->setAnnotationReader($cachedAnnotationReader);
$evm->addEventSubscriber($sortableListener);
// mysql set names UTF-8 if required
$evm->addEventSubscriber(new \Doctrine\DBAL\Event\Listeners\MysqlSessionInit());
// Finally, create entity manager
return EntityManager::create($this->dbParams, $config, $evm);
}
