Moved part table default column definiton to settings UI

This commit is contained in:
Jan Böhmer 2024-08-21 22:02:56 +02:00
parent a45bf22ac5
commit 0dbf417866
10 changed files with 176 additions and 16 deletions

View file

@ -34,4 +34,7 @@ class BehaviorSettings
#[EmbeddedSettings]
public ?SidebarSettings $sidebar = null;
#[EmbeddedSettings]
public ?TableSettings $table = null;
}

View file

@ -0,0 +1,66 @@
<?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\BehaviorSettings;
use Symfony\Contracts\Translation\TranslatableInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
enum PartTableColumns : string implements TranslatableInterface
{
case NAME = "name";
case ID = "id";
case IPN = "ipn";
case DESCRIPTION = "description";
case CATEGORY = "category";
case FOOTPRINT = "footprint";
case MANUFACTURER = "manufacturer";
case LOCATION = "storage_location";
case AMOUNT = "amount";
case MIN_AMOUNT = "minamount";
case PART_UNIT = "partUnit";
case ADDED_DATE = "addedDate";
case LAST_MODIFIED = "lastModified";
case NEEDS_REVIEW = "needs_review";
case FAVORITE = "favorite";
case MANUFACTURING_STATUS = "manufacturing_status";
case MPN = "manufacturer_product_number";
case MASS = "mass";
case TAGS = "tags";
case ATTACHMENTS = "attachments";
case EDIT = "edit";
public function trans(TranslatorInterface $translator, ?string $locale = null): string
{
$key = match($this) {
self::LOCATION => 'part.table.storeLocations',
self::NEEDS_REVIEW => 'part.table.needsReview',
self::MANUFACTURING_STATUS => 'part.table.manufacturingStatus',
self::MPN => 'part.table.mpn',
default => 'part.table.' . $this->value,
};
return $translator->trans($key, locale: $locale);
}
}

View file

@ -50,6 +50,7 @@ class SidebarSettings
formOptions: ['class' => SidebarItems::class, 'multiple' => true, 'ordered' => true]
)]
#[Assert\NotBlank()]
#[Assert\Unique()]
public array $items = [SidebarItems::CATEGORIES, SidebarItems::PROJECTS, SidebarItems::TOOLS];
/**

View file

@ -0,0 +1,90 @@
<?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\BehaviorSettings;
use App\Settings\SettingsIcon;
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(label: new TM("settings.behavior.table"))]
#[SettingsIcon('fa-table')]
class TableSettings
{
use SettingsTrait;
#[SettingsParameter(
label: new TM("settings.behavior.table.default_page_size"),
description: new TM("settings.behavior.table.default_page_size.help"),
envVar: "int:TABLE_DEFAULT_PAGE_SIZE",
envVarMode: EnvVarMode::OVERWRITE,
)]
#[Assert\AtLeastOneOf(constraints:
[
new Assert\Positive(),
new Assert\EqualTo(value: -1)
]
)]
public int $fullDefaultPageSize = 50;
/** @var PartTableColumns[] */
#[SettingsParameter(ArrayType::class,
label: new TM("settings.behavior.table.parts_default_columns"),
description: new TM("settings.behavior.table.parts_default_columns.help"),
options: ['type' => EnumType::class, 'options' => ['class' => PartTableColumns::class]],
formType: \Symfony\Component\Form\Extension\Core\Type\EnumType::class,
formOptions: ['class' => PartTableColumns::class, 'multiple' => true, 'ordered' => true],
envVar: "TABLE_PARTS_DEFAULT_COLUMNS", envVarMode: EnvVarMode::OVERWRITE, envVarMapper: [self::class, 'mapPartsDefaultColumnsEnv']
)]
#[Assert\NotBlank()]
#[Assert\Unique()]
#[Assert\All([new Assert\Type(PartTableColumns::class)])]
public array $partsDefaultColumns = [PartTableColumns::NAME, PartTableColumns::DESCRIPTION,
PartTableColumns::CATEGORY, PartTableColumns::FOOTPRINT, PartTableColumns::MANUFACTURER,
PartTableColumns::LOCATION, PartTableColumns::AMOUNT];
public static function mapPartsDefaultColumnsEnv(string $columns): array
{
$exploded = explode(',', $columns);
$ret = [];
foreach ($exploded as $column) {
$enum = PartTableColumns::tryFrom($column);
if (!$enum) {
throw new \InvalidArgumentException("Invalid column '$column' in TABLE_PARTS_DEFAULT_COLUMNS");
}
$ret[] = $enum;
}
return $ret;
}
}