Download the PHP package ratingstar/shopware-seal without Composer

On this page you can find all versions of the php package ratingstar/shopware-seal. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package shopware-seal

RatingStar für Shopware 6

RatingStar ist das Bewertungstool für Unternehmen: Kundenbewertungen sammeln, Bewertungen aus Google und anderen Portalen bündeln und alles mit Siegeln auf der eigenen Website zeigen. Dieses Plugin bringt die Siegel und Widgets in Ihren Shopware-Shop und gibt die Sterne für Google serverseitig aus.

Funktionen

Voraussetzungen

Installation

Das Plugin gibt es auf zwei Wegen: als ZIP unter Releases oder per Composer als Paket ratingstar/shopware-seal.

Als ZIP

  1. Laden Sie das ZIP in der Administration unter Erweiterungen → Meine Erweiterungen → Erweiterung hochladen hoch.
  2. Installieren und aktivieren Sie RatingStar Siegel & Google-Sterne.
  3. Öffnen Sie über das Menü mit den drei Punkten Konfigurieren.

Auf der Kommandozeile:

Für ein Update laden Sie das neue ZIP genauso hoch und klicken in der Liste der Erweiterungen auf Aktualisieren.

Per Composer

Für Shops, deren Abhängigkeiten Composer verwaltet:

Updates holen Sie mit composer update ratingstar/shopware-seal und bin/console plugin:update RatingStarSeal.

Einrichtung

In der Plugin-Konfiguration tragen Sie ein:

Feld Bedeutung
Filiale (Profil-Slug) Der Teil nach /t/ in der Adresse Ihres RatingStar-Profils, zum Beispiel cafe-sonne.
Gruppe (Gruppen-Slug) Nur für das Siegel einer ganzen Gruppe: der Teil nach /g/ in der Adresse des Gruppenprofils. Ist das Feld gefüllt, zeigen Siegel ohne eigene Angabe die Gruppe statt der Filiale.
API-Key Schlüssel der Filiale oder der Gruppe im Format rs_live_ und 40 Zeichen. Sie finden ihn in RatingStar auf der Seite „Google-Sterne“. Der Shop-Server holt damit die Daten für die Sterne in Google ab.
Adresse des RatingStar-Servers Standard https://ratingstar.de. Nur für eine Test- oder eigene Installation ändern.
Sterne für Google ausgeben Schaltet den Block mit den strukturierten Daten im Seitenkopf ein oder aus.

Verbindung prüfen schlägt Filiale, Gruppe und API-Key am RatingStar-Server nach und nennt den gefundenen Namen. Die Prüfung nutzt die Werte aus dem Formular, auch ungespeicherte, und blockiert nichts: Speichern können Sie unabhängig vom Ergebnis.

Wird der API-Key in RatingStar neu erzeugt, verliert der alte sofort seine Gültigkeit. Tragen Sie dann den neuen hier ein.

Siegel einbinden

Erlebniswelt-Element

Im Layout-Editor der Erlebniswelten finden Sie den Block RatingStar-Siegel in der Kategorie „Commerce“. Das Element lässt sich auch in den Platz eines anderen Blocks tauschen. In den Einstellungen des Elements wählen Sie:

Jede Darstellungsoption steht zunächst auf Standard (Portal). Das Plugin gibt dann nichts vor, und es gilt, was Sie in RatingStar unter „Siegel & Widgets“ eingestellt haben. Erst eine Auswahl im Element überschreibt die Einstellung für genau dieses Siegel. Dieselbe Variante kann so mehrfach mit unterschiedlicher Darstellung im Shop stehen.

Twig-Funktion für Themes

Argument Bedeutung
variant Variante, siehe unten. Ohne Angabe die Banderole.
slug Filiale dieses Siegels. Ohne Angabe gilt die Plugin-Konfiguration.
group Gruppe dieses Siegels. Hat Vorrang vor slug.
position Nur Profil-Karte: inline, bottom-right, bottom-left, top-right, top-left.
overrides Darstellungsoptionen der Variante als Schlüssel-Wert-Paare, siehe unten.
attributes Zusätzliche data-Attribute als Zeichenkette oder als Schlüssel-Wert-Paare. Sie haben Vorrang vor overrides.
mode live (Standard) oder static.
award Nur mit mode='static': Auszeichnung der Filiale im Format Typ, Bindestrich, Stufe.
noRichSnippet true unterdrückt die strukturierten Daten durch das Siegel. Ohne Angabe entscheidet das Plugin selbst.

Die Funktion lässt sich an jeder Stelle eines Storefront-Templates aufrufen, auch im Kopf- und Fußbereich.

Varianten

Schlüssel Name Art
seal-circle Rundsiegel statisches Siegel, jeder Tarif
seal-circle-banner Banderole statisches Siegel, jeder Tarif
profile-card Profil-Karte Live-Widget, an Ort und Stelle oder schwebend
bar Bewertungsleiste Live-Widget
hero Gesamtnote Live-Widget
quote Zitat Live-Widget
carousel Karussell Live-Widget
wall Bewertungswand Live-Widget
footer-bar Fußleiste Live-Widget

Darstellungsoptionen

Die Schlüssel für overrides heißen wie im Code-Generator von RatingStar. Als Attribut wird aus pcColor zum Beispiel data-pc-color. Ja-Nein-Werte schreiben Sie als true und false oder 1 und 0.

Variante Optionen
Rundsiegel, Banderole size (120–320)
Profil-Karte pcWidth (100–215), pcShowCount, pcColor (gold, silber, weiss), pcMobile (compact, hide, full), pcClick (overlay, profile)
Bewertungsleiste barShowCount, barShowVerified, theme
Gesamtnote heroShowCount, heroShowVerified, heroShowBranches (nur Gruppen), theme
Zitat quotePick (best, newest, rotate, manual), quoteWidth (s, m, l, full), reviewsOnlyNamed, reviewsOnlyWithComment, theme
Karussell carCount (3–20), carRotate (0–30), carMin (1–5), carWidth (s, m, l, full), reviewsOnlyNamed, reviewsOnlyWithComment, theme
Bewertungswand wallCols (2–4), wallTotal (2–50), wallMin (1–5), wallSort (newest, best, mix), wallWidth (m, l, xl, full), reviewsOnlyNamed, reviewsOnlyWithComment, theme
Fußleiste footerBarPosition (fixed, inline), footerBarBg, footerBarText, footerBarLinkColor, footerBarLinkHover (Farben als #rrggbb)

theme kennt light und dark. Optionen einer anderen Variante und Werte in falscher Form lässt das Plugin weg; Zahlen außerhalb des Bereichs und unbekannte Werte gleicht RatingStar selbst an.

Das Feld für zusätzliche Attribute nimmt nur Namen an, die mit data- beginnen. Profil, Gruppe, Variante und Position haben eigene Felder und lassen sich dort nicht überschreiben.

Gruppen-Siegel

Alle neun Varianten gibt es auch für eine Gruppe über alle ihre aktiven Filialen. Tragen Sie dazu den Gruppen-Slug ein, in der Plugin-Konfiguration für den ganzen Shop oder am einzelnen Siegel. Ein Siegel zeigt immer entweder eine Filiale oder eine Gruppe; ist beides angegeben, gewinnt die Gruppe.

Für die Sterne für Google gehört dann der API-Key der Gruppe in die Plugin-Konfiguration.

Sterne für Google

Ist ein gültiger API-Key hinterlegt, holt der Shop-Server die strukturierten Daten Ihrer Bewertungen bei RatingStar ab und gibt sie als einen Block im Seitenkopf aus (schema.org). Je Seite gibt es genau einen Block; die Siegel verzichten dann von selbst auf eine eigene Ausgabe.

Eine Gesamtbewertung enthält der Block ab dem 4-Star-Tarif und sobald es Bewertungen gibt. Es zählen dieselben Bewertungen wie in Ihrem Siegel. Ob Google Sterne anzeigt, entscheidet Google.

Steht eine Seite für eine andere Filiale oder Gruppe als der übrige Shop, zum Beispiel eine Standortseite, geben Sie ihr deren Schlüssel mit:

Die Seite erhält dann die Daten dieses Schlüssels statt der des Shops. Es bleibt bei einem Block je Seite.

Statisches Bild

Rundsiegel, Banderole und Profil-Karte gibt es auch als verlinktes Bild ohne JavaScript, zum Beispiel für Seiten, auf denen kein Skript laufen soll. Das Bild kommt fertig vom RatingStar-Server und verlinkt auf Ihr Profil. Für die übrigen Varianten gibt es kein statisches Bild; dort bleibt es beim Live-Widget.

Zwischenspeicher

Domain freigeben

Für die Live-Siegel: Tragen Sie die Domain Ihres Shops in RatingStar unter Siegel & Widgets → Domains & Statistik im Abschnitt „Freigegebene Domains“ ein und bestätigen Sie sie mit dem DNS-Eintrag TXT _ratingstar.ihre-domain.de.

Sobald dort erstmals eine Domain bestätigt ist, liefert RatingStar die Siegel-Daten nur noch an bestätigte Domains. Auf anderen Domains bleibt das Siegel leer. Das bloße Eintragen einer Domain ändert noch nichts; erst die Bestätigung per DNS schaltet den Schutz ein.

Für ein Gruppen-Siegel gilt die eigene Liste im Backend der Gruppe, ebenfalls unter Siegel & Widgets → Domains & Statistik. Die Listen der Filialen gelten nicht für das Gruppen-Siegel und umgekehrt.

Die Sterne für Google holt der Shop-Server mit dem API-Key ab. Das ist von der Freigabe nicht betroffen und in jedem Tarif möglich.

Datenschutz und Einwilligung

Das Plugin trägt nichts in den Cookie-Consent von Shopware ein und macht das Laden der Siegel nicht von einer Einwilligung abhängig. Soll ein Siegel erst nach Einwilligung erscheinen, regeln Sie das über Ihr Consent-Tool oder im Theme.

Die Datenschutzerklärung von RatingStar: https://ratingstar.de/datenschutz

Wie das Plugin seal.js lädt

Jedes Live-Siegel besteht aus dem Element <div class="rs-seal" …> und einem kurzen Skript, das <script src="…/seal.js" async> in die Seite einfügt, sofern es dort noch nicht steht. So wird seal.js je Seite genau einmal geladen, gleich wie viele Siegel sie enthält und auch dann, wenn Shopware Kopf- und Fußbereich getrennt vom Inhalt zwischenspeichert. Ohne Siegel auf der Seite wird nichts von RatingStar geladen.

Für Shops mit eigener Content-Security-Policy: Das eingefügte Skript ist ein Inline-Skript, wie Shopware sie im Storefront selbst verwendet. Der RatingStar-Server muss für Skripte, Stylesheets, Bilder und Abrufe erlaubt sein.

Entwicklung

Das Repository enthält das Plugin mit den gebauten Dateien für die Administration unter src/Resources/public/administration. Nach Änderungen unter src/Resources/app/administration/src bauen Sie sie in einer Shopware-6.7-Installation mit installiertem und aktivem Plugin neu:

Das installierbare ZIP entsteht im Plugin-Verzeichnis:

Das Skript legt dist/RatingStarSeal-<version>.zip an: das Plugin mit den gebauten Dateien, ohne Repository und Entwicklungsdateien.

Die Listen der Varianten und Optionen stehen an zwei Stellen und werden gemeinsam gepflegt: src/Service/VariantRegistry.php für den Storefront und src/Resources/app/administration/src/constant/rs-seal.constant.js für die Administration.

Hilfe

Fragen und Rückmeldungen: https://ratingstar.de/support

Lizenz

GNU General Public License, Version 2 oder später (GPL-2.0-or-later), siehe LICENSE.


All versions of shopware-seal with dependencies

PHP Build Version
Package Version
Requires shopware/core Version ~6.7.0
shopware/storefront Version ~6.7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ratingstar/shopware-seal contains the following files

Loading the files please wait ...