Was ist das?
DB-Rector ist eine TYPO3-Extension.
Diese integriert ein Modul ins TYPO3-Backend, welches jedes in der Datenbank gespeicherte TypoScript anzeigt und auf Knopfdruck mit Hilfe von TYPO3-Rector überarbeitet.
Das Ergebnis der Überarbeitung kann folgend geprüft und angepasst werden, bevor es dann in den originalen sys_template-Datensatz geschrieben werden kann.
Wie funktioniert das Ganze?
Alle existierenden Datensätze der Tabelle "sys_template" werden auf vorhandenes TypoScript im Feld "config" geprüft. Daraus werden eigenständige Datensätze generiert, die im Backend-Modul angezeigt werden.
Mit Start der Refakturierung wird das TypoScript des entsprechenden Datensatzes in eine temporäre Datei geschrieben. Diese Datei wird von TYPO3-Rector überarbeitet, das Ergebnis in den Datensatz zurückgespielt und gespeichert, die temporäre Datei wird entfernt.
Nun kann das Rector-Ergebnis im Backend-Modul geprüft und/oder angepasst werden.
Ist man mit dem Ergebnis zufrieden, kann das überarbeitete TypoScript in den originalen "sys_template"-Datensatz geschrieben werden.
Welche Funktionen bietet DB-Rector?
DB-Rector besteht aus 2 Komponenten, welche die folgenden Aufgaben übernehmen bzw. Funktionen zur Verfügung stellen.
Komponente „TypoScript“
Die Komponente "TypoScript" ist für die Kernfunktion der Extension zuständig. Hier werden die Datensätze der Tabelle "sys_template" geprüft und in eigene Datensätze umgewandelt. Diese werden als Liste angezeigt.
Für jeden einzelnen Datensatz stehen folgende Möglichkeiten zur Verfügung:
- Detailansicht
- Initiieriung des TYPO3-Rector-Prozesses (je Datensatz, für eine Auswahl oder alle Datensätze)
- nach erfolgreicher Refakturierung:
- Detailansicht des Datensatzes mit Bearbeitungsmöglichkeit des TYPO3-Rector-Ergebnisses
- Übertrag des refakturierten TypoScripts in den Originaldatensatz
- nach Übertrag des Ergebnisses:
- Wiederherstellen des Original-TypoScripts
Automatische Aktualisierung der Datensätze
Bei jedem Aufruf der Komponente wird geprüft, ob der Original-Datensatz der Tabelle "sys_template" nach dem Anlegen des jeweiligen DB-Rector-Datensatzes geändert wurde. Wenn dem der Fall ist und die Änderung im Feld "config" stattfand und über eingefügte Leerzeichen und Zeilenumbrüche hinausgeht, wird der existente Datensatz vollständig aktualisiert. Dies bedeutet, dass bereits refakturiertes TypoScript gelöscht und das, im Datensatz gespeicherte, Original-TypoScript überschrieben wird.
Das nun überarbeitete TypoScript des "sys_template"-Datensatz kann nun erneut durch TYPO3-Rector geprüft und überarbeitet werden.
Komponente "Setup check"
Die Komponente "Setup check" ist für die Prüfung des Systems zuständig. Hier können folgende Informationen entnommen werden:
- aktuell verwendete TYPO3-Version
- TYPO3-Kontext der Installation
- Status der TYPO3-Kontext-Restriktion
- Angabe zum Composer-Modus
- aktuell verwendete Rector-Version bzw. Hinweis, wenn Rector im aktuellen Setup nicht lauffähig ist
- aktuell verwendete PHP-Version
- Ausführbarkeit der PHP-Funktion "shell_exec"
Die aktuelle Version
Current version | v12.3.0 |
---|---|
published at | 25.06.2024 |
Name | creifenscheid/db-rector |
License | GPL-2.0-or-later |
Requirements |
|
Installation
Composer
Die Extension ist ohne Composer nicht funktionsfähig, da dieser für TYPO3-Rector benötigt wird.
composer req --dev creifenscheid/db-rector
Lauffähigkeiten
Bekannte lauffähige Systeme
In den folgenden System-Umgebungen konnte die Extension erfolgreich getestet werden:
- DDEV mit TYPO3 12.4
- DDEV mit TYPO3 11.5
Bekannte nicht lauffähige Systeme
In den folgenden System-Umgebungen konnte die Extension nicht zum Laufen gebracht werden:
- MAMP PRO 6.6.3 unter macOS Ventura 13.4
Wer sein System den Listen hinzufügen möchte oder wer eine Lösung für eines der nicht lauffähigen System besitzt, kann mich gern anschreiben.
Jedes Feedback ist herzlich willkommen.
Was bisher geschah
Version | Changes |
---|---|
v12.3.0 |
|
v12.2.1 |
|
v12.2.0 |
|
v12.1.0 |
|
v12.0.0 |
|