Ansichtseinstellungen (Component/Settings)

Mithilfe der Ansichtseinstellungen werden in brandbox die Darstellungen der einzelnen Datensatzlisten gesteuert. Diese werden pro Anwender/Tabelle festgelegt und können zwischen Anwendern geteilt werden. Erreichbar sind die Ansichtseinstellungen über den -Button in den Toolbars der einzelnen Datensatzlisten.

Verfügbare Einstellungen

Für jede Datensatzliste (Datenbanktabelle) stehen die folgenden Einstellungen zur Verfügung:

Art der Darstellung einer Datensatzliste (Tabelle, Baum, Karten)
Sortierung der Datensätze in dieser Liste (maximal 3 Sortierkriterien)
Maximale Anzahl von Datensätzen pro Seite
Kollation der Datensätze bei mehrsprachigen Datenbanktabellen

Zusätzlich stehen pro Darstellung spezifische Einstellungen zur Verfügung. Für jede Darstellung werden zudem die zu zeigenden Informationen konfiguirert. Hier wählen Sie in einer erweiterbaren Liste die verfügbaren Informationen aus.

Programmatischer Abruf

Um auf Ansichtseinstellungen zugreifen zu können, wird zunächst das Entity der Datensatzes benötigt. Der Manager von Component/Settings steht hierzu die folgenden Methoden zur Verfügung:

Methode	Beschreibung
`Manager::getSettingsTemporary($identifier)`	Der Parameter `$identifier` enthält den Identifikator des gewünschten Entities für welches die Einstellungen abgerufen werden sollen. Hierbei handelt es sich um die persönlichen Einstellungen des aktuellen Anwenders welcher den Code ausführt. Falls das Entity mit den persönlichen Einstellungen nicht existiert, wird es erstellt.
`Manager::getSettingsStored($id)`	Hiermit wird ein bestimmter Einstellungssatz aus der Datenbank abgerufen. Der Parameter `$id` enthält die ID des Datensatzes mit den gewünschten Einstellungen.

Sobald man über einen Einstellunsdatensatz verfügt kann dieser in einen Provider für die Einstellungen eingesetzt werden oder der Manager-Methode populate() übergeben werden damit ein Doctrine-QueryBuilder entsprechend mit Bedingungen gefüllt wird.

Einstellungsprovider

// Abrufen eines Einstellungsdatensatzes
$entity = $this
    ->staticController(Component\Settings\Manager::class)
    ->getSettingsTemporary('[Identifikator des Entities]')
;

// Erstellen eines Providers
$provider = new Component\Settings\Lib\Struct\Provider($entity);

// Alter Provider aus Base/Settings (deprecated)
$provider = $this
    ->staticController(Base\Settings\Manager::class)
    ->getProvider('[Identifikator des Entities]')
;

Eventübersicht

Klassenname	Beschreibung
`OnPopulateContainerAvailable`	Wird ausgelöst um die verfügbaren Datensatzlistendarstellungen einzusammeln.
`OnPopulateContainerDefault`	Wird ausgelöst um die Standarddarstellung einer Datensatzliste festzulegen, sofern keine durch den Anwender bestimmt wurde.
`OnPopulateOrderAvailable`	Wird ausgelöst um die verfügbaren Sortierspalten für eine Datensatzliste einzusammeln.
`OnPopulateOrderDefault`	Wird ausgelöst um die Standardsortierung für eine Datensatzliste festzulegen.
`OnPopulateTab`	Wird ausgelöst um die Bearbeitungsoberfläche für die Ansichtseinstellungen aufzufüllen. Das Event für die mögliche Datensatzlistendarstellung ausgelöst.