New: Add settings helpers

Service, FusionObject &EelHelper

Author: jonnitto

Classes/EelHelper/MauticHelper.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Garagist\Mautic\EelHelper;
+
+use Neos\Eel\ProtectedContextAwareInterface;
+use Neos\Flow\Annotations as Flow;
+use Garagist\Mautic\Service\SettingsService;
+
+class MauticHelper implements ProtectedContextAwareInterface
+{
+
+    #[Flow\Inject]
+    protected SettingsService $settingsService;
+
+    public function settings(string $settingPath, ?string $siteName = null, $rootPackage = 'Garagist.Mautic'): string
+    {
+        return $this->settingsService->path($settingPath, $siteName, $rootPackage);
+    }
+}

Classes/FusionObjects/SettingsImplementation.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Garagist\Mautic\FusionObjects;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Fusion\FusionObjects\AbstractFusionObject;
+use Garagist\Mautic\Service\SettingsService;
+
+class SettingsImplementation extends AbstractFusionObject
+{
+    #[Flow\Inject]
+    protected SettingsService $settingsService;
+
+    /**
+     * Get setting path
+     *
+     * @return string|null
+     */
+    protected function getPath(): ?string
+    {
+        return $this->fusionValue('path');
+    }
+
+    /**
+     * Get site name
+     *
+     * @return string|null
+     */
+    protected function siteName(): ?string
+    {
+        return $this->fusionValue('siteName');
+    }
+
+    /**
+     * @return string
+     */
+    public function evaluate()
+    {
+        $path = $this->getPath();
+        $siteName = $this->siteName();
+
+        return $this->settingsService->path($path, $siteName);
+    }
+}

Classes/Service/SettingsService.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Garagist\Mautic\Service;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Configuration\ConfigurationManager;
+
+#[Flow\Scope('singleton')]
+class SettingsService
+{
+    #[Flow\Inject]
+    protected ConfigurationManager $configurationManager;
+
+    /**
+     * Get configuration based on the setting path and sitename
+     *
+     * @return string
+     */
+    public function path(string $settingPath, ?string $siteName = null, $rootPackage = 'Garagist.Mautic'): string
+    {
+        $siteSettings = $this->getSetting($rootPackage, $settingPath, $siteName);
+
+        if (isset($siteSettings)) {
+            return $siteSettings;
+        }
+
+        return $this->getSetting($rootPackage, $settingPath);
+    }
+
+    /**
+     * Get the setting from the configuration
+     *
+     * @param string $settingPath
+     * @param string|null $siteName
+     * @return mixed
+     */
+    protected function getSetting(string $rootPackage, string $settingPath, ?string $siteName = null): mixed
+    {
+        if ($siteName) {
+            $settingPath = sprintf('siteSettings.%s.%s', $siteName, $settingPath);
+        }
+        if (!str_starts_with($settingPath, $rootPackage)) {
+            $settingPath = sprintf('%s.%s', $rootPackage, $settingPath);
+        }
+
+        $setting = $this->configurationManager->getConfiguration(ConfigurationManager::CONFIGURATION_TYPE_SETTINGS, $settingPath);
+        return $setting ?? null;
+    }
+}

Configuration/Settings.Garagist.yaml

@@ -1,5 +1,12 @@
 Garagist:
   Mautic:
+    # Override any of the settings below by add the site name
+    # Example:
+    # siteSettings:
+    #   rootNodeName:
+    #      enableTracking: true
+    siteSettings: null
+
     routeArgument:
       htmlTemplate: email
       plaintextTemplate: plaintext

Configuration/Settings.Neos.yaml

@@ -19,6 +19,9 @@ Neos:
                 logFileURL: '%FLOW_PATH_DATA%Logs/Mautic.log'
                 createParentDirectories: true
                 severityThreshold: '%LOG_DEBUG%'
+  Fusion:
+     defaultContext:
+       Mautic: 'Garagist\Mautic\EelHelper\MauticHelper'
   Neos:
     userInterface:
       translation:

Resources/Private/Fusion/Settings.fusion

@@ -0,0 +1,6 @@
+prototype(Garagist.Mautic:Settings) {
+    @class = 'Garagist\\Mautic\\FusionObjects\\SettingsImplementation'
+
+    siteName = ${site.name}
+    path = null
+}