Download the PHP package ratingstar/contao-seal-bundle without Composer

On this page you can find all versions of the php package ratingstar/contao-seal-bundle. 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 contao-seal-bundle

RatingStar für Contao

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 Bundle bringt die Siegel und Widgets von RatingStar in Ihre Contao-Website und liefert Google die Daten für die Sterne in der Suche.

Installation: über den Contao Manager (Suche nach „RatingStar“) oder composer require ratingstar/contao-seal-bundle.

Funktionen

Voraussetzungen

Installation

Contao Manager: nach ratingstar/contao-seal-bundle suchen, hinzufügen und die Änderungen anwenden. Der Manager aktualisiert anschließend die Datenbank.

Composer:

Einrichtung

  1. Im Backend unter Seitenstruktur die Root-Seite Ihrer Website bearbeiten und den Abschnitt RatingStar öffnen.
  2. Profil-Slug der Filiale eintragen: der Teil hinter /t/ in der Adresse Ihres RatingStar-Profils (bei https://ratingstar.de/t/muster-gmbh also muster-gmbh).
  3. Für die Google-Sterne zusätzlich den API-Key eintragen und Google-Sterne ausgeben (JSON-LD) ankreuzen. Den Key finden Sie im RatingStar-Konto auf der Seite „Google-Sterne“; er beginnt mit rs_live_.
  4. Speichern. Contao prüft den Slug gegen Ihr Profil und zeigt den gefundenen Profilnamen an. Findet es kein Profil, erscheint ein Hinweis; gespeichert wird in jedem Fall, damit Sie einen Tippfehler in Ruhe korrigieren können.
  5. Die Domain der Website bei RatingStar freigeben (nächster Abschnitt).
  6. Auf einer Seite ein Inhaltselement RatingStar-Siegel anlegen (Rubrik „Include-Elemente“) und die Variante wählen.
Feld an der Root-Seite Bedeutung
Profil-Slug der Filiale Wessen Bewertungen die Siegel der Website zeigen.
Gruppe (Slug) Nur für das Siegel einer ganzen Gruppe, siehe „Siegel einer Gruppe“.
API-Key rs_live_ und 40 Zeichen. Wird für die Google-Sterne gebraucht und bleibt gültig, wenn sich der Slug ändert.
Google-Sterne ausgeben (JSON-LD) Schreibt die strukturierten Daten in den Kopf jeder Seite.
RatingStar-Adresse Leer lassen. Nur nötig, wenn Sie eine eigene RatingStar-Instanz nutzen.

Domain freigeben

RatingStar liefert die Daten für Siegel und Widgets nur an Websites, die Sie freigegeben haben:

  1. Im RatingStar-Konto Siegel & Widgets → Domains & Statistik öffnen.
  2. Unter „Freigegebene Domains“ die Domain Ihrer Website eintragen.
  3. Den angezeigten DNS-Eintrag (TXT _ratingstar.<ihre-domain>) bei Ihrem Domain-Anbieter setzen und die Domain bestätigen.

Der Schutz greift, sobald die erste Domain bestätigt ist. Ab dann erhalten nur noch bestätigte Domains die Siegel-Daten; auf allen anderen bleibt das Siegel leer (die Abfrage wird mit HTTP 403 abgelehnt). Das bloße Eintragen einer Domain schaltet noch nichts ab. Tragen Sie deshalb auch Test- und Staging-Domains ein, auf denen das Siegel erscheinen soll.

Zeigen Sie das Siegel einer Gruppe, pflegen Sie die Domains im Gruppen-Backend an derselben Stelle. Die Freigaben der Filialen gelten nicht für das Gruppen-Siegel und umgekehrt.

Die Google-Sterne sind davon unabhängig: Sie laufen über den API-Key und funktionieren auch ohne freigegebene Domain.

Das Inhaltselement

Varianten

Variante Zeigt Tarif
Rundsiegel rundes Siegel mit Note alle
Banderole Siegel mit Banderole alle
Profil-Karte Karte mit Note und Anzahl, im Inhalt oder schwebend in einer Bildschirmecke ab 4-Star
Bewertungsleiste schmale Leiste mit Sternen und Note ab 4-Star
Gesamtnote große Note mit Sternen ab 4-Star
Zitat eine einzelne Bewertung ab 4-Star
Karussell wechselnde Bewertungen ab 4-Star
Bewertungswand mehrere Bewertungen in Spalten ab 4-Star
Fußleiste Leiste am unteren Bildschirmrand oder im Seitenverlauf ab 4-Star

In einem kleineren Tarif erscheint anstelle einer Variante „ab 4-Star“ automatisch die Banderole. Das entscheidet RatingStar bei jedem Aufruf; nach einem Tarifwechsel müssen Sie in Contao nichts ändern.

Optionen

Nach der Wahl der Variante blendet Contao die passenden Optionen ein, zum Beispiel Größe, Kartenfarbe, Anzahl der Bewertungen, Spalten oder Farbschema. Jede Option steht zunächst auf Standard (Portal): Dann gilt die Einstellung aus Ihrem RatingStar-Konto, und eine spätere Änderung dort wirkt sofort auf der Website. Nur was Sie am Element ausdrücklich wählen, überschreibt das Portal für dieses eine Element. So können Sie dieselbe Variante mehrfach mit unterschiedlichem Aussehen einsetzen.

Die Position der Profil-Karte legt fest, ob sie im Inhalt steht oder schwebend in einer der vier Bildschirmecken.

Andere Filiale oder Gruppe

Ohne weitere Angabe zeigt das Element die Filiale oder Gruppe der Root-Seite. Mit Andere Filiale (Profil-Slug) oder Gruppe (Slug) zeigt ein einzelnes Element etwas anderes, etwa das Siegel eines Partners. Auch diese Angaben prüft Contao beim Speichern, ohne das Speichern zu verhindern.

Als statisches Bild ausgeben

Für Rundsiegel, Banderole und Profil-Karte gibt es das Siegel auch als Bild ohne JavaScript, verlinkt auf Ihr Profil. Das eignet sich für Druck- oder Newsletter-Fassungen einer Seite. Das Bild zeigt den aktuellen Stand Ihrer Bewertungen; von den Optionen wirkt hier nur die Größe oder Breite. Für die übrigen Varianten gibt es kein statisches Motiv, deshalb fehlt dort das Ankreuzfeld.

Zusätzliche data-Attribute

Für Fachleute: Im RatingStar-Konto erzeugt der Code-Generator unter „Siegel & Widgets“ für jede Einstellung ein Attribut, zum Beispiel data-size="240" data-pc-color="weiss". Diese Attribute können Sie in das Feld Zusätzliche data-Attribute kopieren. Sie überschreiben gleichnamige Optionen des Elements. Angenommen werden nur data-Attribute; Slug, Gruppe, Variante und Position stellen Sie über die eigenen Felder ein.

Google-Sterne (JSON-LD)

Ist Google-Sterne ausgeben (JSON-LD) angekreuzt und ein API-Key eingetragen, schreibt das Bundle in den Kopf jeder Seite der Website genau einen Block mit strukturierten Daten (schema.org). Google kann daraus die Sterne neben Ihrem Suchergebnis bilden. Ob und wann Google Sterne anzeigt, entscheidet allein Google.

Siegel einer Gruppe

Mehrere Filialen lassen sich bei RatingStar zu einer Gruppe zusammenfassen. Deren Siegel zählt die Bewertungen aller aktiven Filialen.

Ist eine Gruppe gesetzt, hat sie Vorrang vor dem Profil-Slug. In der Variante Gesamtnote steht unter der Gesamtnote die Note jeder Filiale; die Option Note je Filiale zeigen blendet das aus.

Für die Google-Sterne gilt: je Seite ein Block. Auf der Website einer Gruppe trägt er die Daten der Gruppe, auf der Website einer einzelnen Filiale die der Filiale.

Für Theme-Entwickler: Twig-Funktion

In Layouts und anderen Twig-Templates bindet ratingstar_seal() ein Siegel ein, mit denselben Möglichkeiten wie das Inhaltselement:

Angabe Bedeutung
erster Parameter Variante: seal-circle, seal-circle-banner, profile-card, bar, hero, quote, carousel, wall, footer-bar
slug, group andere Filiale oder Gruppe als an der Root-Seite
position nur Profil-Karte: inline, bottom-right, bottom-left, top-right, top-left
static true gibt ein Bild ohne JavaScript aus (Rundsiegel, Banderole, Profil-Karte)
options Optionen mit ihrem Namen aus dem Code-Generator, zum Beispiel {carCount: 4, theme: 'dark'}
attributes zusätzliche data-Attribute als Text oder als Liste {'data-size': 240}

Das Skript seal.js wird je Seite nur einmal geladen, gleichgültig wie viele Siegel sie zeigt. Das Template des Inhaltselements heißt content_element/ratingstar_seal und lässt sich wie jedes Contao-Template überschreiben.

Caching und Cache leeren

Was Wo Dauer
Daten für die Google-Sterne auf Ihrem Server 6 Stunden, nach einem Fehler 15 Minuten
Daten der Siegel und Widgets im Browser der Besucher etwa 1 Minute

Den Zwischenspeicher für die Google-Sterne leeren Sie so:

Auch das Erneuern des Anwendungs-Caches (cache:clear auf der Konsole oder über den Contao Manager) entfernt die Daten. Nutzen Sie den Seitencache von Contao, enthalten bereits zwischengespeicherte Seiten den alten Stand, bis auch dieser Cache abläuft oder geleert wird.

Nimmt der Zwischenspeicher keine Einträge an (Ordner var/cache ohne Schreibrecht, Redis nicht erreichbar oder schreibgeschützt), gibt das Bundle keine Google-Sterne aus und fragt RatingStar nicht ab. Im Log (var/logs) steht dann ein Fehler, der mit „RatingStar: the cache pool“ beginnt.

Content Security Policy

Haben Sie an der Root-Seite die Content Security Policy von Contao eingeschaltet, meldet das Bundle die RatingStar-Adresse selbst als erlaubte Quelle für Skripte, Stile, Datenabrufe und Bilder an, und das Skript erhält die Nonce der Seite. Sie müssen dafür nichts eintragen.

Die Widgets legen einzelne Maße und Farben als Inline-Stil fest. Eine Richtlinie, die Inline-Stile verbietet (etwa nur default-src 'self'), blockiert diese Angaben: Die Widgets erscheinen und zeigen ihre Daten, Abstände, Breiten und Farben können aber vom Portal abweichen. Soll alles wie im Portal aussehen, erlauben Sie Inline-Stile in der Richtlinie der Root-Seite: style-src 'self' 'unsafe-inline'.

Setzen Sie die Richtlinie an anderer Stelle, etwa im Webserver, tragen Sie die RatingStar-Adresse dort für script-src, style-src, connect-src und img-src ein.

Datenschutz

Siegel und Widgets laden beim Seitenaufruf ein Skript, eine Stildatei, die Bewertungsdaten und ein Zählpixel von RatingStar (ratingstar.de). Der Browser Ihrer Besucher baut dabei eine Verbindung zu RatingStar auf und überträgt wie bei jedem Abruf seine IP-Adresse und die Adresse der aufrufenden Seite. Das Zählpixel zählt, wie oft ein Siegel angezeigt und angeklickt wurde.

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

Eigene RatingStar-Instanz

Alle Adressen bildet das Bundle aus einer einzigen Einstellung. Für eine Test- oder eigene Instanz ändern Sie sie für alle Websites in config/config.yaml:

oder für eine einzelne Website im Feld RatingStar-Adresse der Root-Seite. Einzutragen ist die Adresse ohne Pfad.

Wenn etwas nicht erscheint

Entwicklung

Der Code des Bundles liegt in src/, die Contao-Dateien (DCA, Sprachdateien, Templates) in contao/. Die Optionen des Inhaltselements entstehen aus src/Seal/SealOptions.php, dem Abbild der von seal.js unterstützten Einstellungen.

Lizenz

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


All versions of contao-seal-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
contao/core-bundle Version ^5.3
psr/cache Version ^3.0
psr/log Version ^1.1 || ^2.0 || ^3.0
symfony/cache-contracts Version ^3.0
symfony/config Version ^6.4 || ^7.0
symfony/dependency-injection Version ^6.4 || ^7.0
symfony/event-dispatcher Version ^6.4 || ^7.0
symfony/http-client-contracts Version ^3.1
symfony/http-foundation Version ^6.4 || ^7.0
symfony/http-kernel Version ^6.4 || ^7.0
symfony/translation-contracts Version ^3.0
twig/twig Version ^3.8
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/contao-seal-bundle contains the following files

Loading the files please wait ...