Einen Workflow-Ereignistyp schreiben #

Diese Seite richtet sich an PHP-Entwickler, die einen Schritt hinzufügen, den Administratoren in Workflows einsetzen können: ein externes System benachrichtigen, wenn Inhalte veröffentlicht werden, ein Feld vor dem Veröffentlichen prüfen, auf eine Freigabe warten. Ein Workflow läuft, wenn ein Trigger auslöst (zum Beispiel content/publish/before oder after); jedes seiner Ereignisse ist eine Instanz eines Ereignistyps, also einer Klasse, die eZWorkflowEventType erweitert. Das vollständige Beispiel mit Templates finden Sie unter Einen Workflow-Ereignistyp schreiben.

Inhalt #

1. Registrierung
2. Die Klasse
3. Was execute() erhält
4. Die Status
5. Einstellungen pro Ereignis
6. Auf Cron verschieben
7. Regeln
8. Ereignistyp oder Event-Listener?

Registrierung #

extension/acmereport/eventtypes/event/acmenotify/acmenotifytype.php
extension/acmereport/settings/workflow.ini.append.php

<?php /* #?ini charset="utf-8"?
[EventSettings]
ExtensionDirectories[]=acmereport
AvailableEventTypes[]=event_acmenotify
*/ ?>

Einträge in AvailableEventTypes[] sind die Gruppe (event) und der Typ-String, verbunden durch _, wie event_ezapprove des Kernels in settings/workflow.ini.

Die Klasse #

<?php
class acmeNotifyType extends eZWorkflowEventType
{
    const WORKFLOW_TYPE_STRING = 'acmenotify';

    public function __construct()
    {
        parent::__construct( self::WORKFLOW_TYPE_STRING, ezpI18n::tr( 'extension/acmereport', 'Notify the archive' ) );
        $this->setTriggerTypes( array( 'content' => array( 'publish' => array( 'after' ) ) ) );
    }

    function execute( $process, $event )
    {
        $parameters = $process->attribute( 'parameter_list' );
        $object = eZContentObject::fetch( (int)$parameters['object_id'] );
        if ( !$object )
            return eZWorkflowType::STATUS_WORKFLOW_CANCELLED;

        acmeReportQueue::add( $object->attribute( 'id' ), (int)$parameters['version'] );
        return eZWorkflowType::STATUS_ACCEPTED;
    }
}

eZWorkflowEventType::registerEventType( acmeNotifyType::WORKFLOW_TYPE_STRING, 'acmeNotifyType' );

setTriggerTypes() begrenzt die Trigger, mit denen das Ereignis verwendet werden kann, sodass Administratoren es nicht dort anhängen können, wo es keinen Sinn ergibt. eZWaitUntilDateType des Kernels (kernel/classes/workflowtypes/event/ezwaituntildate/) ist ein vollständiges Beispiel.

Was execute() erhält #

Für die Operation zum Veröffentlichen von Inhalten enthalten die Parameter object_id und version. Casten Sie sie: Es sind Werte, keine Objekte.

Die Status #

eZWorkflowType (kernel/classes/ezworkflowtype.php) definiert die Antworten von execute():

Einstellungen pro Ereignis #

Was ein Administrator im Workflow-Editor für das Ereignis einstellt, wird durch Überschreiben von fetchHTTPInput() und validateHTTPInput() gelesen und in den Spalten des Ereignisses gespeichert. Liefern Sie die Templates workflow/eventtype/edit/event_acmenotify.tpl und workflow/eventtype/view/event_acmenotify.tpl in Ihrem Design mit, wie event_ezapprove.tpl des Kernels.

Auf Cron verschieben #

Ein Ereignis, das wartet (auf eine Freigabe, ein Datum, eine externe Antwort), gibt STATUS_DEFERRED_TO_CRON_REPEAT zurück; das Cronjob-Skript workflow führt execute() später erneut aus, und Setup > Workflow-Prozesse zeigt die wartenden Prozesse. Der Redakteur sieht die Veröffentlichung als ausstehend, bis das Ereignis akzeptiert.

Regeln #

• Schnell. execute() läuft innerhalb der Veröffentlichungsanfrage des Redakteurs. Stellen Sie langsame Arbeit (externe Aufrufe, Mail, Bildverarbeitung) in eine Warteschlange, statt sie dort zu erledigen (Hintergrundarbeit).
• Keine Exceptions aus execute() heraus. Fangen Sie ab, was fehlschlagen kann, protokollieren Sie es und geben Sie einen Status zurück.
• Idempotent. Ein verschobenes Ereignis läuft mehr als einmal; machen Sie den zweiten Lauf harmlos.
• Logik außerhalb der Klasse. Legen Sie die Entscheidung in einen Dienst, den Sie ohne Workflow testen können.

Ereignistyp oder Event-Listener? #

Verwandte Seiten #

• Workflows, Trigger und Ereignisse
• eZWorkflowType-API
• Das Muster Workflow-Ereignis
• Freie Dokumentation: diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.