INFO: Version 18.xModultyp:

Bearbeiten eines Ereignisses

In der Entwurfsansicht der Bearbeitung eines Ereignisses können Sie die entsprechenden Aktionen festlegen, die bei Eintritt dieses Ereignisses vorgenommen werden sollen. So lassen sich z.B. zu einem Ereignis Protokollierungen oder andere Aktionen (E-Mail Benachrichtigung, etc.) einrichten.

Ereignisse gibt es auf Systemebene, auf Projektebene und auf Verzeichnisebene. Die Abarbeitung der Ereignisse erfolgt dabei immer zuerst auf Verzeichnisebene und dann auf Projektebene. System-Ereignisse betreffen grundsätzlich keine Projekt- bzw. Verzeichnisfunktion und werden abhängig vom der jeweiligen Ereignis abgefeuert.

Nachfolgend werden die Ereignisse auf Verzeichnisebene erläutert.

Bearbeiten eines Ereignisses - Entwurfsansicht
Bearbeiten eines Ereignisses - Entwurfsansicht

Bedienung

Innerhalb des Registers 'Entwurf' können Sie den PHP-Code angeben, der als Aktion zum entsprechenden Ereignis ausgeführt werden soll. Geben Sie diesen ohne die umschliessenden PHP-Tags (<?php ... ?>) an!
In der rechten Spalte werden standardmäßig bereits diverse Code-Fragmente angeboten.

'Eingabefeld':

In diesem Feld tragen Sie den PHP-Code ein, der als Aktion zum entsprechenden Ereignis ausgeführt werden soll.

'Makros / Code-Beispiele':

Durch Klick auf eines der Makros in der rechten Spalte (vordefinierte Code-Fragmente) wird der Script-Code in das Inhaltsfenster geschrieben. Sollte bereits Quelltext im Inhaltsfenster vorhanden sein, wird der entsprechende Code am Ende angefügt.

Übersicht der möglichen Ereignisse

Für die entsprechenden Ereignisse kann vor bzw. nach Eintritt des jeweiligen Ereignisses eine Aktion definiert werden, womit Ihnen folgende Ereignisse zur Verfügung stehen:

  • onBeforeUpload
  • onAfterUpload
  • onBeforeCreateFile
  • onAfterCreateFile
  • onAfterCreateDraft
  • onBeforeExitEdit
  • onAfterExitEdit
  • onAfterPauseEdit
  • onBeforeSaveFile
  • onAfterSaveFile
  • onAfterChangeManualOrderId
  • onBeforeInitWorkflow
  • onBeforeRenameFile
  • onAfterRenameFile
  • onBeforeCopyFile
  • onAfterCopyFile
  • onBeforeMoveFile
  • onAfterMoveFile
  • onBeforePasteFile
  • onAfterPasteFile
  • onBeforeSetOnlineFile
  • onAfterSetOnlineFile
  • onBeforeSetOfflineFile
  • onAfterSetOfflineFile
  • onBeforeCheckInFile
  • onAfterCheckInFile
  • onBeforeCheckOutFile
  • onAfterCheckOutFile
  • onBeforeDeleteFile
  • onAfterDeleteFile
  • onBeforeChangeUserContent 
  • onAfterChangeUserContent 
  • onBeforeCreateDir 
  • onAfterCreateDir 
  • onBeforeRenameDir 
  • onAfterRenameDir 
  • onBeforeDeleteDir 
  • onAfterDeleteDir
  • onBeforeShowDir
  • onBeforeCopyDir
  • onAfterCopyDir
  • onBeforePasteDir
  • onAfterPasteDir
  • onBeforeAccessDocument
  • onAfterSubscribeNewsletter
  • onAfterConfirmSubscriptionNewsletter
  • onAfterUnsubscribeNewsletter
  • onAfterAddPersonalizationDataNewsletterText
  • onAfterAddPersonalizationDataNewsletterHTML
  • onAfterAddPersonalizationDataNewsletterWeb
  • onAfterChangeStatusNewsletter
    (mögliche Parameter: dirPath und newsletterStatus)
  • onAfterCopyNewsletter
    (mögliche Parameter: dirPath)
  • onAfterDeleteNewsletter
  • onBeforeImportCSV
  • onAfterImportCSV
  • onAfterApproveFile
  • onBeforeReleaseFile 
  • onAfterReleaseFile 
  • onAfterRejectFile
  • onAfterCreateImage

Abhängig vom jeweiligen Ereignis stehen Ihnen innerhalb der Aktionen im PHP-Code folgende Systemparameter zur Verfügung:

  • Für Projektereignisse
    • $eventData['wEventObjectType']
      Objekttyp (hier: project)
    • $eventData['wEventName']
      Name des Ereignisses (z.B. onAfterUpload)
    • $eventData['wEventTime']
      Zeitstempel des Ereignisses (date('Y-m-d H:i:s'))
    • $eventData['wEventUser']
      Benutzer, der das Ereignis angestossen hat (z.B. mustermann)
    • $eventData['userAction']
      Unterscheiden von Speichern (saveAndExit) und Zwischenspeichern (save)
      (wird nur bei den Speicher-Aktionen zur Verfügung gestellt (onBeforeSave, onAfterSave)
    • $eventData['projectPath']
      Projektpfad, in dem das Ereignis ausgeführt wird (z.B. /de)
    • $eventData['filePath']
      Dateipfad, der vom Ereignis betroffen ist (z.B. /de/unternehmen/index.php)
    • $eventData['dirPath']
      Verzeichnispfad, der vom Ereignis betroffen ist (z.B. /de/unternehmen)
    • $eventData['fileNewPath']
      Neuer Verzeichnispfad, der vom Ereignis betroffen ist (z.B. /de/niederlassungen)
  • Für Verzeichnisereignisse
    • $eventData['wEventObjectType']
      Objekttyp (hier: directory)
    • $eventData['wEventName']
      Name des Ereignisses (z.B. onAfterUpload)
    • $eventData['wEventTime']
      Zeitstempel des Ereignisses (date('Y-m-d H:i:s'))
    • $eventData['wEventUser']
      Benutzer, der das Ereignis angestossen hat (z.B. mustermann)
    • $eventData['userAction']
      Unterscheiden von Speichern (saveAndExit) und Zwischenspeichern (save)
      (wird nur bei den Speicher-Aktionen zur Verfügung gestellt (onBeforeSave, onAfterSave)
    • $eventData['projectPath']
      Projektpfad, in dem das Ereignis ausgeführt wird (z.B. /de)
    • $eventData['filePath']
      Dateipfad, der vom Ereignis betroffen ist (z.B. /de/unternehmen/index.php)
    • $eventData['dirPath']
      Verzeichnispfad, der vom Ereignis betroffen ist (z.B. /de/unternehmen)
    • $eventData['fileNewPath']
      Neuer Verzeichnispfad, der vom Ereignis betroffen ist (z.B. /de/niederlassungen)

Der Verwendungszweck dieser Systemparameter leitet sich bereits aus der Benennung ab. An Stelle dieser Systemparameter können Sie natürlich auch PHP-Framework-Funktion oder eigene PHP-Funktionen einsetzen.