Brandbox/Search ist ein zentrales Code-Paket durch das viele verschiedene Suchen verarbeitet werden können. Es wird mit einem rein gereichten Kontext gearbeitet und kann ein gemischtes Set an Ergebnissen zurückliefern. Dabei unterstützt es Suchen durch verschiedene Suchmechanismen wie QueryBuilder, FrameworkDocument-Suche oder auch statische Daten, da die tatsächliche Suche nicht in diesem Paket erfolgt. Dieses Paket ist damit die Infrastruktur für Suchen, bzw. eine einheitliche API.
Events
| Event | Beschreibung |
|---|---|
\Brandbox\Framework\Brandbox\Search\Lib\Event\OnExecuteSearch | Ausführen der Suche. Gibt ein Array aus \Brandbox\Framework\Brandbox\Search\Lib\Struct\GroupAbstract zurück, welches dann weiter verarbeitet werden kann. |
\Brandbox\Framework\Brandbox\Search\Lib\Event\OnPopulateSearch | Wird verwendet, um die Suche (QueryBuilder, FrameworkDocumentContext, o.ä.) mit den Filtern und dem Context zu manipulieren. Das Suchfeld als Filter wird hier zum Beispiel in die jeweilige Form für die Suche gebracht. |
\Brandbox\Framework\Brandbox\Search\Lib\Event\OnPopulateElement | Hiermit wird mit dem Kontext ein Element manipuliert ($target). Als Quelle ($source) kann ElementAbstract, FilterAbstract oder GroupAbstract definiert sein. |
\Brandbox\Framework\Brandbox\Search\Lib\Event\OnPopulateFilters | Das Event kann verwendet werden, um für einen Kontext die relevanten Filter abzufragen, die dann mit \Brandbox\Framework\Brandbox\Search\Manager::getElement zu Styleguide Elemente umgewandelt werden können. |