From 0447a7e6b3f6b9958ac5a7084d14381ad96ef035 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Sun, 12 Nov 2023 21:53:45 +0100 Subject: [PATCH 01/20] Added basic data structures for part associations --- src/Entity/Parts/Part.php | 13 ++ src/Entity/Parts/PartAssociation.php | 117 ++++++++++++++++++ src/Entity/Parts/PartAssociationType.php | 37 ++++++ .../Parts/PartTraits/AssociationTrait.php | 92 ++++++++++++++ 4 files changed, 259 insertions(+) create mode 100644 src/Entity/Parts/PartAssociation.php create mode 100644 src/Entity/Parts/PartAssociationType.php create mode 100644 src/Entity/Parts/PartTraits/AssociationTrait.php diff --git a/src/Entity/Parts/Part.php b/src/Entity/Parts/Part.php index fa01d212..9f7cda95 100644 --- a/src/Entity/Parts/Part.php +++ b/src/Entity/Parts/Part.php @@ -41,6 +41,7 @@ use App\ApiPlatform\Filter\EntityFilter; use App\ApiPlatform\Filter\LikeFilter; use App\ApiPlatform\Filter\PartStoragelocationFilter; use App\Entity\Attachments\AttachmentTypeAttachment; +use App\Entity\Parts\PartTraits\AssociationTrait; use App\Repository\PartRepository; use Doctrine\DBAL\Types\Types; use App\Entity\Attachments\Attachment; @@ -58,6 +59,7 @@ use DateTime; use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; use Doctrine\ORM\Mapping as ORM; +use Jfcherng\Diff\Utility\Arr; use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity; use Symfony\Component\Serializer\Annotation\Groups; use Symfony\Component\Validator\Constraints as Assert; @@ -112,6 +114,7 @@ class Part extends AttachmentContainingDBElement use OrderTrait; use ParametersTrait; use ProjectTrait; + use AssociationTrait; /** @var Collection */ @@ -165,6 +168,9 @@ class Part extends AttachmentContainingDBElement $this->parameters = new ArrayCollection(); $this->project_bom_entries = new ArrayCollection(); + $this->associated_parts_as_owner = new ArrayCollection(); + $this->associated_parts_as_other = new ArrayCollection(); + //By default, the part has no provider $this->providerReference = InfoProviderReference::noProvider(); } @@ -193,6 +199,13 @@ class Part extends AttachmentContainingDBElement $this->addParameter(clone $parameter); } + //Deep clone the owned part associations (the owned ones make not much sense without the owner) + $ownedAssociations = $this->associated_parts_as_owner; + $this->associated_parts_as_owner = new ArrayCollection(); + foreach ($ownedAssociations as $association) { + $this->addAssociatedPartsAsOwner(clone $association); + } + //Deep clone info provider $this->providerReference = clone $this->providerReference; } diff --git a/src/Entity/Parts/PartAssociation.php b/src/Entity/Parts/PartAssociation.php new file mode 100644 index 00000000..1fc0530d --- /dev/null +++ b/src/Entity/Parts/PartAssociation.php @@ -0,0 +1,117 @@ +. + */ + +declare(strict_types=1); + + +namespace App\Entity\Parts; + +use App\Repository\DBElementRepository; +use Doctrine\DBAL\Types\Types; +use Doctrine\ORM\Mapping as ORM; +use App\Entity\Base\AbstractDBElement; +use App\Entity\Base\TimestampTrait; +use Symfony\Component\Validator\Constraints as Assert; + +/** + * This entity describes a part association, which is a semantic connection between two parts. + * For example, a part association can be used to describe that a part is a replacement for another part. + */ +#[ORM\Entity(repositoryClass: DBElementRepository::class)] +#[ORM\HasLifecycleCallbacks] +class PartAssociation extends AbstractDBElement +{ + use TimestampTrait; + + /** + * @var PartAssociationType The type of this association (how the two parts are related) + */ + #[ORM\Column(type: Types::SMALLINT, enumType: PartAssociationType::class)] + protected PartAssociationType $type = PartAssociationType::OTHER; + + /** + * @var string|null A comment describing this association further. Can also be used to specify the OTHER type + * further. + */ + #[ORM\Column(type: Types::TEXT, nullable: true)] + protected ?string $comment = null; + + /** + * @var Part|null The part which "owns" this association, e.g. the part which is a replacement for another part + */ + #[ORM\ManyToOne(targetEntity: Part::class, inversedBy: 'associated_parts_as_owner')] + #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')] + #[Assert\NotNull] + protected ?Part $owner = null; + + /** + * @var Part|null The part which is "owned" by this association, e.g. the part which is replaced by another part + */ + #[ORM\ManyToOne(targetEntity: Part::class, inversedBy: 'associated_parts_as_other')] + #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')] + #[Assert\NotNull] + protected ?Part $other = null; + + public function getType(): PartAssociationType + { + return $this->type; + } + + public function setType(PartAssociationType $type): PartAssociation + { + $this->type = $type; + return $this; + } + + public function getComment(): ?string + { + return $this->comment; + } + + public function setComment(?string $comment): PartAssociation + { + $this->comment = $comment; + return $this; + } + + public function getOwner(): ?Part + { + return $this->owner; + } + + public function setOwner(?Part $owner): PartAssociation + { + $this->owner = $owner; + return $this; + } + + public function getOther(): ?Part + { + return $this->other; + } + + public function setOther(?Part $other): PartAssociation + { + $this->other = $other; + return $this; + } + + +} \ No newline at end of file diff --git a/src/Entity/Parts/PartAssociationType.php b/src/Entity/Parts/PartAssociationType.php new file mode 100644 index 00000000..d9320288 --- /dev/null +++ b/src/Entity/Parts/PartAssociationType.php @@ -0,0 +1,37 @@ +. + */ + +declare(strict_types=1); + + +namespace App\Entity\Parts; + +/** + * The values of this enums are used to describe how two parts are associated with each other. + */ +enum PartAssociationType: int +{ + /** A user definable association type, which can be described in the comment field */ + case OTHER = 0; + /** The owning part is compatible with the other part */ + case COMPATIBLE = 1; + /** The owning part supersedes the other part (owner is newer version) */ + case SUPERSEDES = 2; +} diff --git a/src/Entity/Parts/PartTraits/AssociationTrait.php b/src/Entity/Parts/PartTraits/AssociationTrait.php new file mode 100644 index 00000000..82c46f27 --- /dev/null +++ b/src/Entity/Parts/PartTraits/AssociationTrait.php @@ -0,0 +1,92 @@ +. + */ + +declare(strict_types=1); + + +namespace App\Entity\Parts\PartTraits; + +use App\Entity\Parts\PartAssociation; +use Doctrine\Common\Collections\Collection; +use Symfony\Component\Validator\Constraints\Valid; +use Doctrine\ORM\Mapping as ORM; + +trait AssociationTrait +{ + /** + * @var Collection All associations where this part is the owner + */ + #[Valid] + #[ORM\OneToMany(mappedBy: 'owner', targetEntity: PartAssociation::class, + cascade: ['persist', 'remove'], orphanRemoval: true)] + protected Collection $associated_parts_as_owner; + + /** + * @var Collection All associations where this part is the owned/other part + */ + #[Valid] + #[ORM\OneToMany(mappedBy: 'other', targetEntity: PartAssociation::class, + cascade: ['persist', 'remove'], orphanRemoval: true)] + protected Collection $associated_parts_as_other; + + /** + * Returns all associations where this part is the owner. + * @return Collection + */ + public function getAssociatedPartsAsOwner(): Collection + { + return $this->associated_parts_as_owner; + } + + /** + * Add a new association where this part is the owner. + * @param PartAssociation $association + * @return $this + */ + public function addAssociatedPartsAsOwner(PartAssociation $association): self + { + //Ensure that the association is really owned by this part + $association->setOwner($this); + + $this->associated_parts_as_owner->add($association); + return $this; + } + + /** + * Remove an association where this part is the owner. + * @param PartAssociation $association + * @return $this + */ + public function removeAssociatedPartsAsOwner(PartAssociation $association): self + { + $this->associated_parts_as_owner->removeElement($association); + return $this; + } + + /** + * Returns all associations where this part is the owned/other part. + * If you want to modify the association, do it on the owning part + * @return Collection + */ + public function getAssociatedPartsAsOther(): Collection + { + return $this->associated_parts_as_other; + } +} \ No newline at end of file From b7cfdebad58aaecd54df85f46cba5048b3312ee5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Sun, 12 Nov 2023 22:06:05 +0100 Subject: [PATCH 02/20] Added data field for vendor PartLot barcodes --- src/Entity/Parts/PartLot.php | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/Entity/Parts/PartLot.php b/src/Entity/Parts/PartLot.php index 58fa2afb..fe683499 100644 --- a/src/Entity/Parts/PartLot.php +++ b/src/Entity/Parts/PartLot.php @@ -60,8 +60,9 @@ use Symfony\Component\Validator\Context\ExecutionContextInterface; #[ORM\Entity] #[ORM\HasLifecycleCallbacks] #[ORM\Table(name: 'part_lots')] -#[ORM\Index(name: 'part_lots_idx_instock_un_expiration_id_part', columns: ['instock_unknown', 'expiration_date', 'id_part'])] -#[ORM\Index(name: 'part_lots_idx_needs_refill', columns: ['needs_refill'])] +#[ORM\Index(columns: ['instock_unknown', 'expiration_date', 'id_part'], name: 'part_lots_idx_instock_un_expiration_id_part')] +#[ORM\Index(columns: ['needs_refill'], name: 'part_lots_idx_needs_refill')] +#[ORM\Index(columns: ['vendor_barcode'], name: 'part_lots_idx_barcode')] #[ValidPartLot] #[ApiResource( operations: [ @@ -154,6 +155,12 @@ class PartLot extends AbstractDBElement implements TimeStampableInterface, Named #[Groups(['part_lot:read', 'part_lot:write'])] protected ?User $owner = null; + /** + * @var string|null The content of the barcode of this part lot (e.g. a barcode on the package put by the vendor) + */ + #[ORM\Column(type: Types::STRING, nullable: true)] + protected ?string $vendor_barcode = null; + public function __clone() { if ($this->id) { From 8ab9cf14177c660908fd4c2d0229c6bece55cfd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Mon, 13 Nov 2023 00:11:58 +0100 Subject: [PATCH 03/20] Added very basic possibility to add an association --- migrations/Version20231112211329.php | 39 +++++++++++++ src/Entity/LogSystem/LogTargetType.php | 4 ++ ...ssociationType.php => AssociationType.php} | 2 +- src/Entity/Parts/PartAssociation.php | 10 ++-- src/Form/Part/PartAssociationType.php | 57 +++++++++++++++++++ src/Form/Part/PartBaseType.php | 10 ++++ .../parts/edit/_associated_parts.html.twig | 18 ++++++ templates/parts/edit/edit_part_info.html.twig | 9 +++ 8 files changed, 143 insertions(+), 6 deletions(-) create mode 100644 migrations/Version20231112211329.php rename src/Entity/Parts/{PartAssociationType.php => AssociationType.php} (97%) create mode 100644 src/Form/Part/PartAssociationType.php create mode 100644 templates/parts/edit/_associated_parts.html.twig diff --git a/migrations/Version20231112211329.php b/migrations/Version20231112211329.php new file mode 100644 index 00000000..8fa7409c --- /dev/null +++ b/migrations/Version20231112211329.php @@ -0,0 +1,39 @@ +addSql('CREATE TABLE part_association (id INT AUTO_INCREMENT NOT NULL, owner_id INT NOT NULL, other_id INT NOT NULL, type SMALLINT NOT NULL, comment LONGTEXT DEFAULT NULL, last_modified DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL, datetime_added DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL, INDEX IDX_61B952E07E3C61F9 (owner_id), INDEX IDX_61B952E0998D9879 (other_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB'); + $this->addSql('ALTER TABLE part_association ADD CONSTRAINT FK_61B952E07E3C61F9 FOREIGN KEY (owner_id) REFERENCES `parts` (id) ON DELETE CASCADE'); + $this->addSql('ALTER TABLE part_association ADD CONSTRAINT FK_61B952E0998D9879 FOREIGN KEY (other_id) REFERENCES `parts` (id) ON DELETE CASCADE'); + $this->addSql('ALTER TABLE part_lots ADD vendor_barcode VARCHAR(255) DEFAULT NULL'); + $this->addSql('CREATE INDEX part_lots_idx_barcode ON part_lots (vendor_barcode)'); + } + + public function down(Schema $schema): void + { + // this down() migration is auto-generated, please modify it to your needs + $this->addSql('ALTER TABLE part_association DROP FOREIGN KEY FK_61B952E07E3C61F9'); + $this->addSql('ALTER TABLE part_association DROP FOREIGN KEY FK_61B952E0998D9879'); + $this->addSql('DROP TABLE part_association'); + $this->addSql('DROP INDEX part_lots_idx_barcode ON part_lots'); + $this->addSql('ALTER TABLE part_lots DROP vendor_barcode'); + } +} diff --git a/src/Entity/LogSystem/LogTargetType.php b/src/Entity/LogSystem/LogTargetType.php index eb3346d8..6e413079 100644 --- a/src/Entity/LogSystem/LogTargetType.php +++ b/src/Entity/LogSystem/LogTargetType.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\PartAssociation; use App\Entity\Parts\PartLot; use App\Entity\Parts\StorageLocation; use App\Entity\Parts\Supplier; @@ -63,6 +64,8 @@ enum LogTargetType: int case PARAMETER = 18; case LABEL_PROFILE = 19; + case PART_ASSOCIATION = 20; + /** * Returns the class name of the target type or null if the target type is NONE. * @return string|null @@ -90,6 +93,7 @@ enum LogTargetType: int self::MEASUREMENT_UNIT => MeasurementUnit::class, self::PARAMETER => AbstractParameter::class, self::LABEL_PROFILE => LabelProfile::class, + self::PART_ASSOCIATION => PartAssociation::class, }; } diff --git a/src/Entity/Parts/PartAssociationType.php b/src/Entity/Parts/AssociationType.php similarity index 97% rename from src/Entity/Parts/PartAssociationType.php rename to src/Entity/Parts/AssociationType.php index d9320288..6980f600 100644 --- a/src/Entity/Parts/PartAssociationType.php +++ b/src/Entity/Parts/AssociationType.php @@ -26,7 +26,7 @@ namespace App\Entity\Parts; /** * The values of this enums are used to describe how two parts are associated with each other. */ -enum PartAssociationType: int +enum AssociationType: int { /** A user definable association type, which can be described in the comment field */ case OTHER = 0; diff --git a/src/Entity/Parts/PartAssociation.php b/src/Entity/Parts/PartAssociation.php index 1fc0530d..ae3e1271 100644 --- a/src/Entity/Parts/PartAssociation.php +++ b/src/Entity/Parts/PartAssociation.php @@ -41,10 +41,10 @@ class PartAssociation extends AbstractDBElement use TimestampTrait; /** - * @var PartAssociationType The type of this association (how the two parts are related) + * @var AssociationType The type of this association (how the two parts are related) */ - #[ORM\Column(type: Types::SMALLINT, enumType: PartAssociationType::class)] - protected PartAssociationType $type = PartAssociationType::OTHER; + #[ORM\Column(type: Types::SMALLINT, enumType: AssociationType::class)] + protected AssociationType $type = AssociationType::OTHER; /** * @var string|null A comment describing this association further. Can also be used to specify the OTHER type @@ -69,12 +69,12 @@ class PartAssociation extends AbstractDBElement #[Assert\NotNull] protected ?Part $other = null; - public function getType(): PartAssociationType + public function getType(): AssociationType { return $this->type; } - public function setType(PartAssociationType $type): PartAssociation + public function setType(AssociationType $type): PartAssociation { $this->type = $type; return $this; diff --git a/src/Form/Part/PartAssociationType.php b/src/Form/Part/PartAssociationType.php new file mode 100644 index 00000000..7163c257 --- /dev/null +++ b/src/Form/Part/PartAssociationType.php @@ -0,0 +1,57 @@ +. + */ + +declare(strict_types=1); + + +namespace App\Form\Part; + +use App\Entity\Parts\AssociationType; +use App\Entity\Parts\PartAssociation; +use App\Form\Type\PartSelectType; +use Symfony\Component\Form\AbstractType; +use Symfony\Component\Form\Extension\Core\Type\EnumType; +use Symfony\Component\Form\Extension\Core\Type\TextType; +use Symfony\Component\Form\FormBuilderInterface; +use Symfony\Component\OptionsResolver\OptionsResolver; + +class PartAssociationType extends AbstractType +{ + public function buildForm(FormBuilderInterface $builder, array $options): void + { + $builder + ->add('type', EnumType::class, [ + 'class' => AssociationType::class, + ]) + ->add('other', PartSelectType::class) + ->add('comment', TextType::class, [ + 'required' => false, + ]) + ; + + } + + public function configureOptions(OptionsResolver $resolver) + { + $resolver->setDefaults([ + 'data_class' => PartAssociation::class, + ]); + } +} \ No newline at end of file diff --git a/src/Form/Part/PartBaseType.php b/src/Form/Part/PartBaseType.php index b15ec29f..f7243e64 100644 --- a/src/Form/Part/PartBaseType.php +++ b/src/Form/Part/PartBaseType.php @@ -245,6 +245,16 @@ class PartBaseType extends AbstractType ], ]); + //Part associations + $builder->add('associated_parts_as_owner', CollectionType::class, [ + 'entry_type' => PartAssociationType::class, + 'allow_add' => true, + 'allow_delete' => true, + 'reindex_enable' => true, + 'label' => false, + 'by_reference' => false, + ]); + $builder->add('log_comment', TextType::class, [ 'label' => 'edit.log_comment', 'mapped' => false, diff --git a/templates/parts/edit/_associated_parts.html.twig b/templates/parts/edit/_associated_parts.html.twig new file mode 100644 index 00000000..beef96be --- /dev/null +++ b/templates/parts/edit/_associated_parts.html.twig @@ -0,0 +1,18 @@ +{% form_theme form with ['parts/edit/edit_form_styles.html.twig'] %} +{% import 'components/collection_type.macro.html.twig' as collection %} + +
+ + + {% for assoc in form.associated_parts_as_owner %} + {{ form_widget(assoc) }} + {% endfor %} + +
+ + +
\ No newline at end of file diff --git a/templates/parts/edit/edit_part_info.html.twig b/templates/parts/edit/edit_part_info.html.twig index 51b5d865..4dae8949 100644 --- a/templates/parts/edit/edit_part_info.html.twig +++ b/templates/parts/edit/edit_part_info.html.twig @@ -58,6 +58,12 @@ {% trans %}part.edit.tab.specifications{% endtrans %} +
  • + + + {% trans %}part.edit.tab.associations{% endtrans %} + +
  • @@ -90,6 +96,9 @@
    {% include "parts/edit/_specifications.html.twig" %}
    +
    + {% include "parts/edit/_associated_parts.html.twig" %} +
    {{ form_widget(form.comment)}}
    From 81f8b365e934c8a56150ebf51401b2369db5259f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Mon, 13 Nov 2023 23:01:59 +0100 Subject: [PATCH 04/20] Improved the association edit panel --- src/Entity/Parts/AssociationType.php | 9 +++++ src/Form/Part/PartAssociationType.php | 8 ++++- src/Services/ElementTypeNameGenerator.php | 2 ++ .../parts/edit/edit_form_styles.html.twig | 16 +++++++++ translations/messages.en.xlf | 36 +++++++++++++++++++ 5 files changed, 70 insertions(+), 1 deletion(-) diff --git a/src/Entity/Parts/AssociationType.php b/src/Entity/Parts/AssociationType.php index 6980f600..52a56af2 100644 --- a/src/Entity/Parts/AssociationType.php +++ b/src/Entity/Parts/AssociationType.php @@ -34,4 +34,13 @@ enum AssociationType: int case COMPATIBLE = 1; /** The owning part supersedes the other part (owner is newer version) */ case SUPERSEDES = 2; + + /** + * Returns the translation key for this association type. + * @return string + */ + public function getTranslationKey(): string + { + return 'part_association.type.' . strtolower($this->name); + } } diff --git a/src/Form/Part/PartAssociationType.php b/src/Form/Part/PartAssociationType.php index 7163c257..abd534fe 100644 --- a/src/Form/Part/PartAssociationType.php +++ b/src/Form/Part/PartAssociationType.php @@ -37,12 +37,18 @@ class PartAssociationType extends AbstractType public function buildForm(FormBuilderInterface $builder, array $options): void { $builder + ->add('other', PartSelectType::class, [ + 'label' => 'part_association.edit.other_part', + ]) ->add('type', EnumType::class, [ 'class' => AssociationType::class, + 'label' => 'part_association.edit.type', + 'choice_label' => fn(AssociationType $type) => $type->getTranslationKey(), + 'help' => 'part_association.edit.type.help', ]) - ->add('other', PartSelectType::class) ->add('comment', TextType::class, [ 'required' => false, + 'label' => 'part_association.edit.comment' ]) ; diff --git a/src/Services/ElementTypeNameGenerator.php b/src/Services/ElementTypeNameGenerator.php index b9653d13..96efa01e 100644 --- a/src/Services/ElementTypeNameGenerator.php +++ b/src/Services/ElementTypeNameGenerator.php @@ -28,6 +28,7 @@ use App\Entity\Attachments\AttachmentType; use App\Entity\Base\AbstractDBElement; use App\Entity\Base\AbstractNamedDBElement; use App\Entity\Contracts\NamedElementInterface; +use App\Entity\Parts\PartAssociation; use App\Entity\ProjectSystem\Project; use App\Entity\LabelSystem\LabelProfile; use App\Entity\Parameters\AbstractParameter; @@ -80,6 +81,7 @@ class ElementTypeNameGenerator User::class => $this->translator->trans('user.label'), AbstractParameter::class => $this->translator->trans('parameter.label'), LabelProfile::class => $this->translator->trans('label_profile.label'), + PartAssociation::class => $this->translator->trans('part_association.label'), ]; } diff --git a/templates/parts/edit/edit_form_styles.html.twig b/templates/parts/edit/edit_form_styles.html.twig index 7ff81b77..0f46a2ad 100644 --- a/templates/parts/edit/edit_form_styles.html.twig +++ b/templates/parts/edit/edit_form_styles.html.twig @@ -183,4 +183,20 @@ +{% endblock %} + +{% block part_association_widget %} + {% import 'components/collection_type.macro.html.twig' as collection %} + + + {{ form_widget(form) }} + + + + {{ form_errors(form) }} + + {% endblock %} \ No newline at end of file diff --git a/translations/messages.en.xlf b/translations/messages.en.xlf index a4d526a9..e3eadc4e 100644 --- a/translations/messages.en.xlf +++ b/translations/messages.en.xlf @@ -11831,5 +11831,41 @@ Please note, that you can not impersonate a disabled user. If you try you will g Part-DB barcode + + + part_association.label + Part association + + + + + part.edit.tab.associations + Associated parts + + + + + part_association.edit.other_part + Associated part + + + + + part_association.edit.type + Relation Type + + + + + part_association.edit.comment + Notes + + + + + part_association.edit.type.help + You can select here, how the chosen part is related to this part. + + From 5bd2d9b34441ed12440fb70e63caebd6d6096104 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Mon, 13 Nov 2023 23:05:25 +0100 Subject: [PATCH 05/20] Restrict size of part images, if the part selector element is very wide This improves UX --- assets/controllers/elements/part_select_controller.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/controllers/elements/part_select_controller.js b/assets/controllers/elements/part_select_controller.js index c7507636..5abd5ba3 100644 --- a/assets/controllers/elements/part_select_controller.js +++ b/assets/controllers/elements/part_select_controller.js @@ -27,7 +27,7 @@ export default class extends Controller { } let tmp = '
    ' + - "
    " + + "
    " + (data.image ? "" : "") + "
    " + "
    " + From c7892cb9e20358e8c5802cbdd31b1375e89c2fed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Tue, 14 Nov 2023 23:35:18 +0100 Subject: [PATCH 06/20] Added a seperate field for specifying the other relation --- ...12211329.php => Version20231114223101.php} | 4 ++-- src/Entity/Parts/PartAssociation.php | 21 +++++++++++++++++-- src/Form/Part/PartAssociationType.php | 3 +++ 3 files changed, 24 insertions(+), 4 deletions(-) rename migrations/{Version20231112211329.php => Version20231114223101.php} (77%) diff --git a/migrations/Version20231112211329.php b/migrations/Version20231114223101.php similarity index 77% rename from migrations/Version20231112211329.php rename to migrations/Version20231114223101.php index 8fa7409c..73c845bd 100644 --- a/migrations/Version20231112211329.php +++ b/migrations/Version20231114223101.php @@ -10,7 +10,7 @@ use Doctrine\Migrations\AbstractMigration; /** * Auto-generated Migration: Please modify to your needs! */ -final class Version20231112211329 extends AbstractMigration +final class Version20231114223101 extends AbstractMigration { public function getDescription(): string { @@ -20,7 +20,7 @@ final class Version20231112211329 extends AbstractMigration public function up(Schema $schema): void { // this up() migration is auto-generated, please modify it to your needs - $this->addSql('CREATE TABLE part_association (id INT AUTO_INCREMENT NOT NULL, owner_id INT NOT NULL, other_id INT NOT NULL, type SMALLINT NOT NULL, comment LONGTEXT DEFAULT NULL, last_modified DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL, datetime_added DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL, INDEX IDX_61B952E07E3C61F9 (owner_id), INDEX IDX_61B952E0998D9879 (other_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB'); + $this->addSql('CREATE TABLE part_association (id INT AUTO_INCREMENT NOT NULL, owner_id INT NOT NULL, other_id INT NOT NULL, type SMALLINT NOT NULL, other_type VARCHAR(255) DEFAULT NULL, comment LONGTEXT DEFAULT NULL, last_modified DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL, datetime_added DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL, INDEX IDX_61B952E07E3C61F9 (owner_id), INDEX IDX_61B952E0998D9879 (other_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB'); $this->addSql('ALTER TABLE part_association ADD CONSTRAINT FK_61B952E07E3C61F9 FOREIGN KEY (owner_id) REFERENCES `parts` (id) ON DELETE CASCADE'); $this->addSql('ALTER TABLE part_association ADD CONSTRAINT FK_61B952E0998D9879 FOREIGN KEY (other_id) REFERENCES `parts` (id) ON DELETE CASCADE'); $this->addSql('ALTER TABLE part_lots ADD vendor_barcode VARCHAR(255) DEFAULT NULL'); diff --git a/src/Entity/Parts/PartAssociation.php b/src/Entity/Parts/PartAssociation.php index ae3e1271..1c31bf43 100644 --- a/src/Entity/Parts/PartAssociation.php +++ b/src/Entity/Parts/PartAssociation.php @@ -47,8 +47,14 @@ class PartAssociation extends AbstractDBElement protected AssociationType $type = AssociationType::OTHER; /** - * @var string|null A comment describing this association further. Can also be used to specify the OTHER type - * further. + * @var string|null A user definable association type, which can be described in the comment field, which + * is used if the type is OTHER + */ + #[ORM\Column(type: Types::STRING, length: 255, nullable: true)] + protected ?string $other_type = null; + + /** + * @var string|null A comment describing this association further. */ #[ORM\Column(type: Types::TEXT, nullable: true)] protected ?string $comment = null; @@ -113,5 +119,16 @@ class PartAssociation extends AbstractDBElement return $this; } + public function getOtherType(): ?string + { + return $this->other_type; + } + + public function setOtherType(?string $other_type): PartAssociation + { + $this->other_type = $other_type; + return $this; + } + } \ No newline at end of file diff --git a/src/Form/Part/PartAssociationType.php b/src/Form/Part/PartAssociationType.php index abd534fe..cb5b526f 100644 --- a/src/Form/Part/PartAssociationType.php +++ b/src/Form/Part/PartAssociationType.php @@ -46,6 +46,9 @@ class PartAssociationType extends AbstractType 'choice_label' => fn(AssociationType $type) => $type->getTranslationKey(), 'help' => 'part_association.edit.type.help', ]) + ->add('other_type', TextType::class, [ + 'required' => false, + ]) ->add('comment', TextType::class, [ 'required' => false, 'label' => 'part_association.edit.comment' From cc2332a83ae21054fb93bbcab18946b7556a3566 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Tue, 14 Nov 2023 23:50:09 +0100 Subject: [PATCH 07/20] Added some constraints to ensure validity of the PartAssociation entities --- src/Entity/Parts/PartAssociation.php | 6 ++++++ translations/validators.en.xlf | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/src/Entity/Parts/PartAssociation.php b/src/Entity/Parts/PartAssociation.php index 1c31bf43..98becd9c 100644 --- a/src/Entity/Parts/PartAssociation.php +++ b/src/Entity/Parts/PartAssociation.php @@ -28,6 +28,7 @@ use Doctrine\DBAL\Types\Types; use Doctrine\ORM\Mapping as ORM; use App\Entity\Base\AbstractDBElement; use App\Entity\Base\TimestampTrait; +use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity; use Symfony\Component\Validator\Constraints as Assert; /** @@ -36,6 +37,7 @@ use Symfony\Component\Validator\Constraints as Assert; */ #[ORM\Entity(repositoryClass: DBElementRepository::class)] #[ORM\HasLifecycleCallbacks] +#[UniqueEntity(fields: ['other', 'owner', 'type'], message: 'validator.part_association.already_exists')] class PartAssociation extends AbstractDBElement { use TimestampTrait; @@ -51,6 +53,8 @@ class PartAssociation extends AbstractDBElement * is used if the type is OTHER */ #[ORM\Column(type: Types::STRING, length: 255, nullable: true)] + #[Assert\Expression("this.getType().value !== 0 or this.getOtherType() !== null", + message: 'validator.part_association.must_set_an_value_if_type_is_other')] protected ?string $other_type = null; /** @@ -73,6 +77,8 @@ class PartAssociation extends AbstractDBElement #[ORM\ManyToOne(targetEntity: Part::class, inversedBy: 'associated_parts_as_other')] #[ORM\JoinColumn(nullable: false, onDelete: 'CASCADE')] #[Assert\NotNull] + #[Assert\Expression("this.getOwner() !== this.getOther()", + message: 'validator.part_association.part_cannot_be_associated_with_itself')] protected ?Part $other = null; public function getType(): AssociationType diff --git a/translations/validators.en.xlf b/translations/validators.en.xlf index 1f3438de..19a69323 100644 --- a/translations/validators.en.xlf +++ b/translations/validators.en.xlf @@ -317,5 +317,23 @@ A lot owner must not be the anonymous user! + + + validator.part_association.must_set_an_value_if_type_is_other + If you set the type to "other", then you have to set a descriptive value for it! + + + + + validator.part_association.part_cannot_be_associated_with_itself + A part can not be associated with itself! + + + + + validator.part_association.already_exists + The association with this part already exists! + + From 7f612bc371c27d6b04a18d8a1036ba84aa5f4a8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Wed, 15 Nov 2023 00:44:45 +0100 Subject: [PATCH 08/20] Added ability to view part relations on a part info page --- config/packages/twig.yaml | 1 + src/Entity/Parts/PartAssociation.php | 12 +++++ .../Parts/PartTraits/AssociationTrait.php | 16 +++++++ templates/helper.twig | 9 ++++ templates/parts/info/_associations.html.twig | 40 ++++++++++++++++ templates/parts/info/show_part_info.html.twig | 17 +++++++ translations/messages.en.xlf | 48 +++++++++++++++++++ 7 files changed, 143 insertions(+) create mode 100644 templates/parts/info/_associations.html.twig diff --git a/config/packages/twig.yaml b/config/packages/twig.yaml index 05dec32c..5b2d64e5 100644 --- a/config/packages/twig.yaml +++ b/config/packages/twig.yaml @@ -20,6 +20,7 @@ twig: avatar_helper: '@App\Services\UserSystem\UserAvatarHelper' available_themes: '%partdb.available_themes%' saml_enabled: '%partdb.saml.enabled%' + part_preview_generator: '@App\Services\Attachments\PartPreviewGenerator' when@test: twig: diff --git a/src/Entity/Parts/PartAssociation.php b/src/Entity/Parts/PartAssociation.php index 98becd9c..81732057 100644 --- a/src/Entity/Parts/PartAssociation.php +++ b/src/Entity/Parts/PartAssociation.php @@ -136,5 +136,17 @@ class PartAssociation extends AbstractDBElement return $this; } + /** + * Returns the translation key for the type of this association. + * If the type is set to OTHER, then the other_type field value is used. + * @return string + */ + public function getTypeTranslationKey(): string + { + if ($this->type === AssociationType::OTHER) { + return $this->other_type ?? 'Unknown'; + } + return $this->type->getTranslationKey(); + } } \ No newline at end of file diff --git a/src/Entity/Parts/PartTraits/AssociationTrait.php b/src/Entity/Parts/PartTraits/AssociationTrait.php index 82c46f27..6cc1b973 100644 --- a/src/Entity/Parts/PartTraits/AssociationTrait.php +++ b/src/Entity/Parts/PartTraits/AssociationTrait.php @@ -23,7 +23,9 @@ declare(strict_types=1); namespace App\Entity\Parts\PartTraits; +use App\Entity\Parts\Part; use App\Entity\Parts\PartAssociation; +use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; use Symfony\Component\Validator\Constraints\Valid; use Doctrine\ORM\Mapping as ORM; @@ -89,4 +91,18 @@ trait AssociationTrait { return $this->associated_parts_as_other; } + + /** + * Returns all associations where this part is the owned or other part. + * @return Collection + */ + public function getAssociatedPartsAll(): Collection + { + return new ArrayCollection( + array_merge( + $this->associated_parts_as_owner->toArray(), + $this->associated_parts_as_other->toArray() + ) + ); + } } \ No newline at end of file diff --git a/templates/helper.twig b/templates/helper.twig index d0ea72be..f6de89d6 100644 --- a/templates/helper.twig +++ b/templates/helper.twig @@ -188,6 +188,15 @@ {% endif %} {% endmacro %} +{% macro part_icon_link(part) %} + {% set preview_attach = part_preview_generator.tablePreviewAttachment(part) %} + {% if preview_attach %} + Part image + {% endif %} + {{ part.name }} +{% endmacro %} + {% macro entity_preview_sm(entity) %} {# @var entity \App\Entity\Contracts\HasMasterAttachmentInterface #} {% if entity.masterPictureAttachment and entity.masterPictureAttachment.picture and attachment_manager.fileExisting(entity.masterPictureAttachment) %} diff --git a/templates/parts/info/_associations.html.twig b/templates/parts/info/_associations.html.twig new file mode 100644 index 00000000..7325a5c7 --- /dev/null +++ b/templates/parts/info/_associations.html.twig @@ -0,0 +1,40 @@ +{% import "helper.twig" as helper %} + +{% macro assoc_row(assoc) %} + {# @var assoc \App\Entity\Parts\PartAssociation #} + + {{ helper.part_icon_link(assoc.owner) }} + {{ assoc.typeTranslationKey | trans }} + {{ helper.part_icon_link(assoc.other) }} + {{ assoc.comment }} + +{% endmacro %} + +{% macro assoc_table(assocs, caption) %} +
    + + + + + + + + + + + + {% for assoc in assocs %} + {{ _self.assoc_row(assoc) }} + {% endfor %} + +
    {{ caption | trans }}:
    {% trans %}part_association.table.from{% endtrans %}{% trans %}part_association.table.type{% endtrans %}{% trans %}part_association.table.to{% endtrans %}{% trans %}part_association.edit.comment{% endtrans %}
    +
    +{% endmacro %} + +{% if part.associatedPartsAsOwner is not empty %} + {{ _self.assoc_table(part.associatedPartsAsOwner, 'part_association.table.from_this_part') }} +{% endif %} + +{% if part.associatedPartsAsOther is not empty %} + {{ _self.assoc_table(part.associatedPartsAsOther, 'part_association.table.to_this_part') }} +{% endif %} \ No newline at end of file diff --git a/templates/parts/info/show_part_info.html.twig b/templates/parts/info/show_part_info.html.twig index 6ac7bd52..41daba20 100644 --- a/templates/parts/info/show_part_info.html.twig +++ b/templates/parts/info/show_part_info.html.twig @@ -88,6 +88,17 @@
    • {% endif %} + + {% if part.associatedPartsAll is not empty %} +
  • + + + {% trans %}part.edit.tab.associations{% endtrans %} + {{ part.associatedPartsAll | length }} + +
    • + {% endif %} +
  • @@ -142,6 +153,12 @@ {% endif %} + {% if part.associatedPartsAll is not empty %} +
    + {% include "parts/info/_associations.html.twig" %} +
    + {% endif %} +
    {% include "parts/info/_projects.html.twig" %}
    diff --git a/translations/messages.en.xlf b/translations/messages.en.xlf index e3eadc4e..a901d597 100644 --- a/translations/messages.en.xlf +++ b/translations/messages.en.xlf @@ -11867,5 +11867,53 @@ Please note, that you can not impersonate a disabled user. If you try you will g You can select here, how the chosen part is related to this part. + + + part_association.table.from_this_part + Associations from this part to others + + + + + part_association.table.from + From + + + + + part_association.table.type + Relation + + + + + part_association.table.to + To + + + + + part_association.type.compatible + Is compatible with + + + + + part_association.table.to_this_part + Associations to this part from others + + + + + part_association.type.other + Other (custom value) + + + + + part_association.type.supersedes + Supersedes + + From c8bd800b9f03462bd11cc5112d7252c8de8debe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20B=C3=B6hmer?= Date: Thu, 16 Nov 2023 22:33:31 +0100 Subject: [PATCH 09/20] Hide the custom type input field if not needed to improve the UX --- ...association_edit_type_select_controller.js | 44 +++++++++++++++++++ src/Form/Part/PartAssociationType.php | 7 +++ .../parts/edit/edit_form_styles.html.twig | 4 +- translations/messages.en.xlf | 6 +++ 4 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 assets/controllers/pages/association_edit_type_select_controller.js diff --git a/assets/controllers/pages/association_edit_type_select_controller.js b/assets/controllers/pages/association_edit_type_select_controller.js new file mode 100644 index 00000000..10badf9c --- /dev/null +++ b/assets/controllers/pages/association_edit_type_select_controller.js @@ -0,0 +1,44 @@ +/* + * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony). + * + * Copyright (C) 2019 - 2023 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 . + */ + +import {Controller} from "@hotwired/stimulus"; + +export default class extends Controller { + + static targets = [ "display", "select" ] + + connect() + { + this.update(); + this.selectTarget.addEventListener('change', this.update.bind(this)); + } + + update() + { + //If the select value is 0, then we show the input field + if( this.selectTarget.value === '0') + { + this.displayTarget.classList.remove('d-none'); + } + else + { + this.displayTarget.classList.add('d-none'); + } + } +} \ No newline at end of file diff --git a/src/Form/Part/PartAssociationType.php b/src/Form/Part/PartAssociationType.php index cb5b526f..f640d38a 100644 --- a/src/Form/Part/PartAssociationType.php +++ b/src/Form/Part/PartAssociationType.php @@ -45,9 +45,16 @@ class PartAssociationType extends AbstractType 'label' => 'part_association.edit.type', 'choice_label' => fn(AssociationType $type) => $type->getTranslationKey(), 'help' => 'part_association.edit.type.help', + 'attr' => [ + 'data-pages--association-edit-type-select-target' => 'select' + ] ]) ->add('other_type', TextType::class, [ 'required' => false, + 'label' => 'part_association.edit.other_type', + 'row_attr' => [ + 'data-pages--association-edit-type-select-target' => 'display' + ] ]) ->add('comment', TextType::class, [ 'required' => false, diff --git a/templates/parts/edit/edit_form_styles.html.twig b/templates/parts/edit/edit_form_styles.html.twig index 0f46a2ad..2d60afa8 100644 --- a/templates/parts/edit/edit_form_styles.html.twig +++ b/templates/parts/edit/edit_form_styles.html.twig @@ -189,7 +189,9 @@ {% import 'components/collection_type.macro.html.twig' as collection %} - {{ form_widget(form) }} +
    + {{ form_widget(form) }} +