Eine eigene Fetch-Funktion schreiben #

Diese Seite richtet sich an Anwendungsentwickler, die möchten, dass Templates ihre Daten mit fetch( 'expdemo', 'items', hash( ... ) ) lesen. Eine Fetch-Funktion wird in der function_definition.php des Moduls deklariert und von einer statischen Methode implementiert, die array( 'result' => ... ) zurückgibt.

Inhalt #

1. Die Deklaration
2. Die Implementierung
3. Verwendung
4. Regeln

Die Deklaration #

extension/expdemo/modules/expdemo/function_definition.php, im selben Verzeichnis wie module.php:

<?php
$FunctionList = array();
// fetch( 'expdemo', 'items', hash( 'limit', 5, 'offset', 0 ) )
$FunctionList['items'] = array(
    'name' => 'items',
    'operation_types' => array( 'read' ),
    'call_method' => array( 'class' => 'expDemoFunctionCollection',
                            'method' => 'fetchItems' ),
    'parameter_type' => 'standard',
    'parameters' => array(
        array( 'name' => 'limit',  'type' => 'integer', 'required' => false, 'default' => 10 ),
        array( 'name' => 'offset', 'type' => 'integer', 'required' => false, 'default' => 0 ) ) );

Die Dateien des Kernels haben dieselbe Form (kernel/exphelp/function_definition.php, kernel/content/function_definition.php).

Die Implementierung #

extension/expdemo/classes/expdemofunctioncollection.php:

<?php
class expDemoFunctionCollection
{
    public static function fetchItems( $limit = 10, $offset = 0 )
    {
        $limit = max( 1, min( 100, (int)$limit ) );
        $offset = max( 0, (int)$offset );
        $access = eZUser::currentUser()->hasAccessTo( 'expdemo', 'read' );
        if ( $access['accessWord'] === 'no' )
            return array( 'result' => array() );
        return array( 'result' => expDemoItem::fetchList( $limit, $offset ) );
    }
}

Geben Sie bei Erfolg array( 'result' => $value ) zurück. Generieren Sie danach die Autoloads neu und leeren Sie die Caches.

Verwendung #

{def $items = fetch( 'expdemo', 'items', hash( 'limit', 5 ) )}
{foreach $items as $item}<li>{$item.title|wash}</li>{/foreach}
{undef $items}

Zurückgegebene Objekte sollten eZPersistentObjects sein oder attribute() und hasAttribute() anbieten, damit Templates $item.title lesen können (Persistente Objekte und eigene Tabellen).

Regeln #

• Prüfen Sie die Rechte innerhalb der Funktion; Templates können von überall aufgerufen werden.
• Begrenzen Sie jedes Limit.
• Halten Sie die Methode schlank: Rufen Sie eine Dienstklasse auf, die auch Ihre Ansichten und Befehle verwenden.
• Benennen Sie Parameter wie die Inhalts-Fetches (limit, offset, sort_by), damit Template-Autoren richtig raten.
• Testen Sie die statische Methode wie jede Klasse mit PHPUnit (PHPUnit-Tests ohne Datenbank).

Verwandte Seiten #

• Fetch-Funktionen: Daten in Templates lesen
• Muster für Fetch-Funktionen
• Template-Operatoren schreiben
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.