Seitenvergleich

Ansichten sind Darstellungselemente, die sich auf Seiten platzieren lassen.

...

Eine Ansicht sollte sich innerhalb der Ordnerstruktur einer App immer im Namespace "View" befinden, bspw. lautet der Ordner für die Ansicht "Text / Bild":

^{plugin/remote/brandbox/cms-layout-standard/src/View/Tile}

Im weiteren Verlauf "Paketordner" genannt.
Unterhalb des Paketordners muss sich eine PHP-Datei "Engine.php" und außerdem ein Ordner "views" befinden. Eine platzierbare Ansicht benötigt dort immer mindestens 2 Dateien:

configAnsichten (CMS)#Ansichten (CMS)#config.json

viewAnsichten (CMS)#Ansichten (CMS)#view.hbs

Engine.php

Diese Datei liegt direkt im Paketordner und stellt die öffentlichen Endpunkte für die Ansichten bereit. Ein Endpunkt entspricht einer öffentlichen Methode in dieser Datei.

...

...

Beispiel: "Text / Bild"

public function tile($viewID)
{
    $paragraph = new FrameworkStyleguide\Entity\FrameworkParagraph();
    $paragraph->content = new FrameworkStyleguide\StringSafe('Hello World');
	return [
       'paragraph' => $paragraph
    ];
}

Engines von Views, die andere Views enthalten können, müssen das Interface

...

implementieren, damit im Designer andere Views innerhalb platziert werden können. Hierzu kann die Klasse einfach von Brandbox\CmsCore\Cms\Page\lib\ContainerViewAbstract abgeleitet werden:

class Engine extends Page\lib\ContainerViewAbstract implements Page\lib\Interfaces\ContainerViewInterface

config.json

Anker
config.json config.json

Diese Konfigurationsdatei im JSON-Format vergibt wichtige Parameter für platzierbare Views:

Hier beispielhaft der Inhalt der config.json für "Text / BildContainer":

...

Beispiel: Inhalt der config.json für "

...

Container":

{
    "coreType": "cms-core",
    "friendlyName": {
        "de": "Container"Text,
  / Bild",     "en": "Container"Text
/ Image"   },
    "depends": ["Theme/DefaultCms"],
    "context": ["page"],
    "extra": {
        "cms": {
            "section"]  isContainer": true
        }
    }
}

view.hbs

...

"paragraph" steht in der view.hbs über die serve-Variable zur Verfügung:

Beispiel: view.hbs

{{{ compile serve.paragraph }{{{ compile serve.paragraph }}}

Für Container-Views muss die mögliche Schachtelung von untergeordneten Inhalten deklariert werden, am Beispiel des Container-Views:

{{#> cms-row this class=serve.class }}
  {{{section "main" parent}}}	// brandbox <= 6.0
  {{{views parent}}} 			// brandbox >= 6.0
{{/cms-row}}

Ermittlung des Endpunkt-Namens

config.json-Dateien für Ansichten werden in bis zu 3 Ordnerebenen unter dem Ordner "views" gefunden. Der Feature-Name ergibt sich aus dem Namen der Ordner im CamelCase-Style.

Beispiele:

Abhängigkeitskette für die Zuordnung von Ansichten zu Theme-Paketen

Wie oben beschrieben werden Ansichten über den Parameter "depends" in der config.json zu Theme-Paketen zugeordnet.

...

Diese Logik findet Verwendung beim Theme-Paket "Theme/DefaultShop". Dort wird in der config.json des Pakets eine Abhängigkeit zu Theme/DefaultCms definiert. Damit sind auf einer Seite, die ein Template von Theme/DefaultShop verwendet, auch alle Ansichten platzierbar, die über den Parameter "depends" in der config.json der Ansicht dem Theme-Paket "Theme/DefaultCms" zugeordnet sind.

...

config.json des Theme-Pakets Theme/DefaultShop

{
  "friendlyName": {
    "de": "Default Shop Theme",
    "en": "Default Shop Theme"
   },
  "depends": ["Theme/DefaultCms"]
}

...