Zikula-Modulentwicklung Zikula-Modulentwicklung
MySQL-spezifische Funktionen in DQL nutzen

Dienstag, 30. Juni 2015

Im Kern von Doctrine 2 wird Wert darauf gelegt, dass die Doctrine Query Language (DQL) möglichst portabel bleibt, damit Projekte einfach mit unterschiedlichen Datenquellen arbeiten können. Bei Webanwendungen kommt es immer wieder einmal vor, dass man eine bestimmte Funktion benötigt, die zwar in MySQL existiert, jedoch nicht von DQL unterstützt wird.

Man kann in solchen Fällen eigene DQL-Funktionen erstellen, dies ist aber in den meisten Fällen zum Glück nicht nötig. Denn in den DoctrineExtensions von Benjamin Eberlei befinden sich bereits eine ganze Reihe von MySQL-Funktionen. Dieses Paket ist idealerweise auch im Zikula Core enthalten, so dass man sie für die eigenen Module direkt nutzen kann.

Zumindest in Zikula 1.3.x sind die Funktionen aber per Standard nicht via Symfony registriert (für 1.4 habe ich das nicht nachgeschaut, aber dort verhält es sich vermutlich ähnlich). Daher habe ich einfach die Funktionen, die ich benötigt habe, geladen und dem EntityManager von Doctrine bekannt gemacht. Das folgende Beispiel ist Code aus einer Repository-Methode, die eine gegebene QueryBuilder-Instanz erweitert:

  1.  
  2.     $config = $this->getEntityManager()->getConfiguration();
  3.     $config->addCustomNumericFunction('ACOS', 'DoctrineExtensions\Query\Mysql\Acos');
  4.     $config->addCustomNumericFunction('COS', 'DoctrineExtensions\Query\Mysql\Cos');
  5.     $config->addCustomNumericFunction('RADIANS', 'DoctrineExtensions\Query\Mysql\Radians');
  6.     $config->addCustomNumericFunction('SIN', 'DoctrineExtensions\Query\Mysql\Sin');
  7.     $qb->addSelect(
  8.         '(6371 * ACOS( COS( RADIANS(\'' . $lat . '\') )
  9.             * COS( RADIANS( tbl.latitude ) )
  10.             * COS( RADIANS( tbl.longitude ) - RADIANS(\'' . $long . '\') )
  11.             + SIN( RADIANS(\'' . $lat . '\') )
  12.             * SIN( RADIANS( tbl.latitude ) ) ) ) AS ' . /*HIDDEN */ 'distance'
  13.     )
  14.     ->having('distance <= :distance')
  15.     ->setParameter('distance', $radius)
  16.     ->orderBy('distance');
  17.  

Das Keyword HIDDEN ist derzeit auskommentiert, da in Zikula 1.3 noch eine ältere Version von Doctrine 2 verwendet wird, die dieses Schlüsselwort noch nicht unterstützt. Bei der Umstellung des Modules auf 1.4 wird es dann aktiviert, was die weitere Behandlung des Abfrageergebnisses etwas vereinfacht. Denn mit dem zusätzlichen Feld distance liefert die Abfrage nicht mehr die selekterten Objekte alleine, sondern ein Array mit Paaren aus den Objekten und dem neuen Feld zurück.

 

Weitere Beiträge in Kategorie Zikula-Modulentwicklung

^