Formatierte Umbenennung von Dateien
- Paul Maul
- Sebastian Schulz
- Dirk Münker
Im dam-Modul gibt es die Möglichkeit Dateinamen automatisch vergeben zu lassen. Diese Dateinamen folgen einem bestimmten Format, das einem bestimmten Schema folgen muss. Das definierbare Dateiformat enthält eine Zahl, die hochgezählt wird.
Aufbau des Plugins
Das Plugin dam/file wurde um eine Tabelle(fileNameConfig) erweitert. In dieser Konfiguration werden u.A. die Funktionalität aktiviert bzw. deaktiviert und ein Format definiert. Jedem Datensatz sollte eine Rolle zugewiesen werden, da je nach aktiver Rolle die entsprechende Konfiguration gewählt wird.
Das Verhalten bei einem Nutzer mit min. zwei Rollen, die jeweils eine Konfiguration haben, ist undefiniert.
Es sollte nur ein Datensatz pro Rolle erstellt werden und es wird nur eine Rolle pro Nutzer erwartet.
Ein Dateinamenformat könnte so aussehen: BB5-%05dKM . Die ersten fünf Dateinamen würden wie folgt aussehen:
BB5-00001KM
BB5-00002KM
BB5-00003KM
BB5-00004KM
BB5-00005KM
Konfiguration
Bezeichnung | Attribut | Beschreibung |
|---|---|---|
Aktiv | fileNameConfigIsActive | Bool'scher Wert, der entscheidet, ob die Funktionalität aktiv ist, oder nicht. |
Optional | fileNameConfigIsOptional | Bool'scher Wert, der darüber entscheidet, ob die automatische Umbenennung im Uploadvorgang angeboten wird. Ist der Haken nicht gesetzt (nicht optional), werden alle hochgeladenen Dateien automatisch nach dem definierten Format umbenannt. |
Bezeichnung | fileNameConfigName | Name für den Datensatz. |
Dateinamenformat | fileNameConfigFormat | Das Format, das zur Umbenennung der Dateien verwendet werden soll. Das Format muss ein valides sprintf-Format sein (siehe "https://www.php.net/manual/de/function.sprintf.php"). |
Zugewiesene Rolle | fileNameConfigAssignedRole | Dieser Datensatz ist für diese Rolle gültig. |
Zugewiesener Nutzer | fileNameConfigAssignedUser | Dieser Datensatz ist für diesen Nutzer gültig. Hat Priorität gegenüber der Rolle. |
Zugewiesener Administrator | fileNameConfigAssignedAdminsitrator | Dieser Datensatz ist für diesen Administrator gültig. Hat Priorität gegenüber der Rolle. |
Zähler | fileNameConfigRenamedFilesCount | Ein Zähler, der zählt, wieviele Dateinamen vergeben wurden. Der nächste Dateiname nutzt den Zähler+1. WICHTIG: Wird Code geschrieben, welcher Dateinamen vergibt, muss darauf geachtet werden dieses Attribut zu inkrementieren. |
Verwendung
Dateien können auf zwei Wegen formatiert umbenannt werden:
Eintrag im Kontextmenü: Bei dem Klick auf diesen Button wird die Datei automatisch nach dem eingerichteten Format umbenannt, sofern das Modal bestätigt wird.
Upload-Vorgang:
Aktiv & nicht optional: Wird eine Datei hochgeladen, wird diese automatisch umbenannt. Der "call to action"-Schritt, bei dem potenzielle Konflikte gelistet werden, wird übersprungen.
Aktiv & optional: Wird eine Datei hochgeladen, gibt es im "call to action"-Schritt eine neue Checkbox, die es erlaubt die hochgeladene Datei formatiert umzubenennen. Wird die Checkbox gesetzt, werden die Optionen zu potenziellen Konflikten ausgeblendet.
