Die Content-API #

Diese Seite richtet sich an Anwendungsentwickler, die Inhalte in PHP lesen: in Ansichten, Diensten, Befehlen und Cronjobs. Die Klassen sind eZContentObject, eZContentObjectTreeNode und eZContentObjectAttribute des Kernels in kernel/classes/.

Inhalt #

1. Objekte, Knoten und Attribute
2. Ein einzelnes Element abrufen
3. Listen abrufen
4. Attribute lesen
5. Versionen und Sprachen
6. Rechte und Kontext

Objekte, Knoten und Attribute #

Ein einzelnes Element abrufen #

$object = eZContentObject::fetch( 57 );
$object = eZContentObject::fetchByRemoteID( 'expdemo-settings-page' );
$node   = eZContentObjectTreeNode::fetch( 2 );
$node   = eZContentObjectTreeNode::fetchByURLPath( 'about_us' );

Verwenden Sie für Inhalte, von denen Ihre Anwendung abhängt, bevorzugt Remote-IDs: Sie sind über Installationen hinweg stabil, IDs nicht.

Listen abrufen #

$nodes = eZContentObjectTreeNode::subTreeByNodeID( array(
    'ClassFilterType'  => 'include',
    'ClassFilterArray' => array( 'event' ),
    'AttributeFilter'  => array( array( 'event/start_date', '>=', time() ) ),
    'SortBy'           => array( array( 'attribute', true, 'event/start_date' ) ),
    'Depth'            => 3,
    'Limit'            => 20,
    'Offset'           => 0 ), $parentNodeID );

$count = eZContentObjectTreeNode::subTreeCountByNodeID( array(
    'ClassFilterType' => 'include', 'ClassFilterArray' => array( 'event' ) ), $parentNodeID );

Das ist die PHP-Seite der Template-Fetches (Fetch-Funktionen: Daten in Templates lesen). Setzen Sie immer ein Limit.

Attribute lesen #

$dataMap = $object->dataMap();                     // identifier => eZContentObjectAttribute
if ( isset( $dataMap['title'] ) && $dataMap['title']->hasContent() )
    $title = $dataMap['title']->content();         // a string for ezstring
$image = $dataMap['image']->content();             // an eZImageAliasHandler for ezimage
$alias = $image->attribute( 'medium' );            // url, width, height, alternative_text
$text  = $dataMap['title']->toString();            // a plain string form for every datatype

content() liefert, was der Datentyp speichert (eine Zeichenkette, eine Zahl, ein Objekt); toString() eine Zeichenkette, die Sie speichern und später an fromString() übergeben können (Lebenszyklus eines Datentyps).

Versionen und Sprachen #

$version = $object->version( $object->attribute( 'current_version' ) );
$germanMap = $object->fetchDataMap( false, 'ger-DE' );
$languages = $object->availableLanguages();

Die aktuelle Version ist die veröffentlichte; Entwürfe sind andere Versionen mit eigenem Status. Welche Sprache eine Seite zeigt, folgt der SiteLanguageList des Siteaccess (Inhaltssprachen).

Rechte und Kontext #

• subTreeByNodeID() wendet content/read des aktuellen Benutzers an, sofern Sie nicht 'Limitation' => array() übergeben; übergeben Sie das niemals in Code, der Benutzern Ergebnisse zeigt.
• $node->canRead() und $object->canEdit() prüfen ein einzelnes Element (Richtlinienfunktionen und Einschränkungen).
• In Kommandozeilenskripten ist der aktuelle Benutzer anonym, bis Sie einen anmelden; Skripte, die mehr brauchen, müssen einen eigens dafür vorgesehenen Benutzer anmelden (eZUser::setCurrentlyLoggedInUser()), nicht den Administrator.
• Große Listen: Rufen Sie seitenweise ab und leeren Sie dazwischen die Caches im Speicher (eZContentObject::clearCache()), damit einem langen Skript nicht der Speicher ausgeht.

Verwandte Seiten #

• Inhalte im Code anlegen
• Persistente Objekte und eigene Tabellen
• Active-Record-Muster
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.