Lifecycle

Persistence Context

Jeder EntityManager bildet einen Persistence Context. Der Persistence Context verwaltet alle Entity-Objekte, die über den EntityManager geladen wurden. Im Persistence Context kann pro Entity und Id immer nur eine Instanz existieren. Fragst du zwei Mal das selbe Entity-Objekt ab (egal ob über EntityManager::find(), die Criteria API oder NQL), liefert dir der EntityManager also beide Male die selbe Instanz dieser Entity zurück.

        $article = $em->find(Article::getClass(), $id);
        $article2 = $em->createSimpleCriteria(Article::getClass(), array('id' => $id))
                ->toQuery()->fetchSingle();
        
        var_dump($article === $article2); // bool(true)

EntityManager::find() überprüft zuerst, ob das zu ladende Entity-Objekt bereits vom Persistence Context verwaltet wird und gibt im Erfolgsfall dieses direkt zurück, ohne auf die Datenbank zuzugreifen. Abfragen über die  Criteria API oder NQL führen aber immer zu einer Datenbank-Abfrage. Dies gilt auch, wenn alle Objekte, die zurückgegeben werden, bereits im Persistence Context verwaltet werden. Die Eigenschaften dieser Entity-Objekte werden dabei nicht mit den aktuellen Werten aus der Datenbank überschrieben. Änderungen, die noch nicht in die Datenbank geschrieben wurden, bleiben also bestehen.

Änderungen an Entity-Objekten werden erst bei einem Flush-Ereignis in die Datenbank geschrieben. Ein Flush-Ereignis kann über EntityManager::flush() oder durch den Commit einer Transaktion ausgelöst werden.

Entity States

Entity-Objekte können einen der folgenden Status haben:

• NEW: Eine neu erstelltes Entity-Objekt, das noch nie einem Persistence Context angehört hat.

• MANAGED: Ein persistentes Entity-Objekt, für das ein ensprechender Eintrag in der Datenbank existiert oder ein neu erstelles Entity-Objekt, auf das die Persist-Operation angewendet wurde. Alle Änderungen an einem Entity-Objekt mit Status MANAGED werden beim nächsten Flush-Ereignis automatisch in die Datenbank übernommen (UPDATE-Statements werden abgesetzt).

• DETACHED: Entity-Objekte, die nicht mehr vom Persistence Context verwaltet werden. Änderungen an solchen Entity-Objekten werden nicht mehr in die Datenbank übernommen. Das Entity-Objekt wird auch als DETACHED erkannt, wenn es aus einem anderen Persistence Context stammt (z. B. wenn es über einen anderen EntityManager geladen wurde).

• REMOVED: Entity-Objekte, auf welche die Remove-Operation angewendet wurde.

Operationen

Mit den Operationen Persist, Merge, Remove und Detach kannst du den Status eines Entity-Objekts ändern.

Callbacks

Du kannst Callback-Methoden für Lifecycle-Events direkt in der Entity implementieren. Diese Methoden sind magisch. Folgende Methoden stehen zur Verfügung:

Callback-Methoden können eine beliebige Sichtbarkeit haben.

class Article extends ObjectAdapter {
    private $lastMod;
    
    private function _prePersist() {
        $this->lastMod = new \DateTime();
    }

    private function _preUpdate() {
        $this->lastMod = new \DateTime();
    }

    public function setLastMod(\DateTime $lastMod) {
        $this->lastMod = $lastMod;
    }
    /**
     * @return \DateTime
     */
    public function getLastMod() {
        return $this->lastMod;
    }
    
    // rest of class body
}

In diesem Beispiel fügen wir der Entity Article eine neue Eigenschaft $lastMod vom Typ [Andreas, Link]DateTime[/Andreas, Link] hinzu. Die Eigenschaft soll das Datum und die Zeit der letzten Änderung enthalten. Um dies zu realisieren, nutzen wir die Callback-Methoden _prePersist() und _preUpdate(), um diese Eigenschaft zu aktualisieren.

Callback-Methoden kannst du auch in "Entity-Listener" auslagern. Diese annotierst du mit n2n\persistence\orm\annotation\AnnoEntityListeners.

class Article extends ObjectAdapter {
    private static function _annos(AnnoInit $ai) {
        $ai->c(new AnnoEntityListeners(LastModListener::getClass()));
    }
   
    private $lastMod;
   
    public function setLastMod(\DateTime $lastMod) {
        $this->lastMod = $lastMod;
    }
    /**
     * @return \DateTime
     */
    public function getLastMod() {
        return $this->lastMod;
    }
    
    // rest of class body
}

AnnoEntityListeners erwartet die ReflectionClass-Objekte der "Entity-Listener". Deshalb sollten auch deine "Entity-Listener" n2n\reflection\ObjectAdapter erweitern.

class LastModListener extends ObjectAdapter {
    private function _prePersist(Article $article) {
        $article->setLastMod(new \DateTime());
    }
    
    private function _preUpdate(Article $article) {
        $article->setLastMod(new \DateTime());
    }
}

Den magischen Callback-Methoden kannst du das betreffende Entity-Objekt übergeben lassen. "Entity-Listener"-Klassen werden magisch initialisiert (_init() ist verfügbar).