Hotfolder
- Paul Maul
- Sebastian Schulz
Das Paket dam/hotfolder bietet die Möglichkeit Ordner von einem CronJob überwachen zu lassen und enthaltene Dateien automatisch über Formatvorlagen zu konvertieren.
Aufbau
dam/hotfolder nutzt die Tabelle Hotfolder als zentrale Steuerungseinheit zur Überwachung von Ordnern. Ein Hotfolder-Datensatz besteht aus folgenden Eigenschaften.
Eigenschaft | Bezeichnung | Beschreibung |
|---|---|---|
label | Bezeichnung. | Zeichenkette. Eine einfache Zeichenkette, die zur Identifikation des Datensatzes dient. |
sourceFolderId | Ursprungsordner | Fremdschlüssel. Der Ursprungsordner, der überwacht werden soll. Die Dateiinhalte werden anhand der verknüpften Formatvorlagen konvertiert und in den Zielordner verschoben. |
convertFolderId | Zielordner | Fremdschlüssel. Der Zielordner, in den konvertierte Dateien verschoben werden sollen. |
archiveFolderId | Archivordner. | Fremdschlüssel. Der Ordner, in den die konvertierten Originaldateien verschoben werden sollen. |
fileFormatId | Dateinamenformat | Fremdschlüssel. Das Dateinamenformat, welches zur Umbenennung der konvertierten Dateien genutzt werden soll. |
formatPresetIds | Ausgabeformate | Fremdschlüssel. Die Ausgabeformate, welche auf die Dateien im Ursprungsordner angewendet werden sollen. |
Die angelegten Hotfolder-Datensätze werden periodisch von einem CronJob auf ihre Inhalte überprüft. Unkonvertierte Dateien werden in eine Warteschlange eingetragen, welche ebenfalls von einem CronJob verarbeitet wird. Wurde eine Datei vollständig konvertiert, wird sie in den definierten Zielordner übertragen.
Dateinamenformat
Die Dateinamenformate (Formatierte Umbenennung von Dateien) können hier genutzt werden, um konvertierte Dateien einem bestimmten Schema nach umzubenennen. Folgende wildcards können genutzt werden, um die Dateinamen zu beeinflussen.
Wildcard | Beschreibung |
|---|---|
hfOriginalFilename | Der Dateiname der Originaldatei. |
hfExtension | Die Dateiendung, welche in dem dazugehörigen Dateinamenformat definiert wurde. |
hfFormatPresetId | Die Id, der zur Konvertierung genutzten Formatvorlage. |
Die wildcards müssen von doppelten geschweiften Klammern im Dateinamenformat umklammert werden. Ein Format könnte bspw. so aussehen: {{hfOriginalFilename}}_{{hfExtension}}
Wird kein Dateinamenformat angegeben, wird der automatisch generierte Name von Imagemagick genutzt.
Events
Name | Beschreibung |
|---|---|
OnMoveConvertedFile | Dieses Event wird genutzt, um die konvertierten Dateien in die entsprechenden Zielverzeichnisse zu verschieben. |
OnMoveSourceFile | Dieses Event wird genutzt, um die Originaldateien in die entsprechenden Zielverzeichnisse zu verschieben. |