[Draft] [Example] Integrate a webspace specific setting administration interface

config/forms/webspace_setting_details.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" ?>
+<form xmlns="http://schemas.sulu.io/template/template"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://schemas.sulu.io/template/template http://schemas.sulu.io/template/form-1.0.xsd"
+>
+    <key>webspace_setting_details</key>
+
+    <properties>
+        <property name="demobarText" type="text_line">
+            <meta>
+                <title>app.demobar_text</title>
+            </meta>
+        </property>
+    </properties>
+</form>

config/packages/app_webspace_setting_admin.yaml

@@ -0,0 +1,5 @@
+sulu_admin:
+    resources:
+        webspace_settings:
+            routes:
+                detail: 'app.get_webspace_settings'

public/build/admin/manifest.json

@@ -1,7 +1,7 @@
 {
-  "main.css": "/build/admin/main.7825759723a3c825efc7.css",
-  "main.js": "/build/admin/main.7825759723a3c825efc7.js",
-  "main.js.map": "/build/admin/main.7825759723a3c825efc7.js.map",
+  "main.css": "/build/admin/main.a5f695a5931373b4bce3.css",
+  "main.js": "/build/admin/main.a5f695a5931373b4bce3.js",
+  "main.js.map": "/build/admin/main.a5f695a5931373b4bce3.js.map",
   "build/admin/fonts/fa-brands-400.woff": "/build/admin/fonts/fa-brands-400.2285773e6b4b172f07d9b777c81b0775.woff",
   "build/admin/fonts/fa-brands-400.eot": "/build/admin/fonts/fa-brands-400.23f19bb08961f37aaf692ff943823453.eot",
   "build/admin/fonts/fa-brands-400.svg": "/build/admin/fonts/fa-brands-400.2f517e09eb2ca6650ff5bec5a95157ab.svg",

src/Admin/WebspaceSettingAdmin.php

@@ -0,0 +1,125 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Admin;
+
+use App\Entity\WebspaceSetting;
+use Sulu\Bundle\AdminBundle\Admin\Admin;
+use Sulu\Bundle\AdminBundle\Admin\View\ToolbarAction;
+use Sulu\Bundle\AdminBundle\Admin\View\ViewBuilderFactoryInterface;
+use Sulu\Bundle\AdminBundle\Admin\View\ViewCollection;
+use Sulu\Bundle\PageBundle\Admin\PageAdmin;
+use Sulu\Component\Security\Authorization\PermissionTypes;
+use Sulu\Component\Security\Authorization\SecurityCheckerInterface;
+use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
+use Sulu\Component\Webspace\Webspace;
+
+class WebspaceSettingAdmin extends Admin
+{
+    public const TAB_VIEW = 'app.webspace_settings';
+    public const FORM_VIEW = 'app.webspace_settings.form';
+    public const FORM_KEY = 'webspace_setting_details';
+
+
+    public function __construct(
+        private WebspaceManagerInterface $webspaceManager,
+        private ViewBuilderFactoryInterface $viewBuilderFactory,
+        private SecurityCheckerInterface $securityChecker
+    ) {
+    }
+
+    public function configureViews(ViewCollection $viewCollection): void
+    {
+        if ($this->hasSomeWebspaceSettingPermission()) {
+            $viewCollection->add(
+                // sulu will only load the existing entity if the path of the form includes an id attribute
+                $this->viewBuilderFactory->createResourceTabViewBuilder(static::TAB_VIEW, '/webspace-settings/:id')
+                    ->setResourceKey(WebspaceSetting::RESOURCE_KEY)
+                    ->setTabTitle('app.webspace_settings')
+                    ->setParent(PageAdmin::WEBSPACE_TABS_VIEW)
+                    ->setOption('routerAttributesToFormRequest', ['webspace'])
+                    ->setTabOrder(8096)
+                    ->setAttributeDefault('id', '-')
+            );
+
+            $viewCollection->add(
+                $this->viewBuilderFactory->createFormViewBuilder(static::FORM_VIEW, '/details')
+                    ->setResourceKey(WebspaceSetting::RESOURCE_KEY)
+                    ->setFormKey(self::FORM_KEY)
+                    ->setTabTitle('sulu_admin.details')
+                    ->addToolbarActions([new ToolbarAction('sulu_admin.save')])
+                    ->addRouterAttributesToFormRequest(['webspace'])
+                    ->setParent(static::TAB_VIEW)
+            );
+        }
+    }
+
+    public function getSecurityContexts(): array
+    {
+        $webspaceContexts = [];
+        /* @var Webspace $webspace */
+        foreach ($this->webspaceManager->getWebspaceCollection() as $webspace) {
+            $securityContextKey = self::getWebspaceSettingSecurityContext($webspace->getKey());
+            $webspaceContexts[$securityContextKey] = $this->getSecurityContextPermissions();
+        }
+
+        return [
+            self::SULU_ADMIN_SECURITY_SYSTEM => [
+                'Webspaces' => $webspaceContexts,
+            ],
+        ];
+    }
+
+    public function getSecurityContextsWithPlaceholder(): array
+    {
+        return [
+            self::SULU_ADMIN_SECURITY_SYSTEM => [
+                'Webspaces' => [
+                    self::getWebspaceSettingSecurityContext('#webspace#') => $this->getSecurityContextPermissions(),
+                ],
+            ],
+        ];
+    }
+
+    /**
+     * Returns security context for settings in given webspace.
+     *
+     * @final
+     *
+     * @param string $webspaceKey
+     *
+     * @return string
+     */
+    public static function getWebspaceSettingSecurityContext($webspaceKey): string
+    {
+        return \sprintf('%s%s.%s', PageAdmin::SECURITY_CONTEXT_PREFIX, $webspaceKey, 'settings');
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getSecurityContextPermissions(): array
+    {
+        return [
+            PermissionTypes::VIEW,
+            PermissionTypes::EDIT,
+        ];
+    }
+
+    private function hasSomeWebspaceSettingPermission(): bool
+    {
+        foreach ($this->webspaceManager->getWebspaceCollection()->getWebspaces() as $webspace) {
+            $hasWebspaceAnalyticsPermission = $this->securityChecker->hasPermission(
+                self::getWebspaceSettingSecurityContext($webspace->getKey()),
+                PermissionTypes::EDIT
+            );
+
+            if ($hasWebspaceAnalyticsPermission) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/Controller/Admin/WebspaceSettingController.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Admin;
+
+use App\Admin\WebspaceSettingAdmin;
+use App\Entity\WebspaceSetting;
+use Doctrine\ORM\EntityManagerInterface;
+use Sulu\Component\Security\SecuredControllerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+/**
+ * @phpstan-type WebspaceSettingsData array{
+ *     demobarText: string|null,
+ * }
+ */
+class WebspaceSettingController extends AbstractController implements SecuredControllerInterface
+{
+    public function __construct(
+        private EntityManagerInterface $entityManager,
+        private RequestStack $requestStack,
+    ) {
+    }
+
+    /**
+     * @Route("/admin/api/webspace-settings/{id}", methods={"GET"}, name="app.get_webspace_settings")
+     */
+    public function getAction(Request $request): Response
+    {
+        $webspace = $request->query->get('webspace');
+
+        $webspaceSetting = $this->entityManager->getRepository(WebspaceSetting::class)->findOneBy([
+            'webspace' => $webspace,
+        ]);
+
+        return $this->json($this->getDataForEntity($webspaceSetting ?: new WebspaceSetting($webspace)));
+    }
+
+    /**
+     * @Route("/admin/api/webspace-settings/{id}", methods={"PUT"}, name="app.put_webspace_settings")
+     */
+    public function putAction(Request $request): Response
+    {
+        $webspace = $request->query->get('webspace');
+
+        $webspaceSetting = $this->entityManager->getRepository(WebspaceSetting::class)->findOneBy([
+            'webspace' => $webspace,
+        ]);
+
+        if (!$webspaceSetting) {
+            $webspaceSetting = new WebspaceSetting($webspace);
+            $this->entityManager->persist($webspaceSetting);
+        }
+
+        /** @var WebspaceSettingsData $data */
+        $data = $request->toArray();
+        $this->mapDataToEntity($data, $webspaceSetting);
+        $this->entityManager->flush();
+
+        return $this->json($this->getDataForEntity($webspaceSetting));
+    }
+
+    /**
+     * @return WebspaceSettingsData $data
+     */
+    protected function getDataForEntity(WebspaceSetting $entity): array
+    {
+        return [
+            'demobarText' => $entity->getDemobarText(),
+        ];
+    }
+
+    /**
+     * @param WebspaceSettingsData $data
+     */
+    protected function mapDataToEntity(array $data, WebspaceSetting $entity): void
+    {
+        $entity->setDemobarText($data['demobarText']);
+    }
+
+    public function getSecurityContext()
+    {
+        $request = $this->requestStack->getCurrentRequest();
+
+        return WebspaceSettingAdmin::getWebspaceSettingSecurityContext($request->query->get('webspace'));
+    }
+
+    public function getLocale(Request $request): ?string
+    {
+        return $request->query->get('locale');
+    }
+}

src/Entity/WebspaceSetting.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Sulu\Component\Persistence\Model\AuditableInterface;
+use Sulu\Component\Persistence\Model\AuditableTrait;
+
+
+#[ORM\Entity]
+#[ORM\Table(name: 'app_webspace_setting')]
+class WebspaceSetting implements AuditableInterface
+{
+    use AuditableTrait;
+
+    public const RESOURCE_KEY = 'webspace_settings';
+
+    #[ORM\Id()]
+    #[ORM\GeneratedValue()]
+    #[ORM\Column(type: "integer")]
+    private ?int $id = null;
+
+    #[ORM\Column(type: "string", length: 32, nullable: false, unique: true)]
+    private string $webspace;
+
+    #[ORM\Column(type: "string", length: 191, nullable: true)]
+    private ?string $demobarText = null;
+
+    public function __construct(string $webspace)
+    {
+        $this->webspace = $webspace;
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getWebspace(): string
+    {
+        return $this->webspace;
+    }
+
+    public function getDemobarText(): ?string
+    {
+        return $this->demobarText;
+    }
+
+    public function setDemobarText(?string $demobarText): void
+    {
+        $this->demobarText = $demobarText;
+    }
+}

src/Twig/WebspaceSettingTwigExtension.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Twig;
+
+use App\Entity\WebspaceSetting;
+use Doctrine\ORM\EntityManagerInterface;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFunction;
+
+class WebspaceSettingTwigExtension extends AbstractExtension
+{
+    private EntityManagerInterface $entityManager;
+
+    public function __construct(
+        EntityManagerInterface $entityManager
+    ) {
+        $this->entityManager = $entityManager;
+    }
+
+    public function getFunctions()
+    {
+        return [
+            new TwigFunction('load_webspace_setting', [$this, 'loadWebspaceSetting']),
+        ];
+    }
+
+    public function loadWebspaceSetting(string $webspace): WebspaceSetting
+    {
+        $applicationSettings = $this->entityManager->getRepository(WebspaceSetting::class)->findOneBy(['webspace' => $webspace]) ?? null;
+
+        return $applicationSettings ?: new WebspaceSetting($webspace);
+    }
+}

templates/base.html.twig

@@ -4,6 +4,8 @@
     {# @see https://docs.sulu.io/en/2.2/reference/twig-extensions/functions/sulu_snippet_load_by_area.html #}
     {% set webspaceSettings = sulu_snippet_load_by_area('webspace_settings') %}
 
+    {% set webspaceSetting = load_webspace_setting(app.request.attributes.get('_sulu').getAttribute('webspace').key) %}
+
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">

templates/includes/demobar.html.twig

@@ -4,7 +4,7 @@
     </a>
 
     <p class="demobar__title">
-        SULU DEMO
+        {{ applicationSettings.demobarText|default('SULU DEMO') }}
     </p>
 
     <a href="https://github.com/sulu/sulu-demo" target="_blank" class="demobar__github">

translations/admin.de.json

@@ -10,5 +10,7 @@
     "app.album_selection_label": "{count} {count, plural, =1 {Album} other {Alben}} ausgewählt",
     "app.select_albums": "Alben auswählen",
     "app.no_album_selected": "Kein Album ausgewählt",
-    "app.select_album": "Album auswählen"
+    "app.select_album": "Album auswählen",
+    "app.webspace_settings": "Einstellungen",
+    "app.demobar_text": "Demobar Text"
 }

translations/admin.en.json

@@ -10,5 +10,7 @@
     "app.album_selection_label": "{count} {count, plural, =1 {album} other {albums}} selected",
     "app.select_albums": "Select albums",
     "app.no_album_selected": "No album selected",
-    "app.select_album": "Select album"
+    "app.select_album": "Select album",
+    "app.webspace_settings": "Settings",
+    "app.demobar_text": "Demobar Text"
 }