Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

Die nachfolgenden Methoden stehen für einen programmatischen Zugriff zur Verfügung und können im Manager von Component/Preference gefunden werden.

Abrufen einer Anwenderpräferenz
Codeblock
languagephp
themeRDark
titleAbrufen einer Anwenderpräferenz
use Brandbox\Framework\Component\Preference;

$content = $this
	->staticController(Preference\Manager::class)
	->getPreferenceContent('[Identifikator der Präferenz]')
;

// $content enthält ggf. einen Standardwert des Entities, null oder den durch den Anwender festgelegten Wert


Festlegen einer Anwenderpräferenz
Codeblock
languagephp
themeRDark
titleFestlegen einer Anwenderpräferenz
use Brandbox\Framework\Component\Preference;

$this
	->staticController(Preference\Manager::class)
	->setPreferenceContent('[Identifikator der Präferenz]', '[Inhalt der Präferenz]')
;

Integration der Pflegeoberfläche

Um dem Anwender die Pflege seiner Präferenzen zu ermöglichen, muss die genutzte Oberfläche eine Integration von Component/Preference durchführen. Hierzu wird über den nachfolgenden Code die Pflegemaske von Component/Preference abgerufen welche dann in der integrierenden Oberfläche platziert werden kann.

Codeblock
languagephpthemeRDark
use Brandbox\Framework\Component\Preference;

$container = $this
	->staticController(Preference\Manager::class)
	->getPreferenceContainer(...$flags)
;

// $container enthält eine Instanz des FrameworkContainer aus dem framework-styleguide mit einer Toolbar und einem Formular
// $flags ist ein Array aus Strings mit frei-wählbaren Kennzeichen welche in den Events zur Verfügung stehen

Verfügbare Events

Klassenname

Beschreibung

OnPopulateContainer

Wird durch den Aufruf von Manager::getPreferenceContainer() ausgeführt. Es befüllt den zu nutzenden FormBuilder, platziert die Toolbar und das Präferenzenformular.

OnPopulateListed

Wird während OnPopulateContainer und OnExecutePersist aufgerufen um die White- und Blacklist der FormBuilders zu befüllen sowie die zu ignorierenden Felder für die Validierung zu ermitteln.

OnExecuteReset

Wird ausgeführt, wenn der Anwender seine Präferenzen zurücksetzten möchte.

OnExecutePersist

Wird ausgeführt, wenn der Anwender seine Präferenzen speichern möchte.

Rechtekonfiguration

Für diese Komponente gibt es keine notwendige Rollen- oder Rechtekonfiguration. Die Präfernenzentabelle mit allen Datensätzen kann nur durch Administratoren eingesehen werden. Jeder Anwender kann jederzeit seine Präferenzen speichern und lesen.