Topdata Topdata Docs

TopdataCategoryFilterSW6

Topdata Category Filter SW6 Benutzerhandbuch

Überblick

Das Topdata Category Filter SW6 Plugin erweitert die Filterfunktionen von Shopware, indem es einen leistungsfähigen Kategoriefilter hinzufügt. Dieser Filter ermöglicht es den Kunden, sich einfach durch die Produktkategorien zu navigieren, verbessert ihr Einkaufserlebnis und erhöht die Wahrscheinlichkeit, relevante Produkte zu finden.

Hauptmerkmale

  • Fortschrittliche Kategorienfilterung mit mehrstufiger Unterstützung
  • Anpassbare Filtererscheinung und -verhalten
  • Leistungsoptimierungsoptionen
  • Integration mit Elasticsearch für schnelle Suchen
  • Umfassende Konfigurationseinstellungen

Einstieg

Um mit dem Topdata Category Filter SW6 Plugin zu beginnen:

  1. Folgen Sie dem Installationshandbuch, um das Plugin zu installieren und zu aktivieren
  2. Passen Sie die Plugin-Einstellungen nach den Bedürfnissen Ihres Shops an, indem Sie den Einstellungsleitfaden verwenden
  3. Beziehen Sie sich auf die FAQ & Fehlerbehebung für häufige Probleme und Lösungen

Support

Für zusätzlichen Support wenden Sie sich bitte an unser technisches Support-Team oder besuchen Sie unseren Support-Portal.

Versionshinweise

Version 1.0.0 (Juni 2024)

  • Erstveröffentlichung mit grundlegender Kategorienfilterfunktion
  • Integration mit Shopware 6.4
  • Elasticsearch-Unterstützung für schnelle Kategoriesuchen

Version 1.1.0 (September 2024)

  • Hinzugefügte Leistungsoptimierungseinstellungen
  • Verbesserte UI/UX mit ausklappbaren Unterkategorien
  • Erweiterte Konfigurationsoptionen

Version 1.2.0 (Dezember 2024)

  • Unterstützung für dynamische Produktgruppen
  • Bessere Verwaltung verborgener Kategorien
  • Verschiedene Fehlerbehebungen und Stabilitätsverbesserungen

Roadmap

  • Verbesserte Integration mit anderen Shopware-Plugins
  • Zusätzliche Anpassungsoptionen für die Filter-Benutzeroberfläche
  • Erweiterte Analyse- und Berichtsmerkmale

Topdata Category Filter SW6 Installationshandbuch

Systemanforderungen

  • Shopware 6.5.x oder höher
  • PHP 8.0 oder höher
  • Composer auf Ihrem Server installiert

Installationsschritte

1. Installation über Composer

Öffnen Sie Ihr Terminal und navigieren Sie zu Ihrem Shopware-Projektverzeichnis. Führen Sie den folgenden Befehl aus, um das Plugin zu installieren:

composer require topdata/topdata-category-filter-sw6

2. Aktivieren des Plugins

Nach Abschluss der Installation müssen Sie das Plugin aktivieren. Dies können Sie über das Shopware-Admin-Panel oder die Befehlszeile tun.

Option A: Über das Shopware-Admin-Panel

  1. Melden Sie sich bei Ihrem Shopware-Admin-Panel an
  2. Gehen Sie zu Erweiterungen > Meine Erweiterungen
  3. Finden Sie “Topdata Category Filter SW6” in der Liste
  4. Klicken Sie auf Aktivieren

Option B: Über die Befehlszeile

Führen Sie den folgenden Befehl in Ihrem Shopware-Projektverzeichnis aus:

bin/console plugin:install --activate TopdataCategoryFilterSW6

3. Cache leeren

Nach der Aktivierung des Plugins wird empfohlen, den Cache zu leeren, um sicherzustellen, dass alle Änderungen wirksam werden:

bin/console cache:clear

Verifikation

Um zu überprüfen, ob das Plugin korrekt installiert und aktiviert wurde:

  1. Gehen Sie zur Produktlisten-Seite in Ihrem Storefront
  2. Sie sollten den Kategoriefilter im Filterpanel sehen
  3. Testen Sie die Filterfunktion, indem Sie verschiedene Kategorien auswählen

Fehlerbehebung

Wenn Sie während der Installation auf Probleme stoßen:

  • Überprüfen Sie die Shopware-Fehlerprotokolle auf detaillierte Fehlermeldungen
  • Stellen Sie sicher, dass Ihr Server alle Systemanforderungen erfüllt
  • Überprüfen Sie, ob Composer die notwendigen Berechtigungen zum Installieren von Plugins hat

Topdata Category Filter SW6 Einstellungsleitfaden

Dieser Leitfaden bietet detaillierte Informationen zu allen Konfigurationsoptionen, die im Topdata Category Filter SW6 Plugin verfügbar sind.

Allgemein

EinstellungStandardBeschreibung
filterPositionbeginningPosition des Kategoriefilters im Panel: beginning, afterManufacturer, end oder hidden. afterManufacturer entspricht dem bisherigen “Als erster Filter anzeigen = aus”. hidden entfernt den Filter vollständig: keine Anzeige, keine Filterung, keine Produkt-Aggregation.
initialFilterStatecollapsedLegt fest, ob der Kategoriefilter-Akkordeon beim Laden der Seite zunächst ein- oder ausgeklappt sein soll. Andere Listing-Filter werden nicht beeinflusst.
sortnoneLegt die Sortierreihenfolge der Kategorien fest (Name, Anzahl oder Standard).

Kategoriebaum

EinstellungStandardBeschreibung
collapseSubcategoriestrueZeigt an Kategorien mit Unterkategorien einen Pfeil zum Ein-/Ausklappen. Wenn deaktiviert, wird der Baum flach ohne Pfeile dargestellt; wie viele Ebenen sichtbar sind, steuert subcategoryInitialExpandDepth.
subcategoryMaxDepthallMaximale Tiefe des Baums, wenn Ein-/Ausklappen aktiviert ist: 1, 2, 3 oder all. Tiefere Ebenen werden weder angezeigt noch können sie aufgeklappt werden. Ohne Pfeile wird diese Einstellung ignoriert.
subcategoryInitialExpandDepthcollapsedMit Pfeilen: Anzahl der beim Laden ausgeklappten Ebenen (collapsed, 1, 2, 3, all), begrenzt durch subcategoryMaxDepth. Ohne Pfeile: Anzahl der sichtbaren Ebenen im flachen Baum.
showNumbertrueZeigt die Anzahl der Produkte in jeder Kategorie an.
manyMainCategoriestrueBehandelt Fälle, in denen es nur eine Hauptkategorie gibt, indem sie in Unterkategorien aufgeteilt wird.
joinParentsfalseKombiniert übergeordnete Kategorien in der Anzeige. Kategorienamen werden durch ”/” getrennt.
showParentCategory0Gibt an, wie viele Ebenen übergeordneter Kategorien angezeigt werden sollen (0 bis 20 oder “Alle”).
hideParentsfalseBlendet übergeordnete Kategorien im Filter aus.

Sichtbarkeit

EinstellungStandardBeschreibung
hideOtherBranchestrueBlendet Kategorien aus anderen Kategoriezweigen auf Kategorieseiten aus. Muss deaktiviert werden, wenn der Filter mit dynamischen Produktgruppen verwendet wird.
excludeHiddenfalseBlendet Kategorien aus, die als “In Navigation ausblenden” markiert sind.
hideSingleCategorytrueBlendet den Filter aus, wenn nur eine Kategorie verfügbar ist.
hideDynamicCategorytrueBlendet Kategorien mit dynamischen Produktgruppen aus.
popularCount0Zeigt nur die beliebtesten Endkategorien an. Setzen Sie auf 0, um alle anzuzeigen.

Empfohlene Konfigurationen

  • Für Geschäfte mit einer tiefen Kategorienstruktur begrenzen Sie subcategoryMaxDepth auf 2 oder 3 Ebenen.
  • Für einen flachen, vollständig ausgeklappten Baum ohne Pfeile: collapseSubcategories deaktivieren und subcategoryInitialExpandDepth auf all setzen.
  • Wenn Sie nur eine Hauptkategorie haben, aktivieren Sie manyMainCategories für eine bessere Visualisierung.
  • Für Geschäfte mit dynamischen Produktgruppen deaktivieren Sie hideOtherBranches und hideDynamicCategory.

Visuelle Beispiele

Standardansicht

Standard Kategoriefilter

Eingeklappte Unterkategorien

Eingeklappter Filter

Kombinierte Elternkategorien

Vereinigte Eltern

Topdata Category Filter SW6 FAQ & Fehlerbehebung

Häufige Probleme

SymptomWahrscheinliche UrsacheLösung
Fehlende KategorienAusgeblendete KategorienÜberprüfen Sie die Einstellung excludeHidden in der Plugin-Konfiguration.
Langsame FilterladezeitKomplexe BaumverarbeitungBegrenzen Sie subcategoryMaxDepth oder nutzen Sie popularCount, um die Anzahl angezeigter Kategorien zu reduzieren.
Dynamische Kategorien fehlenMapping-ProblemStellen Sie sicher, dass die Eigenschaft streamCategories korrekt in Ihrem Elasticsearch-Index konfiguriert ist.
URL-Parameter funktionieren nichtVerarbeitung von AnforderungsparameternÜberprüfen Sie die Methode _getCategoryIdsFromRequest in der Subscriber-Klasse.
Unterkategorien nach Update immer eingeklapptAlte subcategoryInitialState-Einstellung entferntWählen Sie die gewünschte Tiefe in der Einstellung subcategoryInitialExpandDepth erneut.
Pfeile zum Ein-/Ausklappen fehlenPlugin-Version < 3.3.0 oder Theme färbt Icons weißAuf Version 3.3.0 oder neuer aktualisieren und Theme neu kompilieren.
Einstellung “Ausklapptiefe” nicht gefundensubcategoryExpandDepth in subcategoryInitialExpandDepth umbenannt (3.3.0)Der gespeicherte Wert wird automatisch übernommen; Feld im Bereich “Kategoriebaum” prüfen.
Kategoriefilter nach Update nicht sichtbarfilterPosition wurde auf hidden übernommen (bisher showCategoryFilter = aus)Wählen Sie eine andere Position als “Nicht anzeigen” in der Plugin-Konfiguration.

Fehlerbehebungsleitfaden

1. Fehlende Kategorien im Filter

Wenn Sie feststellen, dass einige Kategorien im Filter nicht angezeigt werden:

  1. Überprüfen Sie, ob die Einstellung excludeHidden aktiviert ist, die Kategorien ausblendet, die als “In Navigation ausblenden” markiert sind.
  2. Stellen Sie sicher, dass den Kategorien Produkte zugewiesen sind.
  3. Überprüfen Sie, ob der Elasticsearch-Index mit den neuesten Kategoriedaten aktualisiert ist.

2. Langsame Filterleistung

Wenn der Kategoriefilter langsam lädt:

  1. Aktivieren Sie die Einstellung hideUnpopular, um Kategorien mit geringer Produktanzahl zu entfernen.
  2. Erhöhen Sie ggf. den popularCount-Schwellenwert, um nur die beliebtesten Kategorien anzuzeigen.
  3. Aktivieren Sie das Caching für die Kategorienbaumdaten.

3. Dynamische Kategorien werden nicht angezeigt

Wenn dynamische Produktgruppen im Filter nicht angezeigt werden:

  1. Stellen Sie sicher, dass die Einstellung hideDynamicCategory deaktiviert ist.
  2. Überprüfen Sie, ob die Elasticsearch-Mapping die Eigenschaft streamCategories enthält.
  3. Stellen Sie sicher, dass Produkte korrekt dynamischen Kategorien zugewiesen sind.

4. URL-Parameter funktionieren nicht

Wenn Kategorienauswahlen in der URL nicht gespeichert werden:

  1. Überprüfen Sie die Methode _getCategoryIdsFromRequest in der Subscriber-Klasse.
  2. Stellen Sie sicher, dass der Filtername (tdxcats) korrekt in den Plugin-Einstellungen konfiguriert ist.
  3. Überprüfen Sie, ob JavaScript-Fehler die Filteraktualisierung der URL verhindern.

Best Practices

Kategorienverwaltung

  • Überprüfen und aktualisieren Sie regelmäßig Ihre Kategorienstruktur, um sicherzustellen, dass sie optimiert bleibt.
  • Verwenden Sie beschreibende Kategoriennamen, um den Kunden die Produktgruppen zu erläutern.
  • Berücksichtigen Sie die Tiefe Ihres Kategorienbaums und aktivieren Sie Einstellungen wie hideUnpopular für eine bessere Leistung.

Leistungsoptimierung

  • Aktivieren Sie das Caching für den Kategorienbaum, um die Verarbeitungszeit zu reduzieren.
  • Verwenden Sie die Einstellung popularCount, um die Anzahl der angezeigten Kategorien zu begrenzen.
  • Überlegen Sie, Kategorien-ID-Abfragen in Ihren Elasticsearch-Abfragen zu bündeln.

Konfigurationstipps

  • Für Geschäfte mit einer komplexen Kategorienstruktur aktivieren Sie joinParents, um die Anzeige zu vereinfachen.
  • Verwenden Sie die Einstellung showParentCategory, um zu steuern, wie viele Elternstufen in Kategorienamen angezeigt werden.
  • Überprüfen und aktualisieren Sie regelmäßig Ihre Konfigurationseinstellungen, um den Bedürfnissen Ihres Geschäfts gerecht zu werden.

Warum sind die Hersteller- / Preis- / Eigenschafts-Filter ausgegraut, wenn ich eine Kategorie auswähle?

Dies tritt nur auf, wenn die Shop-Einstellung “Filteroptionen ohne Ergebnisse deaktivieren” (core.listing.disableEmptyFilterOptions) aktiviert ist. Der Storefront fordert Shopware dann auf, die verfügbaren Optionen jedes Filters neu zu berechnen, wobei die anderen aktiven Filter ausgeschlossen werden (reduce-aggregations). Da der Kategorie-Filter aus dem gesamten Kategoriebaum (product.categoriesRo.id) auswählt, reduzierte das Auswählen einer übergeordneten Kategorie, die noch alle aktuellen Produkte enthält, die anderen Filter früher auf null Optionen, sodass sie deaktiviert wurden.

Das Plugin kennzeichnet seinen Kategorie-Filter (tdxcats) nun als transparent für diese Neuberechnung: Er wird nie aus den Aggregationen der anderen Filter ausgeschlossen. Dadurch bleiben die Hersteller- / Preis- / Eigenschafts-Filter bei der Auswahl einer Kategorie aktiv und nutzbar, und die Kombination (Kategorie ∩ Hersteller, …) funktioniert korrekt. Ein Filter wird weiterhin nur dann ausgegraut, wenn eine ausgewählte Kategorie tatsächlich keine passenden Produkte liefert.

Warum sind nach dem Update alle Unterkategorien wieder eingeklappt?

Die frühere Einstellung subcategoryInitialState (eingeklappt/ausgeklappt) wurde durch die Ausklapptiefe (heute subcategoryInitialExpandDepth: collapsed / 1 / 2 / 3 / all) ersetzt. Es gibt keine automatische Übernahme des alten Wertes: Shops, die zuvor “ausgeklappt” gewählt hatten, fallen auf den Standard collapsed zurück. Wählen Sie einfach in den Plugin-Einstellungen die gewünschte Ausklapptiefe neu — für das frühere Verhalten “alles ausgeklappt” ist das die Option all.

Warum heißt die Einstellung jetzt subcategoryInitialExpandDepth?

Mit Version 3.3.0 wurde die Ausklapptiefe auf zwei Einstellungen aufgeteilt: subcategoryInitialExpandDepth (beim Laden ausgeklappt) und subcategoryMaxDepth (maximal erreichbare Tiefe mit Pfeilen). Der gespeicherte Wert der alten Einstellung subcategoryExpandDepth wird beim Update automatisch auf subcategoryInitialExpandDepth übernommen.

Wie bekomme ich einen flachen, vollständig ausgeklappten Kategoriebaum ohne Pfeile?

Deaktivieren Sie “Unterkategorien ein-/ausklappbar (Pfeilsymbole)” und setzen Sie die “Anfängliche Ausklapptiefe der Unterkategorien” auf Alle. Die maximale Tiefe wird ohne Pfeile ignoriert. Mit einer anderen Tiefe (z. B. 2) zeigen Sie nur entsprechend viele Ebenen an, ohne dass Kunden tiefer aufklappen können.