Added custom part status (#1053)

* Benutzerdefinierten Bauteilstatus einführen

* PartCustomStateController hinzufügen

* Umstellung Migrationen bzgl. Multi-Plattform-Support.
Zunächst MySQL, SQLite Statements integrieren.

* Postgre Statements integrieren

* Semikolon in Migration entfernen

* Migration für PartCustomState aktualisieren

* Benutzerdefinierten Bauteilstatus in TableSettings aufnehmen

* PartCustomStateControllerTest: Attribute für PHPUnit-Gruppen umgestellt

* PartCustomState: Mapping für Parameter korrigieren

* PartCustomState: Darstellung und Zuordnung von Anhängen ergänzt

Die Sidebar wurde um die Anzeige des benutzerdefinierten Bauteilstatus erweitert, inklusive Vorschaubild, sofern vorhanden.

* Migrationen zusammenführen

* PartCustomState: Anpassungen bzgl. Tests

* PartCustomStateEndpoint hinzufügen

* Made custom part states plural for consistency with other entity captions

* Fixed phpunit error

* Fixed phpstan issues

---------

Co-authored-by: Marcel Diegelmann <marcel.diegelmann@gmail.com>
Co-authored-by: Jan Böhmer <mail@jan-boehmer.de>

src/Services/Attachments/AttachmentSubmitHandler.php

@@ -30,6 +30,7 @@ use App\Entity\Attachments\AttachmentUpload;
 use App\Entity\Attachments\CategoryAttachment;
 use App\Entity\Attachments\CurrencyAttachment;
 use App\Entity\Attachments\LabelAttachment;
+use App\Entity\Attachments\PartCustomStateAttachment;
 use App\Entity\Attachments\ProjectAttachment;
 use App\Entity\Attachments\FootprintAttachment;
 use App\Entity\Attachments\GroupAttachment;
@@ -80,6 +81,7 @@ class AttachmentSubmitHandler
         //The mapping used to determine which folder will be used for an attachment type
         $this->folder_mapping = [
             PartAttachment::class => 'part',
+            PartCustomStateAttachment::class => 'part_custom_state',
             AttachmentTypeAttachment::class => 'attachment_type',
             CategoryAttachment::class => 'category',
             CurrencyAttachment::class => 'currency',

src/Services/Attachments/PartPreviewGenerator.php

@@ -23,6 +23,7 @@ declare(strict_types=1);
 namespace App\Services\Attachments;
 
 use App\Entity\Parts\Footprint;
+use App\Entity\Parts\PartCustomState;
 use App\Entity\ProjectSystem\Project;
 use App\Entity\Parts\Category;
 use App\Entity\Parts\StorageLocation;

src/Services/EDA/KiCadHelper.php

@@ -233,6 +233,10 @@ class KiCadHelper
             }
             $result["fields"]["Part-DB Unit"] = $this->createField($unit);
         }
+        if ($part->getPartCustomState() !== null) {
+            $customState = $part->getPartCustomState()->getName();
+            $result["fields"]["Part-DB Custom state"] = $this->createField($customState);
+        }
         if ($part->getMass()) {
             $result["fields"]["Mass"] = $this->createField($part->getMass() . ' g');
         }

src/Services/ElementTypeNameGenerator.php

@@ -37,6 +37,7 @@ use App\Entity\Parts\Manufacturer;
 use App\Entity\Parts\MeasurementUnit;
 use App\Entity\Parts\Part;
 use App\Entity\Parts\PartAssociation;
+use App\Entity\Parts\PartCustomState;
 use App\Entity\Parts\PartLot;
 use App\Entity\Parts\StorageLocation;
 use App\Entity\Parts\Supplier;
@@ -83,6 +84,7 @@ class ElementTypeNameGenerator
             PartAssociation::class => $this->translator->trans('part_association.label'),
             BulkInfoProviderImportJob::class => $this->translator->trans('bulk_info_provider_import_job.label'),
             BulkInfoProviderImportJobPart::class => $this->translator->trans('bulk_info_provider_import_job_part.label'),
+            PartCustomState::class => $this->translator->trans('part_custom_state.label'),
         ];
     }
 

src/Services/EntityMergers/Mergers/PartMerger.php

@@ -65,6 +65,7 @@ class PartMerger implements EntityMergerInterface
         $this->useOtherValueIfNotNull($target, $other, 'footprint');
         $this->useOtherValueIfNotNull($target, $other, 'category');
         $this->useOtherValueIfNotNull($target, $other, 'partUnit');
+        $this->useOtherValueIfNotNull($target, $other, 'partCustomState');
 
         //We assume that the higher value is the correct one for minimum instock
         $this->useLargerValue($target, $other, 'minamount');

src/Services/EntityURLGenerator.php

@@ -27,6 +27,7 @@ use App\Entity\Attachments\AttachmentType;
 use App\Entity\Attachments\PartAttachment;
 use App\Entity\Base\AbstractDBElement;
 use App\Entity\Parameters\PartParameter;
+use App\Entity\Parts\PartCustomState;
 use App\Entity\ProjectSystem\Project;
 use App\Entity\LabelSystem\LabelProfile;
 use App\Entity\Parts\Category;
@@ -107,6 +108,7 @@ class EntityURLGenerator
             MeasurementUnit::class => 'measurement_unit_edit',
             Group::class => 'group_edit',
             LabelProfile::class => 'label_profile_edit',
+            PartCustomState::class => 'part_custom_state_edit',
         ];
 
         try {
@@ -213,6 +215,7 @@ class EntityURLGenerator
             MeasurementUnit::class => 'measurement_unit_edit',
             Group::class => 'group_edit',
             LabelProfile::class => 'label_profile_edit',
+            PartCustomState::class => 'part_custom_state_edit',
         ];
 
         return $this->urlGenerator->generate($this->mapToController($map, $entity), ['id' => $entity->getID()]);
@@ -243,6 +246,7 @@ class EntityURLGenerator
             MeasurementUnit::class => 'measurement_unit_edit',
             Group::class => 'group_edit',
             LabelProfile::class => 'label_profile_edit',
+            PartCustomState::class => 'part_custom_state_edit',
         ];
 
         return $this->urlGenerator->generate($this->mapToController($map, $entity), ['id' => $entity->getID()]);
@@ -274,6 +278,7 @@ class EntityURLGenerator
             MeasurementUnit::class => 'measurement_unit_new',
             Group::class => 'group_new',
             LabelProfile::class => 'label_profile_new',
+            PartCustomState::class => 'part_custom_state_new',
         ];
 
         return $this->urlGenerator->generate($this->mapToController($map, $entity));
@@ -305,6 +310,7 @@ class EntityURLGenerator
             MeasurementUnit::class => 'measurement_unit_clone',
             Group::class => 'group_clone',
             LabelProfile::class => 'label_profile_clone',
+            PartCustomState::class => 'part_custom_state_clone',
         ];
 
         return $this->urlGenerator->generate($this->mapToController($map, $entity), ['id' => $entity->getID()]);
@@ -350,6 +356,7 @@ class EntityURLGenerator
             MeasurementUnit::class => 'measurement_unit_delete',
             Group::class => 'group_delete',
             LabelProfile::class => 'label_profile_delete',
+            PartCustomState::class => 'part_custom_state_delete',
         ];
 
         return $this->urlGenerator->generate($this->mapToController($map, $entity), ['id' => $entity->getID()]);

src/Services/ImportExportSystem/PartKeeprImporter/PKDatastructureImporter.php

@@ -29,6 +29,7 @@ use App\Entity\Parts\Category;
 use App\Entity\Parts\Footprint;
 use App\Entity\Parts\Manufacturer;
 use App\Entity\Parts\MeasurementUnit;
+use App\Entity\Parts\PartCustomState;
 use App\Entity\Parts\StorageLocation;
 use App\Entity\Parts\Supplier;
 use Doctrine\ORM\EntityManagerInterface;
@@ -148,6 +149,26 @@ class PKDatastructureImporter
         return is_countable($partunit_data) ? count($partunit_data) : 0;
     }
 
+    public function importPartCustomStates(array $data): int
+    {
+        if (!isset($data['partcustomstate'])) {
+            throw new \RuntimeException('$data must contain a "partcustomstate" key!');
+        }
+
+        $partCustomStateData = $data['partcustomstate'];
+        foreach ($partCustomStateData as $partCustomState) {
+            $customState = new PartCustomState();
+            $customState->setName($partCustomState['name']);
+
+            $this->setIDOfEntity($customState, $partCustomState['id']);
+            $this->em->persist($customState);
+        }
+
+        $this->em->flush();
+
+        return is_countable($partCustomStateData) ? count($partCustomStateData) : 0;
+    }
+
     public function importCategories(array $data): int
     {
         if (!isset($data['partcategory'])) {

src/Services/ImportExportSystem/PartKeeprImporter/PKPartImporter.php

@@ -91,6 +91,8 @@ class PKPartImporter
                     $this->setAssociationField($entity, 'partUnit', MeasurementUnit::class, $part['partUnit_id']);
                 }
 
+                $this->setAssociationField($entity, 'partCustomState', MeasurementUnit::class, $part['partCustomState_id']);
+
                 //Create a part lot to store the stock level and location
                 $lot = new PartLot();
                 $lot->setAmount((float) ($part['stockLevel'] ?? 0));

src/Services/LabelSystem/SandboxedTwigFactory.php

@@ -133,7 +133,7 @@ final class SandboxedTwigFactory
         Supplier::class => ['getShippingCosts', 'getDefaultCurrency'],
         Part::class => ['isNeedsReview', 'getTags', 'getMass', 'getIpn', 'getProviderReference',
             'getDescription', 'getComment', 'isFavorite', 'getCategory', 'getFootprint',
-            'getPartLots', 'getPartUnit', 'useFloatAmount', 'getMinAmount', 'getAmountSum', 'isNotEnoughInstock', 'isAmountUnknown', 'getExpiredAmountSum',
+            'getPartLots', 'getPartUnit', 'getPartCustomState', 'useFloatAmount', 'getMinAmount', 'getAmountSum', 'isNotEnoughInstock', 'isAmountUnknown', 'getExpiredAmountSum',
             'getManufacturerProductUrl', 'getCustomProductURL', 'getManufacturingStatus', 'getManufacturer',
             'getManufacturerProductNumber', 'getOrderdetails', 'isObsolete',
             'getParameters', 'getGroupedParameters',

src/Services/Trees/ToolsTreeBuilder.php

@@ -29,6 +29,7 @@ use App\Entity\Parts\Footprint;
 use App\Entity\Parts\Manufacturer;
 use App\Entity\Parts\MeasurementUnit;
 use App\Entity\Parts\Part;
+use App\Entity\Parts\PartCustomState;
 use App\Entity\Parts\StorageLocation;
 use App\Entity\Parts\Supplier;
 use App\Entity\PriceInformations\Currency;
@@ -217,6 +218,12 @@ class ToolsTreeBuilder
                 $this->urlGenerator->generate('label_profile_new')
             ))->setIcon('fa-fw fa-treeview fa-solid fa-qrcode');
         }
+        if ($this->security->isGranted('read', new PartCustomState())) {
+            $nodes[] = (new TreeViewNode(
+                $this->translator->trans('tree.tools.edit.part_custom_state'),
+                $this->urlGenerator->generate('part_custom_state_new')
+            ))->setIcon('fa-fw fa-treeview fa-solid fa-tools');
+        }
         if ($this->security->isGranted('create', new Part())) {
             $nodes[] = (new TreeViewNode(
                 $this->translator->trans('tree.tools.edit.part'),

src/Services/UserSystem/PermissionPresetsHelper.php

@@ -102,6 +102,7 @@ class PermissionPresetsHelper
         $this->permissionResolver->setAllOperationsOfPermission($perm_holder, 'attachment_types', PermissionData::ALLOW);
         $this->permissionResolver->setAllOperationsOfPermission($perm_holder, 'currencies', PermissionData::ALLOW);
         $this->permissionResolver->setAllOperationsOfPermission($perm_holder, 'measurement_units', PermissionData::ALLOW);
+        $this->permissionResolver->setAllOperationsOfPermission($perm_holder, 'part_custom_states', PermissionData::ALLOW);
         $this->permissionResolver->setAllOperationsOfPermission($perm_holder, 'suppliers', PermissionData::ALLOW);
         $this->permissionResolver->setAllOperationsOfPermission($perm_holder, 'projects', PermissionData::ALLOW);
 
@@ -131,6 +132,7 @@ class PermissionPresetsHelper
         $this->permissionResolver->setAllOperationsOfPermissionExcept($permHolder, 'attachment_types', PermissionData::ALLOW, ['import']);
         $this->permissionResolver->setAllOperationsOfPermissionExcept($permHolder, 'currencies', PermissionData::ALLOW, ['import']);
         $this->permissionResolver->setAllOperationsOfPermissionExcept($permHolder, 'measurement_units', PermissionData::ALLOW, ['import']);
+        $this->permissionResolver->setAllOperationsOfPermissionExcept($permHolder, 'part_custom_states', PermissionData::ALLOW, ['import']);
         $this->permissionResolver->setAllOperationsOfPermissionExcept($permHolder, 'suppliers', PermissionData::ALLOW, ['import']);
         $this->permissionResolver->setAllOperationsOfPermissionExcept($permHolder, 'projects', PermissionData::ALLOW, ['import']);