Allow to customize which items get shown on the homepage and in which order

This fixes issue #470 and #894
This commit is contained in:
Jan Böhmer 2025-09-07 19:27:02 +02:00
parent 617ae03b48
commit 4b00697f02
4 changed files with 117 additions and 17 deletions

View file

@ -28,10 +28,13 @@ use App\Form\Type\ThemeChoiceType;
use App\Settings\SettingsIcon;
use App\Validator\Constraints\ValidTheme;
use Jbtronics\SettingsBundle\Metadata\EnvVarMode;
use Jbtronics\SettingsBundle\ParameterTypes\ArrayType;
use Jbtronics\SettingsBundle\ParameterTypes\EnumType;
use Jbtronics\SettingsBundle\Settings\Settings;
use Jbtronics\SettingsBundle\Settings\SettingsParameter;
use Jbtronics\SettingsBundle\Settings\SettingsTrait;
use Symfony\Component\Translation\TranslatableMessage as TM;
use Symfony\Component\Validator\Constraints as Assert;
#[Settings(name: "customization", label: new TM("settings.system.customization"))]
#[SettingsIcon("fa-paint-roller")]
@ -46,6 +49,13 @@ class CustomizationSettings
)]
public string $instanceName = "Part-DB";
#[SettingsParameter(
label: new TM("settings.system.customization.theme"),
formType: ThemeChoiceType::class, formOptions: ['placeholder' => false]
)]
#[ValidTheme]
public string $theme = 'bootstrap';
#[SettingsParameter(
label: new TM("settings.system.customization.banner"),
formType: RichTextEditorType::class, formOptions: ['mode' => 'markdown-full'],
@ -53,10 +63,17 @@ class CustomizationSettings
)]
public ?string $banner = null;
#[SettingsParameter(
label: new TM("settings.system.customization.theme"),
formType: ThemeChoiceType::class, formOptions: ['placeholder' => false]
/**
* @var HomepageItems[] The items to show in the sidebar.
*/
#[SettingsParameter(ArrayType::class,
label: new TM("settings.behavior.hompepage.items"),
description: new TM("settings.behavior.homepage.items.help"),
options: ['type' => EnumType::class, 'options' => ['class' => HomepageItems::class]],
formType: \Symfony\Component\Form\Extension\Core\Type\EnumType::class,
formOptions: ['class' => HomepageItems::class, 'multiple' => true, 'ordered' => true]
)]
#[ValidTheme]
public string $theme = 'bootstrap';
#[Assert\NotBlank()]
#[Assert\Unique()]
public array $homepageitems = [HomepageItems::SEARCH, HomepageItems::BANNER, HomepageItems::FIRST_STEPS, HomepageItems::LICENSE, HomepageItems::LAST_ACTIVITY];
}

View file

@ -0,0 +1,51 @@
<?php
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2025 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\SystemSettings;
use Symfony\Contracts\Translation\TranslatableInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
use function Symfony\Component\Translation\t;
enum HomepageItems: string implements TranslatableInterface
{
case SEARCH = 'search';
case BANNER = 'banner';
case LICENSE = 'license';
case FIRST_STEPS = 'first_steps';
case LAST_ACTIVITY = 'last_activity';
public function trans(TranslatorInterface $translator, ?string $locale = null): string
{
$key = match($this) {
self::SEARCH => 'search.placeholder',
self::BANNER => 'settings.system.customization.banner',
self::LICENSE => 'homepage.license',
self::FIRST_STEPS => 'homepage.first_steps.title',
self::LAST_ACTIVITY => 'homepage.last_activity',
};
return $translator->trans($key, locale: $locale);
}
}