Versionen im Vergleich

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.

...

Aufbau des Plugins

Alle Bestandteile sind im Plugin inputInput/foreignKeyForeignKey zu finden. Integriert werden kann diese Art des Eingabefeldes durch die Datenmodellierung 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.

...

BezeichnungMögliche WerteBeschreibung
source
Input/ForeignKey.single
Input/ForeignKey.multiple
Input/ForeignKey.editable

Legt den Source-Aufruf für brandbox fest.

Info

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


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.
repositoryEindeutiger Identifikator einer DatentabelleAus der hier angegebenen Tabelle werden die auswählbaren Datensätze ausgelesen.
columnEindeutiger 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.


datapoolEindeutiger 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.


Funktionsumfänge

Wert in feature sourceBeschreibung
Input/ForeignKey.single
Einfaches Auswahlfeld ohne erweiterte Funktionen
Input/ForeignKey.multiple
Feld mit Mehrfachauswahl von einem oder mehreren Datensätzen. Keine Bearbeiten- und Anlegen-Funktion.
Input/ForeignKey.editable
Einfach-Auswahlfeld für einen Datensatz mit Buttons für die Bearbeitung und das Anlegen eines neuen Datensatzes.

Events

MethodeEingabeRückgabe
KlassennameBeschreibung
getCriteria
  • array
array

This 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.

getParameter
  • base\widget\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

\Brandbox\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.