Hallo zusammen, hiermit veröffentliche ich mein Gambio-Modul ReviewModeration. Das Modul ergänzt Gambio um eine Moderations- und Freigabefunktion für Produktbewertungen. Neue Bewertungen können vor ihrer Veröffentlichung geprüft, bearbeitet, freigegeben, abgelehnt, als Spam markiert oder endgültig gelöscht werden. Nicht freigegebene Bewertungen werden dabei nicht nur optisch ausgeblendet. Das Modul nimmt sie vollständig aus den öffentlich ausgewerteten Gambio-Bewertungstabellen und bewahrt die Originaldaten in einer eigenen Quarantäne auf. Dadurch beeinflussen offene, abgelehnte oder als Spam markierte Bewertungen weder die Bewertungsanzahl noch den Sterne-Durchschnitt eines Artikels. Modulinformationen Modul: ReviewModeration / Bewertungsmanager Version: 1.1.0 Getestete Gambio-Versionen: 26.08.0 bis einschließlich 26.11.0 Download: siehe Dateianhang dieses Beitrags Wichtiger Kompatibilitätshinweis: Das Modul wurde bislang ausschließlich mit Gambio-Versionen im genannten Bereich getestet. Für ältere oder zukünftige Gambio-Versionen kann aktuell keine bestätigte Kompatibilität zugesichert werden. Bitte ungetestete Versionen zunächst in einer Test- oder Staging-Umgebung prüfen. Funktionen im Überblick Neue Produktbewertungen vor der Veröffentlichung zurückhalten Eigener Moderationsbereich im Gambio-Admin Status Offen, Freigegeben, Abgelehnt und Spam Bewertungstext vor oder nach der Freigabe bearbeiten Bewertungen freigeben oder bereits veröffentlichte Bewertungen wieder zurückziehen Bewertungen verborgen aufbewahren oder endgültig löschen Optionale E-Mail-Benachrichtigung bei einer neuen Bewertung Benachrichtigungen auf Deutsch oder Englisch Eigene Systemdiagnose für Installation, Kompatibilität und Datenkonsistenz Transaktionsgesichertes Verschieben und Wiederherstellen der Bewertungsdaten Schutz der Admin-Aktionen durch CSRF-Token Was passiert mit bereits vorhandenen Bewertungen? Bereits vor der Installation vorhandene Bewertungen werden nicht verändert, nicht ausgeblendet und nicht erneut zur Freigabe vorgelegt. Sie bleiben weiterhin im Shop sichtbar und werden vom Bewertungsmanager als freigegeben behandelt. Das Modul führt bei der Installation also keine automatische Massenverschiebung bestehender Bewertungen durch. Vorhandene Bewertungen können anschließend trotzdem über den Bewertungsmanager bearbeitet, abgelehnt, als Spam markiert, wieder auf „Offen“ gesetzt oder endgültig gelöscht werden. Wird eine bereits veröffentlichte Bewertung nachträglich abgelehnt, als Spam markiert oder wieder auf „Offen“ gesetzt, sichert das Modul ihre Originaldaten und entfernt sie aus den öffentlichen Gambio-Bewertungstabellen. Sie ist danach nicht mehr im Shop sichtbar und beeinflusst die Bewertung des Artikels nicht mehr. Was passiert bei einer neuen Bewertung? Für den Kunden bleibt das normale Gambio-Bewertungsformular bestehen. Ist die Moderation aktiviert, verarbeitet das Modul eine neue Bewertung anschließend wie folgt: Gambio speichert die Bewertung zunächst wie gewohnt. Das Modul erkennt die neu angelegte Bewertung. Die vollständigen Bewertungsdaten und alle vorhandenen Sprachtexte werden gesichert. Die Bewertung erhält den Status Offen. Sie wird aus den öffentlich ausgewerteten Gambio-Bewertungstabellen entfernt und in die interne Quarantäne verschoben. Sie erscheint noch nicht im Shop und beeinflusst weder Anzahl noch Sterne-Durchschnitt. Falls aktiviert, erhält der Shopbetreiber eine E-Mail mit Artikel, Artikelnummer, Kunde, Sternebewertung, Bewertungstext und einem Link zum Adminbereich. Als Empfänger kann in der Modulkonfiguration eine eigene E-Mail-Adresse eingetragen werden. Bleibt das Feld leer, wird die im Shop hinterlegte Betreiberadresse verwendet. Die E-Mail-Funktion benachrichtigt ausschließlich den Shopbetreiber über eine neue Bewertung. Eine automatische Benachrichtigung des Kunden bei Freigabe oder Ablehnung ist in Version 1.1.0 nicht enthalten. Schlägt lediglich der Versand der Benachrichtigungs-E-Mail fehl, bleibt die Bewertung trotzdem in der Moderation erhalten. Was passiert beim Freigeben? Bei der Aktion Freigeben stellt das Modul die zuvor gesicherten Originaldaten wieder in den nativen Gambio-Bewertungstabellen her. Anschließend: erscheint die Bewertung öffentlich beim Artikel, wird sie von Gambio wieder bei Bewertungsanzahl und Durchschnitt berücksichtigt, wird ihr Moderationsstatus als „Freigegeben“ geführt, kann sie bei Bedarf später erneut zurückgezogen werden. Der Bewertungstext kann vor der Freigabe direkt im Moderationsbereich bearbeitet werden. Bei einer bereits veröffentlichten Bewertung wird eine Textänderung unmittelbar in der normalen Gambio-Bewertung gespeichert. Bedeutung der Moderationsaktionen Freigeben Veröffentlicht die Bewertung im Shop und berücksichtigt sie wieder bei Anzahl und Durchschnitt. Ablehnen Die Bewertung bleibt unsichtbar, wird aber sicher aufbewahrt. Sie kann später erneut geprüft und freigegeben werden. Spam Die Bewertung bleibt verborgen und wird in einer eigenen Spam-Ansicht einsortiert. Auch eine Spam-Bewertung kann später wieder auf „Offen“ gesetzt oder freigegeben werden. Auf Offen setzen Markiert die Bewertung erneut zur Prüfung. War die Bewertung bereits veröffentlicht, wird sie wieder aus dem Shop entfernt und in die Quarantäne verschoben. Text speichern Speichert eine Korrektur oder Bearbeitung des Bewertungstextes, ohne den aktuellen Moderationsstatus zu verändern. Löschen Entfernt die Bewertung endgültig aus den Gambio- und Moderationsdaten. Dieser Vorgang kann nicht rückgängig gemacht werden und muss im Adminbereich bestätigt werden. Moderationsbereich im Admin Nach erfolgreicher Installation steht im Adminmenü der Punkt „Bewertungen freigeben“ zur Verfügung. Der Bewertungsmanager besitzt getrennte Ansichten und Zähler für: Offen Freigegeben Abgelehnt Spam Alle Zu jeder Bewertung werden unter anderem Artikel, Artikelnummer, Sternebewertung, Kundenname, Datum und Bewertungstext angezeigt. Der Text kann direkt in der Moderationsansicht bearbeitet werden. Integrierte Systemdiagnose Das Modul bringt eine eigene, nur lesende Systemdiagnose mit. Die Diagnose verändert keine Bewertungen und kontrolliert unter anderem: Modul-, Gambio-, PHP- und Datenbankversion erforderliche Moduldateien benötigte Datenbanktabellen und Spalten Transaktionsunterstützung der Datenbanktabellen ungültige Moderationsstatus Quarantäne-Bewertungen, die versehentlich noch öffentlich vorhanden sind fehlende Original- beziehungsweise Wiederherstellungsdaten verwaiste Freigabe-Einträge Anzahl offener, abgelehnter und als Spam markierter Bewertungen Zustand der Moderationsdaten vor einer Deinstallation Installation Bitte vor der Installation eine Sicherung der Shopdateien und der Datenbank erstellen. Den Ordner ReviewModeration nach /GXModules/SvenMx/ReviewModeration/ übertragen. Die Gambio-Caches leeren. Im Gambio-Admin anmelden. Das Modul-Center über folgenden manuell eingegebenen Direktlink öffnen: Code: https://dein-shop.de/admin/admin.php?do=ModuleCenter „dein-shop.de“ muss durch die eigene Shopdomain ersetzt werden. Der Direktlink funktioniert nur, wenn bereits eine aktive Anmeldung im Gambio-Adminbereich besteht. Im Modul-Center nach ReviewModeration beziehungsweise Bewertungsmanager suchen. Das Modul installieren. Moderation, E-Mail-Benachrichtigung, Empfängeradresse und Sprache konfigurieren. Danach „Bewertungen freigeben“ öffnen und einmal die Systemdiagnose ausführen. Konfiguration Folgende Einstellungen stehen im Modul-Center zur Verfügung: Moderation neuer Produktbewertungen ein- oder ausschalten E-Mail-Benachrichtigung ein- oder ausschalten eigene Empfängeradresse hinterlegen Deutsch oder Englisch als Sprache der Benachrichtigung auswählen Wird die Moderation deaktiviert, verarbeitet Gambio neue Bewertungen wieder nach dem normalen Shopverhalten und veröffentlicht sie direkt. Bereits in der Quarantäne befindliche Bewertungen werden durch das Abschalten nicht automatisch veröffentlicht. Sie bleiben im Bewertungsmanager erhalten und müssen dort bewusst bearbeitet werden. Hinweis zur Deinstallation Das Modul behandelt noch nicht veröffentlichte Kundendaten bei einer Deinstallation bewusst vorsichtig: Sind ausschließlich freigegebene Moderationseinträge vorhanden, kann die Modultabelle vollständig entfernt werden. Existieren noch offene, abgelehnte oder als Spam markierte Bewertungen, bleiben diese Daten aus Sicherheitsgründen in der Modultabelle erhalten. Bei einer späteren Neuinstallation werden die zurückbehaltenen Quarantänedaten wiederverwendet. Wer das Modul einschließlich aller Moderationsdaten vollständig entfernen möchte, sollte daher zuvor alle zurückgehaltenen Bewertungen entweder freigeben oder endgültig löschen. Technischer Hinweis zum Fehlerverhalten Das Modul ist so aufgebaut, dass der normale Bewertungsvorgang des Kunden bei einem technischen Problem in der nachgelagerten Moderationslogik nicht mit einer Fehlerseite abgebrochen wird. Der aufgetretene Fehler wird protokolliert. In einem solchen Ausnahmefall kann eine Bewertung im normalen Gambio-Bestand veröffentlicht bleiben, wenn sie nicht erfolgreich in die Quarantäne verschoben werden konnte. Nach der Installation sollte deshalb die integrierte Systemdiagnose ausgeführt und das Shop-Log bei Auffälligkeiten kontrolliert werden. Download und Rückmeldungen Die aktuelle Version befindet sich im Dateianhang dieses Beitrags. Aktuelle Version: 1.1.0 Ich freue mich über Rückmeldungen, Testergebnisse, Fehlermeldungen und Verbesserungsvorschläge. Bitte bei einer Fehlermeldung möglichst die verwendete Gambio-, PHP- und Datenbankversion sowie das Ergebnis der integrierten Systemdiagnose angeben.
