Versionen im Vergleich

Version Alte Version 2 Neue Version Aktuell
Änderungen wurden vorgenommen von

Dirk Münker

Dominik Hisler

Gespeichert am

Schlüssel

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

Die Datensatzauswahl ermöglicht es Datensätze einer beliebigen Tabelle zu durchsuchen und diese einfach oder mehrfach auszuwählen. Zudem können Datensätze bei Bedarf bearbeitet und angelegt werden.

Image Removed

Aufbau des Plugins

Alle Bestandteile sind im Plugin inputInput/foreignKeyForeignKey zu finden. Integriert werden kann diese Art des Eingabefeldes durch die die Strukturmodellierung (Component/Modelling) und die Datenbankwidgets. Zudem zu beachten ist dass sich dieses Plugin in die Prozesse von Datensatz-Speicherung und Datensatz-Auslesen einklinkt und die zu speichernden oder zu lesenden Daten entsprechend transformiert.

Info

Eine Property einer Entitiy, welche durch dieses Plugin verwaltet wird, enthält entweder einen Integer oder ein Integer-Array und muss auch mit den gleichen Datentypen befüllt werden.

Verwendung

Verwendung

...

in der Strukturmodellierung (Component/Modelling)

Folgende Mindestkonfiguration muss als Feldkonfiguration hinterlegt werden:

Codeblock
languagetext
themeRDark
feature{
	"source": "inputInput/foreignKeyForeignKey.[single|multiple|editable]"
inputForeignKeyEditExternal: [false|true]
foreignKeyCriteria,
	"ForeignKeyCriteria": [Zusätzliche Suchkriterien],
	"relation": {
    	"repository": "[Tabellenidentifikator]",
    	"column": "[Spaltenidentifikator]",
    	"datapool": "[Datenpoolidentifikator]"
	}
}

Verwendung bei einem Feld des Datenbankwidgets

Folgende Mindestkonfiguration muss in der widget.json bei einer Spalte hinterlegt sein:

Codeblock
languagejsthemeRDark
{
	// [...],
	"formType": "featureSelect",
	"featuresource": "inputInput/foreignKeyForeignKey.[single|multiple|editable]",
	"configuration": {
		// [...],
		"foreignKeyCriteriaForeignKeyCriteria": [Zusätzliche Suchkriterien]
		"inputForeignKeyEditExternal": [false|true],
		"relation": {
			"repository": "[Tabellenidentifikator]",
			"column": "[Spaltenidentifikator]",
            "datapool": "[Datenpoolidentifikator]"
		}
	 }
	// [...]
}

Konfiguration

Parametererklärung

Bezeichnung

Mögliche Werte

Beschreibung

feature

source

input

Input/

foreignKey

ForeignKey.single

input

Input/

foreignKey

ForeignKey.multiple

input

Input/

foreignKey

ForeignKey.editable

Legt den

Feature

Source-Aufruf für brandbox fest.

Info

Der Funktionsumfang der einzelnen Möglichkeiten ist weiter unten beschrieben.

foreignKeyCriteria


ForeignKeyCriteria

Ein oder mehrere Einträge. Schlüssel des Eintrags entspricht einem eindeutigen Feldidentifikator und der Wert einem erwarten Wert im angegebenen Feld.

Der Platzhalter % ist gestattet.

Legt ein oder mehrere zusätzliche Suchkriterien für mögliche Datensätze fest. Gemeinsam mit einem durch den Benutzer definierten Suchfilter werden alle Kriterien mit einer UND-Verknüpfung verbunden und damit die entsprechende Datenbanktabelle durchsucht

.
inputForeignKeyEditExternal
true oder false

Legt fest, dass man direkt in einen ausgewählten Datensatz springen kann ohne die aktuellen Änderungen zu speichern. Hierzu wird bei aktiver Einstellung ein zusätzlicher Button neben dem Eingabefeld angezeigt.

InfoDiese Einstellung wird nur beachtet, wenn der Wert von feature auf input/foreignKey.editable gesetzt ist

.

repository

Eindeutiger Identifikator einer Datentabelle

Aus der hier angegebenen Tabelle werden die auswählbaren Datensätze ausgelesen.

column

Eindeutiger Identifikator eines Feldes

Werden auswählbare Datensätze zur Auswahl präsentiert oder durchsucht wird dieses Feld genutzt.

Info

Diese Option kann ab brandbox 5.6 ausgelassen werden. In diesem Fall werden die Ergebnisspalten zur Anzeige und die Suchfelder für die Suche der Datensätze genutzt.


datapool

Eindeutiger Identifikator eines Datenpools

Diese Eigenschaft ist gilt ausschließlich für Tabellen welche über die Tabellenstrukturen definiert wurden. Hier muss ein entsprechender Identifikator hinterlegt werden.

Info

Diese Eigenschaft darf auf einen leeren Wert gesetzt werden. Hierbei wird der Datenpool automatisch ermittelt wenn die aktuelle Tabelle und die Tabelle, auf welche der Fremdschlüssel zeigt, eine Tabellenstruktur-Tabelle ist und zuvor ein entsprechender Datenpool geöffnet wurde.


ForeignKeyUntranslated

Boolischer Wert (true oder false)

Wenn diese Option auf false gesetzt wurde, werden nur Datensätze beachtet welche eine Übersetzung in der aktuellen Kollation besitzen.

ForeignKeyCreate

Boolischer Wert (true oder false)

Wenn diese Option auf false gesetzt wurde, wird keine Schaltfläche zum Erstellen eines neuen Datensatzes angeboten auch wenn der Anwender die entsprechenen Rechte für diese Funktion besitzt.

Info

Befindet sich das Fremdschlüsselauswahlfeld in einem Übersetzungsdatensatz, steht die Schaltfläche zur Datensatzerstellung nur zusammen mit der Option ForeignKeyUntranslated zur Verfügung.

ForeignKeyOpen

Boolischer Wert (true oder false)

Wenn diese Option auf false gesetzt wurde, wird keine Schaltfläche zum Öffnen des gewählten Datensatzes angeboten auch wenn der Anwender die entsprechenen Rechte für diese Funktion besitzt.

Funktionsumfänge

Wert in

feature

source

Beschreibung

input

Input/

foreignKey

ForeignKey.single

Einfaches Auswahlfeld ohne erweiterte Funktionen

input

Input/

foreignKey

ForeignKey.multiple

Feld mit Mehrfachauswahl von einem oder mehreren Datensätzen. Keine Bearbeiten- und Anlegen-Funktion.

input

Input/

foreignKey

ForeignKey.editable

Einfach-Auswahlfeld für einen Datensatz mit Buttons für die Bearbeitung und das Anlegen eines neuen Datensatzes

. Wurde die Option inputForeignKeyEditExternal auf true gesetzt wird hier zusätzlich ein Button angezeigt welches direkt zu dem ausgewählten Datensatz führt

.

Events

MethodeEingabe

Klassenname

Rückgabe

Beschreibung

getCriteria
  • array
arrayThis event can be subscribed to when it is neccessary to manipulate the possible entries of a foreign key input field. The subscribers are expected to manipulate the array of criteria that is processed when a foreign key input field is searching for its possible entries.

getParameterbase

\

widget

Brandbox\

lib\field
  • array
    • array

    This event can be subscribed to when it is neccessary to manipulate the array of parameters that are provided to the search function of a foreign key input field when it searches for its entries.

    getQueryBuilderCriteria

    • array

    • base\widget\lib\widget\interfaces\columnInterface

    • doctrine\lib\repository\repositoryAbstract

    array

    This event can be subscribed to when it is neccessary to manipulate the possible results when searching for a foreign key value by using the search filter in uiBase. The subscribers are expected to manipulate the array of criteria that is processed when "component/querybuilder" build the search query.

    save
    • doctrine\lib\entityAbstract
    • array
    voidThis event can be subscribed to when it is neccessary to mainpulate the save proccess when creating a new dataset via the "Create dataset"-button of the foreign key input field.onPopulateButton
    • foreignkey\lib\event\dto\dtoPopulateButtons
      • styleguide\brandbox\entity\button[]
      • string
    voidThis event can be subscribed to when it is neccessary to add or remove buttons from the foreign key input field

    Framework\Input\ForeignKey\Lib\Event\OnPopulateQueryBuilder

    Über dieses Event kann der QueryBuilder für die Datensatzsuche beeinflusst werden.

    \Brandbox\Framework\Input\ForeignKey\Lib\Event\OnPopulateRepository

    Standardmäßig wird das Repository aus dem Identifikator der Konfiguration ermittelt. Über dieses Event kann in die Suche nach dem Repository eingegriffen werden.