Diagramme können in brandbox über eine Definition dargestellt werden.
Die Definitionen werden in einem persistenten Cache zwischengespeichert um die Performance zu verbesseren. Dieser Cache nutzt der Namespace brandbox/framework-diagram
, welcher sowohl über die Administrationsoberfläche als auch programmatisch geleert werden kann.
Definition
Eine diagram.json
muss dem in framework-diagram/resources/diagram-schema.json
beschriebenen JSON-Schema folgen. Eine Entwicklungsumgebung wie bspw. PHPStorm verfügt über eine einfache Validierungmöglichkeit für die Schemata.
{ "diagrams": [ { "identifier": "countDatasets", "type": "table", "labels": { "de": "Anzahl Request Logs", "en": "Count Request log" }, "repository": "Administrator", "query": { "source": "\\Brandbox\\FrameworkDiagram\\Diagram\\Test\\Lib\\Query\\RequestLog", "filter": [ { "repository": "Administrator", "source": "definition:plugin/remote/brandbox/framework-diagram/src/Diagram/Test/Lib/Structure/AdministratorFilterDefinition.json" }, { "repository": "RequestLog", "source": "definition:plugin/remote/brandbox/framework-diagram/src/Diagram/Test/Lib/Structure/RequestLogFilterDefinition.json" } ] }, "configuration": { //Individuelle Konfiguration } } ] }