Versionen im Vergleich

Schlüssel

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

...

Info

Eine widget.json muss dem in framework/resources/widget-schema.json beschriebenen JSON-Schema folgen. Eine Entwicklungsumgebung wie bspw. PHPStorm verfügt über eine einfache Validierungmöglichkeit für die Schemata.


Abrufen einer Widgetdefinition
Codeblock
languagephp
themeRDark
titleAbrufen einer Widgetdefinition
collapsetrue
use Brandbox\Framework\Component\Widget;

$definition = $this
	->staticController(Widget\Manager::class)
	->getPackageWidget('Custom/Package')
;

// Die Definition einer Datenbanktabelle kann aber auch direkt anhand ihres Identifikators abgerufen werden ...
$definition = $this
	->staticController(Widget\Manager::class)
	->getRepositoryWidget('CustomEntityIdentifier')
;

...

Info

Strukturdefinition sollten innerhalb eines Codepakets immer im Ordner Lib/Structure/ abgelegt werden und eine eindeutigen Namen tragen. Zudem müssen diese Definitionen dem in framework/resources/structure-schema.json definierten JSON-Schema folgen.


Abrufen einer Strukturdefinition
Codeblock
languagephp
themeRDark
titleAbrufen einer Strukturdefinition
collapsetrue
use Brandbox\Framework\Component\Widget;

$definition = $this
	->staticController(Widget\Manager::class)
	->getDefinitionWidget('[Pfad zur Strukturdefinition ohne Hauptverzeichnis (/var/www/)]')
;

Definition per modelling.json

Die Modellingdefinition ist sehr ähnlich zur Strukturdefinition, sie wird allerdings zur Erweiterung von bereits existierenden Widgetdefinitionen genutzt und daher sehr ähnlich zur Datenmodellierung in brandbox. Jedes Codepaket kann eine modelling.json enthalten. Diese muss, wie die widget.json, im Hauptverzeichnis des Codepakets abgelegt werden.

...