Form

Das Plugin component/form stellt ein einheitliches Interface zur Verfügung über das Formulare und Formularfelder aus einem Doctrine-Entity oder eine Formularmaske der Datenmodellierung erstellt werden können. Zudem können über component/form Felder vorab gefiltert werden um ein Formular mit eingeschränkten Feldern zu erhalten.

Aufbau des Plugins

Dem Programmierer stehen die in der nachfolgenden Tabelle beschriebenen öffentlichen Methoden in der Klase \brandbox\component\form\engine zur Verfügung.

Methode	Parameter	Beschreibung
`getFormByEntity`	Liefert eine nicht vollständig konfigurierte Datenklasse welche für das Styleguide-Formular (`form`) genutzt werden kann. Diese Datenklasse verfügt über weitaus mehr Eigenschaften als diese Methode befüllt. Eine vollständige Konfiguration muss daher durch den Entwickler stattfinden.
	`$entity`	Eine Doctrine-Entity einer bestimmtem Tabelle aus welcher das Formular generiert werden soll.
	`$iso639`	Der zweistellige Ländercode welcher für die Übersetzung des Formulars genutzt werden soll (bspw. `de`).
	`$values`	Ein Array mit Werten welche vorab in die Felder des Formulars gefüllt werden. Der Schlüssel des Arrays entspricht dem Identifikator des Feldes und der Wert aus dem Array dem Wert welcher in das Formularfeld gefüllt wird.
	`$whitelist`	Ein Array mit Identifikatoren von Feldern welche in diesem Formular gezeigt werden sollen. Ein solches Array erhält unter anderem über die Methode `getListedColumnsByEntity`. Sind Werte in diesem Array vorhanden werden alle Felder, deren Identifikatoren sich nicht in diesem Array befinden, nicht in diesem Formular angezeigt.
	`$blacklist`	Ein Array mit Identifikatoren von Feldern welche nicht in diesem Formular erscheinen sollen. Ein solches Array erhält man beispielsweise über die Methode `getListedColumnsByEntity`.
	`$params`	Ein Array mit Parametern welche den Eingabefeldern zur Verfügung stehen.
	`$engine`	Eine Plugin welches den Eingabefeldern mitgegeben wird.
	`$pattern`	Ein Muster welches für die Namen der Felder innerhalb des Formulars genutzt werden sollen. Der Platzhalter `%s` wird immer durch den Identifikator des Feldes ersetzt.
`getFormByFormMaskID`	Liefert eine nicht vollständig konfigurierte Datenklasse welche für das Styleguide-Formular (`form`) genutzt werden kann. Diese Datenklasse verfügt über weitaus mehr Eigenschaften als diese Methode befüllt. Eine vollständige Konfiguration muss daher durch den Entwickler stattfinden.
	`$id`	Die Datensatz-ID der entsprechenden Formularmaske aus der Datenmodellierung.
	`$iso639`	Siehe Beschreibung von `$iso639` bei der Methode `getFormByEntity`.
	`$values`	Siehe Beschreibung von `$values` bei der Methode `getFormByEntity`.
	`$whitelist`	Siehe Beschreibung von `$whitelist` bei der Methode `getFormByEntity`.
	`$blacklist`	Siehe Beschreibung von `$blacklist` bei der Methode `getFormByEntity`.
	`$params`	Siehe Beschreibung von `$params` bei der Methode `getFormByEntity`.
	`$engine`	Siehe Beschreibung von `$engine` bei der Methode `getFormByEntity`.
	`$pattern`	Siehe Beschreibung von `$pattern` bei der Methode `getFormByEntity`.
`getListedColumnsByEntity`	Liefert ein Array aus Feldidentifikatoren welche entweder für den Parameter `$blacklist` oder `$whitelist` aus den zuvor beschriebenen Methoden verwendet können.
	`$entity`	Eine Doctrine-Entity aus der Felder entsprechend gefiltert werden sollen.
	`$identifier`	Ein eindeutiger Formular-Identifikator. Eine genauere Beschreibung dieses Identifikators ist unter dem Punkt Konfiguration zu finden.
	`$type`	Der genutzte Typ für den Filter. Es stehen die Konstanten `\brandbox\component\form\engine::LIST_TYPE_BLACKLIST` und `\brandbox\component\form\engine::LIST_TYPE_WHITELIST` zur Verfügung.
`getListedColumnsByFormMaskID`	Liefert ein Array aus Feldidentifikatoren welche entweder für den Parameter `$blacklist` oder `$whitelist` aus den zuvor beschriebenen Methoden verwendet können.
	`$id`	Die Datensatz-ID der Formularmaske aus der Datenmodellierung.
	`$identifier`	Siehe Beschreibung von `$identifier` bei der Methode `getListedColumnsByEntity`.
	`$type`	Siehe Beschreibung von `$type` bei der Methode `getListedColumnsByEntity`.

Konfiguration

Um ein Formular aus einem Doctrine-Entity oder einer Formularmaske zu generieren ist grundsätzliche keine zusätzliche Konfiguration für dieses Plugin erforderlich. Werde jedoch die Black- bzw. Whitelist verwendet, so müssen die Felder des Entities oder der Formularmaske entsprechend gekennzeichnet werden. Die Methoden getListedColumnsByEntity und getColumnsByFormMaskID besitzen den Parameter $identifier. Dieser stellt eine eindeutige Identifikation eines Formulars dar und kann durch den Programmierer bzw. den Anwender frei gewählt werden. Dieser Identifikator kann bei jedem betroffenen Feld hinterlegt werden und bestimmt ob dieses Feld freigegeben ist oder nicht.

Hinterlegung in der widget.json

{
    "identifier": "[Identifikator des Datenbankfeldes]",
	// [...]
	"configuration": {
		// [...]
		"whitelist": ["[Identifikator des Formulars]"],
		"blacklist": ["[Identifikator des Formulars]"]
	}
}

Hinterlegung in der Feldkonfiguration

blacklist:
  - '[Identifkator des Formulars]'
whitelist:
  - '[Identifkator des Formulars]'

Beispiel

// Abrufen eines leeren Doctrine-Entities
$entity = $this
	->getRepository(myDoctrineEntity::class)
	->getEntity(0)
;

// Abrufen der Black- und Whitelist
$engine = $this->getAppFactory(\brandbox\component\form\engine::class);

$whitelist = $engine->getListedColumnyByEntity($entity, '[Identifikator des Formulars]', $engine::LIST_TYPE_WHITELIST);
$blacklist = $engine->getListedColumnyByEntity($entity, '[Identifikator des Formulars]', $engine::LIST_TYPE_BLACKLIST);

// Abrufen des Formulars
$iso639 = $this->getApplicationLanguage();
$values = [];
$pattern = '%s';

$form = $engine->getFormByEntity($entity, $iso639, $values, $whitelist, $blacklist, $pattern);