Allow to define icons for settings

src/Settings/SettingsIcon.php

@@ -0,0 +1,32 @@
+<?php
+/*
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ *  Copyright (C) 2019 - 2024 Jan Böhmer (https://github.com/jbtronics)
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published
+ *  by the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+
+namespace App\Settings;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class SettingsIcon
+{
+    public function __construct(public string $icon)
+    {
+    }
+}

src/Settings/SystemSettings/AttachmentsSettings.php

@@ -23,6 +23,7 @@ declare(strict_types=1);
 
 namespace App\Settings\SystemSettings;
 
+use App\Settings\SettingsIcon;
 use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
 use Jbtronics\SettingsBundle\Settings\Settings;
 use Jbtronics\SettingsBundle\Settings\SettingsParameter;
@@ -31,6 +32,7 @@ use Symfony\Component\Translation\TranslatableMessage as TM;
 use Symfony\Component\Validator\Constraints as Assert;
 
 #[Settings(label: new TM("settings.system.attachments"))]
+#[SettingsIcon("fa-paperclip")]
 class AttachmentsSettings
 {
     use SettingsTrait;

src/Settings/SystemSettings/CustomizationSettings.php

@@ -25,6 +25,7 @@ namespace App\Settings\SystemSettings;
 
 use App\Form\Type\RichTextEditorType;
 use App\Form\Type\ThemeChoiceType;
+use App\Settings\SettingsIcon;
 use App\Validator\Constraints\ValidTheme;
 use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
 use Jbtronics\SettingsBundle\Settings\Settings;
@@ -33,6 +34,7 @@ use Jbtronics\SettingsBundle\Settings\SettingsTrait;
 use Symfony\Component\Translation\TranslatableMessage as TM;
 
 #[Settings(name: "customization", label: new TM("settings.system.customization"))]
+#[SettingsIcon("fa-paint-roller")]
 class CustomizationSettings
 {
     use SettingsTrait;

src/Settings/SystemSettings/HistorySettings.php

@@ -25,6 +25,7 @@ namespace App\Settings\SystemSettings;
 
 use App\Form\History\EnforceEventCommentTypesType;
 use App\Services\LogSystem\EventCommentType;
+use App\Settings\SettingsIcon;
 use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
 use Jbtronics\SettingsBundle\ParameterTypes\ArrayType;
 use Jbtronics\SettingsBundle\ParameterTypes\EnumType;
@@ -34,6 +35,7 @@ use Jbtronics\SettingsBundle\Settings\SettingsTrait;
 use Symfony\Component\Translation\TranslatableMessage as TM;
 
 #[Settings(label: new TM("settings.system.history"))]
+#[SettingsIcon("fa-binoculars")]
 class HistorySettings
 {
     use SettingsTrait;

src/Settings/SystemSettings/LocalizationSettings.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace App\Settings\SystemSettings;
 
 use App\Form\Type\LocaleSelectType;
+use App\Settings\SettingsIcon;
 use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
 use Jbtronics\SettingsBundle\Settings\Settings;
 use Jbtronics\SettingsBundle\Settings\SettingsParameter;
@@ -34,6 +35,7 @@ use Symfony\Component\Translation\TranslatableMessage as TM;
 use Symfony\Component\Validator\Constraints as Assert;
 
 #[Settings(label: new TM("settings.system.localization"))]
+#[SettingsIcon("fa-globe")]
 class LocalizationSettings
 {
     use SettingsTrait;

src/Settings/SystemSettings/PrivacySettings.php

@@ -23,6 +23,7 @@ declare(strict_types=1);
 
 namespace App\Settings\SystemSettings;
 
+use App\Settings\SettingsIcon;
 use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
 use Jbtronics\SettingsBundle\Settings\Settings;
 use Jbtronics\SettingsBundle\Settings\SettingsParameter;
@@ -30,6 +31,7 @@ use Jbtronics\SettingsBundle\Settings\SettingsTrait;
 use Symfony\Component\Translation\TranslatableMessage as TM;
 
 #[Settings(label: new TM("settings.system.privacy"))]
+#[SettingsIcon("fa-location-pin-lock")]
 class PrivacySettings
 {
     use SettingsTrait;
@@ -48,5 +50,4 @@ class PrivacySettings
         description: new TM("settings.system.privacy.useGravatar.description"),
         envVar: 'bool:USE_GRAVATAR', envVarMode: EnvVarMode::OVERWRITE)]
     public bool $useGravatar = false;
-
 }

src/Twig/MiscExtension.php

@@ -23,6 +23,8 @@ declare(strict_types=1);
 namespace App\Twig;
 
 use App\Services\LogSystem\EventCommentType;
+use Jbtronics\SettingsBundle\Proxy\SettingsProxyInterface;
+use ReflectionClass;
 use Twig\TwigFunction;
 use App\Services\LogSystem\EventCommentNeededHelper;
 use Twig\Extension\AbstractExtension;
@@ -37,6 +39,8 @@ final class MiscExtension extends AbstractExtension
     {
         return [
             new TwigFunction('event_comment_needed', $this->evenCommentNeeded(...)),
+
+            new TwigFunction('settings_icon', $this->settingsIcon(...)),
         ];
     }
 
@@ -48,4 +52,25 @@ final class MiscExtension extends AbstractExtension
 
         return $this->eventCommentNeededHelper->isCommentNeeded($operation_type);
     }
+
+    /**
+     * Returns the value of the icon attribute of the SettingsIcon attribute of the given class.
+     * If the class does not have a SettingsIcon attribute, then null is returned.
+     * @param  string|object  $objectOrClass
+     * @return string|null
+     * @throws \ReflectionException
+     */
+    private function settingsIcon(string|object $objectOrClass): ?string
+    {
+        //If the given object is a proxy, then get the real object
+        if (is_a($objectOrClass, SettingsProxyInterface::class)) {
+            $objectOrClass = get_parent_class($objectOrClass);
+        }
+
+        $reflection = new ReflectionClass($objectOrClass);
+
+        $attribute = $reflection->getAttributes(\App\Settings\SettingsIcon::class)[0] ?? null;
+
+        return $attribute?->newInstance()->icon;
+    }
 }

templates/settings/settings.html.twig

@@ -32,9 +32,12 @@
                     {{ form_errors(tab_widget) }}
 
                     {% for section_widget in tab_widget %}
+                        {% set settings_object = section_widget.vars.value %}
+
                         {% if section_widget.vars.compound ?? false %}
                             <fieldset>
-                                <legend>
+                                <legend class="offset-3">
+                                    <i class="fa-solid {{ settings_icon(settings_object)|default('fa-sliders') }} fa-fw"></i>
                                     {{ (section_widget.vars.label ?? section_widget.vars.name|humanize)|trans }}
                                 </legend>
                                 {{ form_help(section_widget) }}
@@ -42,7 +45,7 @@
                                 {{ form_widget(section_widget) }}
                             </fieldset>
                             {% if not loop.last %}
-                                <hr class="m-0">
+                                <hr class="mx-0 mb-2 mt-2">
                             {% endif %}
                         {% else %} {# If not a compound render as normal row #}
                             {{ form_row(section_widget) }}