c4y/reviews

Contao Bundle für Kundenbewertungen

Maintainers

Details

github.com/c4y/reviews

Source

Issues

Installs: 16

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 1

Forks: 0

Type:contao-bundle

0.0.1 2019-09-01 16:04 UTC

README

Mit dieser Contao Erweiterung können Kundenbewertungen mit einer Sterne-Bewertung und einem Text eingeholt werden. Diese Bewertungen werden mit einem Badge dargestellt. Das Badge wird typischerweise auf der Seite an einer fixen Stelle angezeigt mit einem Logo, der durchschnittlichen Sterne-Bewertung und der Anzahl der Kundenbewertungen. Mit Klick auf das Badge wird eine Liste mit x Bewertungen (einstellbar) angezeigt sowie einem Link zur Seite mit allen Bewertungen.

Das Badge kann weggeklickt werden. Das wird als Session-Cookie gespeichert. Sobald der Browser geschlossen und neu geöffnet wird, erscheint das Badge erneut.

Um eine Bewertung abgeben zu können, muss der "Kunde" eingeladen werden. Hierbei wird ein Token generiert, womit der Kunde eine einmalige Bewertung abgeben kann. Die Einladung kann mit dem Formular verschickt werden oder automatisiert per ReviewsService->sendLink(...) oder per API. Siehe hierzu weiter unten.

Die Bewertungen werden je Kategorie erfasst. In einer Multi-Domain Installation können dies z.B. verschiedene Webseiten sein - so dass für jede Webseite (Seitenbaum) verschiedene Bewertungen erfasst werden können.

Die Bewertungen müssen nach erfolgreicher Abgabe erst vom Admin aktiviert werden und können hier auch (im Backend) kommentiert werden.

Installieren

  1. Im Contao-Manager nach c4y/reviews suchen und installieren:
  2. oder auf der Konsole composer require c4y/reviews

Einrichtung

  1. Im Notification Center einen Gateway einrichten (falls noch nicht vorhanden)
  2. Im Notification Center eine Benachrichtung anlegen vom Typ "Benachrichtigungslink"
  3. Eine Sprache anlegen und
    • als Empfänger ##recipient_email## eintragen
    • im Text irgendwo ##link## eintragen
  4. Die folgenden Seiten erstellen
    • Bewertung - Einladung verschicken
    • Bewertung - Badge
    • Bewertung - Formular
    • Bewertung - Liste
    • Bewertung - ungültiger Token
    • Bewertung - Erfolgreich
  5. Eine "Kategorie" unter Inhalte / Bewertungen anlegen
    • die Seite "Bewertung - Formular" auswählen
    • die Benachrichtigung auswählen
  6. Die folgenden Module erstellen
    • Bewertungs-Badge (Weiterleitung zur Seite "Bewertung-Liste", Auswahl der Logos, Angabe, wieviele Bewertungen in der Liste erscheinen, die mit Klick auf das Badge eingeblendet werden)
    • Bewertungs-Formular (Weiterleitung zu den angegebenen Seiten bei einem fehlerhaften/abgelaufenen Token bzw. nach erfolgreicher Abgabe einer Bewertung)
    • Bewertungs-Link verschicken (Angabe der angelegten Kategorie)
    • Bewertungs-Liste (Auswahl der Kategorie, Angabe wieviele Elemente pro Seite angezeigt werden sollen)
  7. Einbau der Module auf den zuvor angelegten Seiten
  8. Einbau des Badge-Moduls im Seitenlayout (am Besten in den Footer)
  9. Aktivierung des CSS im Seitenlayout (bei Bedarf bzw. zum Testen)

Senden per Service

  1. Hinzufügen des ReviewService per DI
  2. Senden einer Einladung per ReviewService->sendLink($user, $email, $kategorie)
    • der User ist im Klartext derjenige, der bei der Bewertung angezeigt wird

Senden per API

POST Request als JSON. Der API Token muss bei den Bewertungen in der jeweiligen Kategorie angelegt werden.

POST /api/reviews/sendlink
{
	"user": "API User",
	"email": "test@test.de",
	"category": 1,
	"apiToken": "ac43a85f-167c-41db-aa7b-7edb51d6a55b"
}