settingsHelper

Der settings-Helper ist ein Wrapper um das Settings-Objekt, welcher Zugriffe auf das Objekt bearbeitet und zusätzlich Caching implementiert. Neue Einstellungen sollen über Migrationen erstellt werden, deswegen gibt es keine Funktionalitäten zum Erstellen oder Löschen von Einstellungen.

Verwendung im Code

Der settingsHelper kann über das $app-Objekt in der ganzen Applikation verwendet werden. Der Zugriff erfolgt via Yii::$app->settings.

Methoden

getSetting(string $key, string $module = "core")

Gibt den Wert der Einstellung zurück. Hierbei ist $key der Key der Einstellung, und $module das Modul, zu welchem die Einstellung gehört. Das Ergebnis dieser Methode wird gecached.

saveSetting(string $value, string $key, string $module = "core", string $type = "string")

Speichert den neuen Wert einer Einstellung. Hierbei ist $key der Key-Wert einer Einstellung, $value der neue Wert einer Einstellung,$module das Yii-Modul, zu welchem die Einstellung gehört und $type der Datentyp der Einstellung. Sollte der Wert einer Einstellung gecached sein, wird der Cache nach erfolgreicher Speicherung gelöscht.

saveMultipleSettings(Settings[] $settings)

Kann gleich mehrere Settings auf einmal speichern. $settings ist hierbei ein Array an Settings-Objekten, welche gespeichert werden solle

getAllSettings(bool $ignoreCache = true)

Gibt ein Array mit allen existierenden Settings zurück. Holt diese aktuell nur aus der Datenbank. $ignoreCache ist dabei, um später entscheiden zu können, ob man direkt von der Datenbank oder aus dem Cache zurückbekommen möchte.

getSettingsById()

Gibt ein Array mit allen existierenden Settings zurück, nach IDs indexiert.

getSettingsForModule($module, $ignoreCache = true)

Gibt alle Settings für ein Modul zurück. $module ist hierbei das abgefragte Modul. $ignoreCache entscheidet, ob die Werte aus dem Cache oder direkt von der Datenbank geladen werden sollen.