ORM und Active Record: eZPersistentObject #

Diese Seite richtet sich an Entwickler, die Daten mit Eloquent, Doctrine, dem Django-ORM oder dem ActiveRecord von Rails modellieren. Exponential bietet zwei Antworten. Für Daten, die Redakteure anlegen und pflegen, gibt es das Inhaltsmodell (Klassen, Objekte, Versionen), das Sie konfigurieren statt programmieren (Das Inhaltsmodell für ORM-Nutzer). Für die eigenen Tabellen Ihrer Anwendung gibt es eZPersistentObject (kernel/classes/ezpersistentobject.php), eine kleine Active-Record-Basisklasse, die der Kernel selbst für seine Tabellen verwendet (eZSection, eZRole und viele weitere).

Inhalt #

1. Inhaltsklasse oder eigene Tabelle?
2. Ein Modell
3. Lesen und Schreiben
4. Relationen
5. Transaktionen
6. Im Vergleich mit vollständigen ORMs

Inhaltsklasse oder eigene Tabelle? #

Aus Persistente Objekte und eigene Tabellen:

Ein Modell #

<?php
class expDemoItem extends eZPersistentObject
{
    public static function definition()
    {
        return array(
            'fields' => array(
                'id'      => array( 'name' => 'ID', 'datatype' => 'integer', 'default' => 0, 'required' => true ),
                'user_id' => array( 'name' => 'UserID', 'datatype' => 'integer', 'default' => 0, 'required' => true ),
                'title'   => array( 'name' => 'Title', 'datatype' => 'string', 'default' => '', 'required' => true ),
                'created' => array( 'name' => 'Created', 'datatype' => 'integer', 'default' => 0, 'required' => true ) ),
            'keys' => array( 'id' ),
            'increment_key' => 'id',
            'function_attributes' => array( 'user' => 'user' ),
            'class_name' => 'expDemoItem',
            'sort' => array( 'created' => 'desc' ),
            'name' => 'expdemo_item' );
    }

    public function user()
    {
        return eZUser::fetch( $this->attribute( 'user_id' ) );
    }
}

Das definition()-Array ist das Mapping (was Doctrine in Attribute oder XML schreibt und Eloquent aus der Tabelle ableitet): Felder mit Typen und Standardwerten, der Primärschlüssel, der Auto-Increment-Schlüssel, der Tabellenname und Funktionsattribute, also berechnete Eigenschaften, die Templates als $item.user.login lesen können.

Lesen und Schreiben #

$item  = eZPersistentObject::fetchObject( expDemoItem::definition(), null, array( 'id' => (int)$id ) );
$items = eZPersistentObject::fetchObjectList( expDemoItem::definition(), null,
                                              array( 'user_id' => (int)$userID ),
                                              array( 'created' => 'desc' ),
                                              array( 'offset' => 0, 'length' => 20 ) );
$count = eZPersistentObject::count( expDemoItem::definition(), array( 'user_id' => (int)$userID ) );

$item = new expDemoItem( array( 'user_id' => $userID, 'title' => $title, 'created' => time() ) );
$item->store();                     // insert; the id is set from increment_key
$item->setAttribute( 'title', $newTitle );
$item->store();                     // update
$item->remove();                    // delete

Bedingungen sind Arrays, niemals SQL-Strings, und die Werte werden für Sie maskiert. Die meisten Projekte ergänzen statische Hilfsmethoden wie expDemoItem::fetch( $id ) und expDemoItem::fetchByUser( $userID ), so wie es die Klassen des Kernels tun.

Relationen #

Es gibt keine deklarierten Relationen (hasMany, ManyToOne, ForeignKey) und keine Lazy-Loading-Proxys. Schreiben Sie die Methode selbst, wie user() oben, und stellen Sie sie über function_attributes bereit, wenn Templates sie benötigen. Für Many-to-many-Daten modellieren Sie die Verknüpfungstabelle als eigenes persistentes Objekt. Inhalte haben eigene Relationen (Objektrelationen und den Baum), die Sie über die Inhalts-API lesen.

Transaktionen #

$db = eZDB::instance();
$db->begin();
// several store() and remove() calls
$db->commit();

Verschachtelte begin()-Aufrufe werden gezählt; nur das äußerste commit() schreibt die Transaktion fest (Datenbankzugriff und SQL). Halten Sie niemals eine Transaktion um einen langsamen entfernten Aufruf herum offen.

Im Vergleich mit vollständigen ORMs #

Sie können weiterhin eine Composer-Bibliothek in Ihrer Erweiterung verwenden (der Autoloader von Composer wird von autoload.php geladen), aber ein zweites ORM bedeutet eine zweite Verbindung, und Inhalte müssen trotzdem über die Inhalts-API geschrieben werden, damit Versionen, Caches, Berechtigungen und Suche konsistent bleiben.

Verwandte Seiten #

• Persistente Objekte und eigene Tabellen
• Das Active-Record-Muster
• Standard für Datenbanken und SQL
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.