groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-01-11 04:39:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Assembly um IPN-Eingabemöglichkeit und Automatismus zur Name-Angabe erweitern

Browse source
This commit is contained in:
Marcel Diegelmann 2025-06-26 14:43:25 +02:00
parent bba619797e
commit 4f9c20a409
29 changed files with 287 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
config/parameters.yaml
View file

@ -14,6 +14,8 @@ parameters:
partdb.db.emulate_natural_sort: '%env(bool:DATABASE_EMULATE_NATURAL_SORT)%' # If this is set to true, natural sorting is emulated on platforms that do not support it natively. This can be slow on large datasets.
partdb.create_assembly_use_ipn_placeholder_in_name: '%env(bool:CREATE_ASSEMBLY_USE_IPN_PLACEHOLDER_IN_NAME)%' # Use an %%ipn%% placeholder in the name of an assembly. Placeholder is replaced with the ipn input while saving.
######################################################################################################################
# Users and Privacy
######################################################################################################################

4
config/services.yaml
View file

@ -164,6 +164,10 @@ services:
arguments:
$saml_enabled: '%partdb.saml.enabled%'
App\Form\AdminPages\AssemblyAdminForm:
arguments:
$useAssemblyIpnPlaceholder: '%partdb.create_assembly_use_ipn_placeholder_in_name%'
####################################################################################################################
# Table settings
####################################################################################################################

1
docs/configuration.md
View file

@ -141,6 +141,7 @@ bundled with Part-DB. Set `DATABASE_MYSQL_SSL_VERIFY_CERT` if you want to accept
time).
Also specify the default order of the columns. This is a comma separated list of column names. Available columns
are: `name`, `id`, `quantity`, `ipn`, `description`, `category`, `footprint`, `manufacturer`, `mountnames`, `instockAmount`, `storageLocations`, `addedDate`, `lastModified`.
* `CREATE_ASSEMBLY_USE_IPN_PLACEHOLDER_IN_NAME`: Use an %%ipn%% placeholder in the name of a assembly. Placeholder is replaced with the ipn input while saving.
### History/Eventlog-related settings

7
migrations/Version20250304081039.php
View file

@ -120,6 +120,7 @@ final class Version20250304081039 extends AbstractMultiPlatformMigration
last_modified DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL,
datetime_added DATETIME DEFAULT CURRENT_TIMESTAMP NOT NULL,
status VARCHAR(64) DEFAULT NULL,
ipn VARCHAR(100) DEFAULT NULL,
description CLOB NOT NULL,
alternative_names CLOB DEFAULT NULL,
CONSTRAINT FK_5F3832C0727ACA70 FOREIGN KEY (parent_id) REFERENCES assemblies (id) NOT DEFERRABLE INITIALLY IMMEDIATE,
@ -132,6 +133,12 @@ final class Version20250304081039 extends AbstractMultiPlatformMigration
$this->addSql(<<<'SQL'
CREATE INDEX IDX_5F3832C0EA7100A1 ON assemblies (id_preview_attachment)
SQL);
$this->addSql(<<<'SQL'
CREATE UNIQUE INDEX UNIQ_5F3832C03D721C14 ON assemblies (ipn)
SQL);
$this->addSql(<<<'SQL'
CREATE INDEX assembly_idx_ipn ON assemblies (ipn)
SQL);
$this->addSql(<<<'SQL'
CREATE TABLE assembly_bom_entries (

84
migrations/Version20250624095045.php Normal file
View file

@ -0,0 +1,84 @@
<?php
declare(strict_types=1);
namespace DoctrineMigrations;
use App\Migration\AbstractMultiPlatformMigration;
use Doctrine\DBAL\Schema\Schema;
final class Version20250624095045 extends AbstractMultiPlatformMigration
{
public function getDescription(): string
{
return 'Add IPN to assemblies';
}
public function mySQLUp(Schema $schema): void
{
$this->addSql(<<<'SQL'
ALTER TABLE assemblies ADD ipn VARCHAR(100) DEFAULT NULL AFTER status
SQL);
$this->addSql(<<<'SQL'
CREATE UNIQUE INDEX UNIQ_5F3832C03D721C14 ON assemblies (ipn)
SQL);
$this->addSql(<<<'SQL'
CREATE INDEX assembly_idx_ipn ON assemblies (ipn)
SQL);
$this->addSql(<<<'SQL'
ALTER TABLE assembly_bom_entries RENAME INDEX idx_8c74887e2f180363 TO IDX_8C74887E4AD2039E
SQL);
}
public function mySQLDown(Schema $schema): void
{
$this->addSql(<<<'SQL'
DROP INDEX UNIQ_5F3832C03D721C14 ON assemblies
SQL);
$this->addSql(<<<'SQL'
DROP INDEX assembly_idx_ipn ON assemblies
SQL);
$this->addSql(<<<'SQL'
ALTER TABLE assemblies DROP ipn
SQL);
$this->addSql(<<<'SQL'
ALTER TABLE assembly_bom_entries RENAME INDEX idx_8c74887e4ad2039e TO IDX_8C74887E2F180363
SQL);
}
public function sqLiteUp(Schema $schema): void
{
//nothing to do. Done via Version20250304081039
}
public function sqLiteDown(Schema $schema): void
{
//nothing to do. Done via Version20250304081039
}
public function postgreSQLUp(Schema $schema): void
{
$this->addSql(<<<'SQL'
ALTER TABLE assemblies ADD ipn VARCHAR(100) DEFAULT NULL
SQL);
$this->addSql(<<<'SQL'
CREATE UNIQUE INDEX UNIQ_5F3832C03D721C14 ON assemblies (ipn)
SQL);
$this->addSql(<<<'SQL'
CREATE INDEX assembly_idx_ipn ON assemblies (ipn)
SQL);
}
public function postgreSQLDown(Schema $schema): void
{
$this->addSql(<<<'SQL'
DROP INDEX UNIQ_5F3832C03D721C14
SQL);
$this->addSql(<<<'SQL'
DROP INDEX assembly_idx_ipn
SQL);
$this->addSql(<<<'SQL'
ALTER TABLE assemblies DROP ipn
SQL);
}
}

19
src/Controller/AdminPages/BaseAdminController.php
View file

@ -23,6 +23,7 @@ declare(strict_types=1);
namespace App\Controller\AdminPages;
use App\DataTables\LogDataTable;
use App\Entity\AssemblySystem\Assembly;
use App\Entity\Attachments\Attachment;
use App\Entity\Attachments\AttachmentContainingDBElement;
use App\Entity\Attachments\AttachmentUpload;
@ -193,6 +194,15 @@ abstract class BaseAdminController extends AbstractController
$entity->setMasterPictureAttachment(null);
}
if ($entity instanceof Assembly) {
/* Replace ipn placeholder with the IPN information if applicable.
* The '%%ipn%%' placeholder is automatically inserted into the Name property,
* depending on CREATE_ASSEMBLY_USE_IPN_PLACEHOLDER_IN_NAME, when creating a new one,
* to avoid having to insert it manually */
$entity->setName(str_ireplace('%%ipn%%', $entity->getIpn(), $entity->getName()));
}
$this->commentHelper->setMessage($form['log_comment']->getData());
$em->persist($entity);
@ -287,6 +297,15 @@ abstract class BaseAdminController extends AbstractController
$new_entity->setMasterPictureAttachment(null);
}
if ($new_entity instanceof Assembly) {
/* Replace ipn placeholder with the IPN information if applicable.
* The '%%ipn%%' placeholder is automatically inserted into the Name property,
* depending on CREATE_ASSEMBLY_USE_IPN_PLACEHOLDER_IN_NAME, when creating a new one,
* to avoid having to insert it manually */
$new_entity->setName(str_ireplace('%%ipn%%', $new_entity->getIpn(), $new_entity->getName()));
}
$this->commentHelper->setMessage($form['log_comment']->getData());
$em->persist($new_entity);
$em->flush();

33
src/Entity/AssemblySystem/Assembly.php
View file

@ -47,8 +47,10 @@ use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use InvalidArgumentException;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
/**
@ -58,6 +60,8 @@ use Symfony\Component\Validator\Context\ExecutionContextInterface;
*/
#[ORM\Entity]
#[ORM\Table(name: 'assemblies')]
#[UniqueEntity(fields: ['ipn'], message: 'assembly.ipn.must_be_unique')]
#[ORM\Index(columns: ['ipn'], name: 'assembly_idx_ipn')]
#[ApiResource(
operations: [
new Get(security: 'is_granted("read", object)'),
@ -83,7 +87,7 @@ use Symfony\Component\Validator\Context\ExecutionContextInterface;
normalizationContext: ['groups' => ['assembly:read', 'api:basic:read'], 'openapi_definition_name' => 'Read']
)]
#[ApiFilter(PropertyFilter::class)]
#[ApiFilter(LikeFilter::class, properties: ["name", "comment"])]
#[ApiFilter(LikeFilter::class, properties: ["name", "comment", "ipn"])]
#[ApiFilter(OrderFilter::class, properties: ['name', 'id', 'addedDate', 'lastModified'])]
class Assembly extends AbstractStructuralDBElement
{
@ -122,6 +126,14 @@ class Assembly extends AbstractStructuralDBElement
#[ORM\Column(type: Types::STRING, length: 64, nullable: true)]
protected ?string $status = null;
/**
* @var string|null The internal ipn number of the assembly
*/
#[Assert\Length(max: 100)]
#[Groups(['extended', 'full', 'project:read', 'project:write', 'import'])]
#[ORM\Column(type: Types::STRING, length: 100, unique: true, nullable: true)]
#[Length(max: 100)]
protected ?string $ipn = null;
/**
* @var Part|null The (optional) part that represents the builds of this assembly in the stock
@ -301,6 +313,25 @@ class Assembly extends AbstractStructuralDBElement
$this->status = $status;
}
/**
* Returns the internal part number of the assembly.
* @return string
*/
public function getIpn(): ?string
{
return $this->ipn;
}
/**
* Sets the internal part number of the assembly.
* @param string $ipn The new IPN of the assembly
*/
public function setIpn(?string $ipn): Assembly
{
$this->ipn = $ipn;
return $this;
}
/**
* Checks if this assembly has an associated part representing the builds of this assembly in the stock.
*/

17
src/Form/AdminPages/AssemblyAdminForm.php
View file

@ -25,11 +25,22 @@ namespace App\Form\AdminPages;
use App\Entity\Base\AbstractNamedDBElement;
use App\Form\AssemblySystem\AssemblyBOMEntryCollectionType;
use App\Form\Type\RichTextEditorType;
use App\Services\LogSystem\EventCommentNeededHelper;
use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
class AssemblyAdminForm extends BaseEntityAdminForm
{
public function __construct(
protected Security $security,
protected EventCommentNeededHelper $eventCommentNeededHelper,
protected bool $useAssemblyIpnPlaceholder = false
) {
parent::__construct($security, $eventCommentNeededHelper, $useAssemblyIpnPlaceholder);
}
protected function additionalFormElements(FormBuilderInterface $builder, array $options, AbstractNamedDBElement $entity): void
{
$builder->add('description', RichTextEditorType::class, [
@ -60,5 +71,11 @@ class AssemblyAdminForm extends BaseEntityAdminForm
'assembly.status.archived' => 'archived',
],
]);
$builder->add('ipn', TextType::class, [
'required' => false,
'empty_data' => null,
'label' => 'assembly.edit.ipn',
]);
}
}

8
src/Form/AdminPages/BaseEntityAdminForm.php
View file

@ -48,8 +48,11 @@ use Symfony\Component\OptionsResolver\OptionsResolver;
class BaseEntityAdminForm extends AbstractType
{
public function __construct(protected Security $security, protected EventCommentNeededHelper $eventCommentNeededHelper)
{
public function __construct(
protected Security $security,
protected EventCommentNeededHelper $eventCommentNeededHelper,
protected bool $useAssemblyIpnPlaceholder = false
) {
}
public function configureOptions(OptionsResolver $resolver): void
@ -70,6 +73,7 @@ class BaseEntityAdminForm extends AbstractType
->add('name', TextType::class, [
'empty_data' => '',
'label' => 'name.label',
'data' => $is_new && $entity instanceof Assembly && $this->useAssemblyIpnPlaceholder ? '%%ipn%%' : $entity->getName(),
'attr' => [
'placeholder' => 'part.name.placeholder',
],

1
templates/admin/assembly_admin.html.twig
View file

@ -29,6 +29,7 @@
{% block additional_controls %}
{{ form_row(form.description) }}
{{ form_row(form.status) }}
{{ form_row(form.ipn) }}
{% if entity.id %}
<div class="mb-2 row">
<label class="col-form-label col-sm-3">{% trans %}assembly.edit.associated_build_part{% endtrans %}</label>

6
translations/messages.cs.xlf
View file

@ -9870,6 +9870,12 @@ Element 3</target>
<target>Stav</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Interní číslo dílu (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.da.xlf
View file

@ -9896,6 +9896,12 @@ Element 3</target>
<target>Status</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Internt Partnummer (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.de.xlf
View file

@ -9956,6 +9956,12 @@ Element 1 -&gt; Element 1.2</target>
<target>Status</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Internal Part Number (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.en.xlf
View file

@ -9957,6 +9957,12 @@ Element 1 -&gt; Element 1.2</target>
<target>Project status</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Internal Part Number (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.es.xlf
View file

@ -9900,6 +9900,12 @@ Elemento 3</target>
<target>Estatus</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Número de Componente Interno (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.it.xlf
View file

@ -9902,6 +9902,12 @@ Element 3</target>
<target>Stato</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Codice interno (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.pl.xlf
View file

@ -9905,6 +9905,12 @@ Element 3</target>
<target>Status</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Internal Part Number (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.ru.xlf
View file

@ -9909,6 +9909,12 @@
<target>Статус</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>Внутренний номер компонента (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/messages.zh.xlf
View file

@ -9908,6 +9908,12 @@ Element 3</target>
<target>状态</target>
</segment>
</unit>
<unit id="9uJEwv1" name="assembly.edit.ipn">
<segment state="translated">
<source>assembly.edit.ipn</source>
<target>内部零件号 (IPN)</target>
</segment>
</unit>
<unit id="zRd.psv" name="assembly.status.draft">
<segment state="translated">
<source>assembly.status.draft</source>

6
translations/validators.cs.xlf
View file

@ -239,6 +239,12 @@
<target>Interní číslo dílu musí být jedinečné. {{ value }} se již používá!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Interní číslo dílu musí být jedinečné. {{ value }} se již používá!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.da.xlf
View file

@ -239,6 +239,12 @@
<target>Det interne partnummer skal være unikt. {{ value }} værdien er allerede i brug!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Det interne partnummer skal være unikt. {{ value }} værdien er allerede i brug!</target>
</segment>
</unit>
<unit id="Z4Kuuo2" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.de.xlf
View file

@ -239,6 +239,12 @@
<target>Die Internal Part Number (IPN) muss einzigartig sein. Der Wert {{value}} wird bereits benutzt!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Die Internal Part Number (IPN) muss einzigartig sein. Der Wert {{value}} wird bereits benutzt!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.el.xlf
View file

@ -7,6 +7,12 @@
<target>Ο εσωτερικός αριθμός εξαρτήματος πρέπει να είναι μοναδικός. {{ value }} χρησιμοποιείται ήδη!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Ο εσωτερικός αριθμός εξαρτήματος πρέπει να είναι μοναδικός. {{ value }} χρησιμοποιείται ήδη!</target>
</segment>
</unit>
<unit id="Q42Zh.e" name="validator.project.bom_entry.only_part_or_assembly_allowed">
<segment state="translated">
<source>validator.project.bom_entry.only_part_or_assembly_allowed</source>

6
translations/validators.en.xlf
View file

@ -239,6 +239,12 @@
<target>The internal part number must be unique. {{ value }} is already in use!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>The internal part number must be unique. {{ value }} is already in use!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.hr.xlf
View file

@ -239,6 +239,12 @@
<target>Internal part number (IPN) mora biti jedinstven. {{ value }} je već u uporabi!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Internal part number (IPN) mora biti jedinstven. {{ value }} je već u uporabi!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.it.xlf
View file

@ -239,6 +239,12 @@
<target>Il codice interno (IPN) deve essere univoco. Il valore {{value}} è già in uso!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Il codice interno (IPN) deve essere univoco. Il valore {{value}} è già in uso!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.pl.xlf
View file

@ -239,6 +239,12 @@
<target>Wewnętrzny numer części musi być unikalny. {{value }} jest już w użyciu!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Wewnętrzny numer części musi być unikalny. {{value }} jest już w użyciu!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.ru.xlf
View file

@ -239,6 +239,12 @@
<target>Внутренний номер детали (IPN) должен быть уникальным. Значение {{value}} уже используется!</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>Внутренний номер детали (IPN) должен быть уникальным. Значение {{value}} уже используется!</target>
</segment>
</unit>
<unit id="P31Yg.d" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>

6
translations/validators.zh.xlf
View file

@ -239,6 +239,12 @@
<target>内部部件号是唯一的。{{ value }} 已被使用！</target>
</segment>
</unit>
<unit id="Zhn4Xq1" name="assembly.ipn.must_be_unique">
<segment state="translated">
<source>assembly.ipn.must_be_unique</source>
<target>内部部件号是唯一的。{{ value }} 已被使用！</target>
</segment>
</unit>
<unit id="Z4Kuuo2" name="validator.project.bom_entry.name_or_part_needed">
<segment state="translated">
<source>validator.project.bom_entry.name_or_part_needed</source>