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.

...

Ein Array mit Identifikatoren von Feldern welche in diesem Formular gezeigt werden sollen. Ein solches Array erhält unter anderem über die 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.

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

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

Beispiel

...

...

Mit Component/Form können aus den Strukturdefinition von Component/Widget und der Datenmodellierung Formulare erzeugt werden. Durch einen FormBuilder kann das entstehende Formular beeinflusst und verändert werden.

Erzeugen eines Formulares

use Brandbox\Framework\Component\Widget;
use Brandbox\Framework\Component\Form;

$builder = $this
	->staticController(Form\Manager::class)
	->getStandardBuilder()
;

$builder->prefix = '...'; // Eindeutiger Identifikator für dieses Formular (bspw. uniqid())
$builder->container = $this
	->staticController(Widget\Manager::class)
	->getRepositoryWidget('Administrator')
;

$form = $this
	->staticController(Form\Manager::class)
	->getFrameworkForm($builder)
;

Weitere Optionen von FormBuilderStandard

Einstellungskonstanten von FormBuilderStandard

Konfiguration von Eingabefeldlisten

Die Einstellungen für die Optionen whitelist, blacklist, readonly und disabled können unter anderem auch durch eine Konfiguration bei den Eingabefeldern definiert und über eine Methode in Component/Form abgerufen werden.

Definition der Eingabefeldlisten

{
	// ...

	"[whitelist|blacklist|readonly|disabled]": [
		"[Frei wählbarer Identifikator]"
	]

	// ...
}

Diese Definition kann direkt in den Strukturdateien von Component/Widget aber auch in der Feldkonfiguration der Datenmodellierung genutzt hinterlegt werden. Es können pro Option mehrere frei wählbare Identifikatoren konfiguriert werden. Diese auf diese Weise markierten Felder können mit dem folgenden Code aus einer Strukturdefinition abegrufen werden:

use Brandbox\Framework\Component\Form;
use Brandbox\Framework\Component\Widget;

$container = $this
	->staticController(Widget\Manager::class)
	->getRepositoryWidget("Administrator")
;

// Die folgenden Konstanten stehen zur Verfügung:
//  - Form\Manager::TYPE_WHITELIST
//  - Form\Manager::TYPE_BLACKLIST
//  - Form\Manager::TYPE_READONLY
//  - Form\Manager::TYPE_DISABLED

$columns = $this
	->staticController(Form\Manager::class)
	->getListedColumns($container, "[Frei wählbarer Identifikator]", "[Eine der genannten Konstanten]")
;