mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-07-02 22:44:33 +02:00
Use Embeddables for EDACategoryInfo instead of a json column
This commit is contained in:
parent
d5f002ac20
commit
b76b2740a7
13 changed files with 280 additions and 150 deletions
125
src/Entity/EDA/EDACategoryInfo.php
Normal file
125
src/Entity/EDA/EDACategoryInfo.php
Normal file
|
@ -0,0 +1,125 @@
|
|||
<?php
|
||||
/*
|
||||
* 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 <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
|
||||
namespace App\Entity\EDA;
|
||||
|
||||
use Doctrine\DBAL\Types\Types;
|
||||
use Doctrine\ORM\Mapping\Column;
|
||||
use Doctrine\ORM\Mapping\Embeddable;
|
||||
|
||||
#[Embeddable]
|
||||
class EDACategoryInfo
|
||||
{
|
||||
/**
|
||||
* @var string|null The reference prefix of the Part in the schematic. E.g. "R" for resistors, or "C" for capacitors.
|
||||
*/
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $reference_prefix = null;
|
||||
|
||||
/** @var bool|null If this is true, then this part is invisible for the EDA software */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $invisible = null;
|
||||
|
||||
/** @var bool|null If this is set to true, then this part will be excluded from the BOM */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $exclude_from_bom = null;
|
||||
|
||||
/** @var bool|null If this is set to true, then this part will be excluded from the board/the PCB */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $exclude_from_board = null;
|
||||
|
||||
/** @var bool|null If this is set to true, then this part will be excluded in the simulation */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $exclude_from_sim = true;
|
||||
|
||||
/** @var string|null The KiCAD schematic symbol, which should be used (the path to the library) */
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $kicad_symbol = null;
|
||||
|
||||
public function getReferencePrefix(): ?string
|
||||
{
|
||||
return $this->reference_prefix;
|
||||
}
|
||||
|
||||
public function setReferencePrefix(?string $reference_prefix): EDACategoryInfo
|
||||
{
|
||||
$this->reference_prefix = $reference_prefix;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getInvisible(): ?bool
|
||||
{
|
||||
return $this->invisible;
|
||||
}
|
||||
|
||||
public function setInvisible(?bool $invisible): EDACategoryInfo
|
||||
{
|
||||
$this->invisible = $invisible;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getExcludeFromBom(): ?bool
|
||||
{
|
||||
return $this->exclude_from_bom;
|
||||
}
|
||||
|
||||
public function setExcludeFromBom(?bool $exclude_from_bom): EDACategoryInfo
|
||||
{
|
||||
$this->exclude_from_bom = $exclude_from_bom;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getExcludeFromBoard(): ?bool
|
||||
{
|
||||
return $this->exclude_from_board;
|
||||
}
|
||||
|
||||
public function setExcludeFromBoard(?bool $exclude_from_board): EDACategoryInfo
|
||||
{
|
||||
$this->exclude_from_board = $exclude_from_board;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getExcludeFromSim(): ?bool
|
||||
{
|
||||
return $this->exclude_from_sim;
|
||||
}
|
||||
|
||||
public function setExcludeFromSim(?bool $exclude_from_sim): EDACategoryInfo
|
||||
{
|
||||
$this->exclude_from_sim = $exclude_from_sim;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getKicadSymbol(): ?string
|
||||
{
|
||||
return $this->kicad_symbol;
|
||||
}
|
||||
|
||||
public function setKicadSymbol(?string $kicad_symbol): EDACategoryInfo
|
||||
{
|
||||
$this->kicad_symbol = $kicad_symbol;
|
||||
return $this;
|
||||
}
|
||||
|
||||
}
|
47
src/Entity/EDA/EDAFootprintInfo.php
Normal file
47
src/Entity/EDA/EDAFootprintInfo.php
Normal file
|
@ -0,0 +1,47 @@
|
|||
<?php
|
||||
/*
|
||||
* 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 <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
|
||||
namespace App\Entity\EDA;
|
||||
|
||||
use Doctrine\DBAL\Types\Types;
|
||||
use Doctrine\ORM\Mapping\Column;
|
||||
use Doctrine\ORM\Mapping\Embeddable;
|
||||
|
||||
#[Embeddable]
|
||||
class EDAFootprintInfo
|
||||
{
|
||||
/** @var string|null The KiCAD footprint, which should be used (the path to the library) */
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $kicad_footprint = null;
|
||||
|
||||
public function getKicadFootprint(): ?string
|
||||
{
|
||||
return $this->kicad_footprint;
|
||||
}
|
||||
|
||||
public function setKicadFootprint(?string $kicad_footprint): EDAFootprintInfo
|
||||
{
|
||||
$this->kicad_footprint = $kicad_footprint;
|
||||
return $this;
|
||||
}
|
||||
}
|
|
@ -23,31 +23,49 @@ declare(strict_types=1);
|
|||
|
||||
namespace App\Entity\EDA;
|
||||
|
||||
use Doctrine\DBAL\Types\Types;
|
||||
use Doctrine\ORM\Mapping\Column;
|
||||
use Doctrine\ORM\Mapping\Embeddable;
|
||||
|
||||
#[Embeddable]
|
||||
class EDAPartInfo
|
||||
{
|
||||
/**
|
||||
* @var string|null The reference prefix of the Part in the schematic. E.g. "R" for resistors, or "C" for capacitors.
|
||||
*/
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $reference_prefix = null;
|
||||
|
||||
/** @var string|null The value, which should be shown together with the part (e.g. 470 for a 470 Ohm resistor) */
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $value = null;
|
||||
|
||||
/** @var bool|null If this is true, then this part is invisible for the EDA software */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $invisible = null;
|
||||
|
||||
/** @var bool|null If this is set to true, then this part will be excluded from the BOM */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $exclude_from_bom = null;
|
||||
|
||||
/** @var bool|null If this is set to true, then this part will be excluded from the board/the PCB */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $exclude_from_board = null;
|
||||
|
||||
/** @var bool|null If this is set to true, then this part will be excluded in the simulation */
|
||||
#[Column(type: Types::BOOLEAN, nullable: true)]
|
||||
private ?bool $exclude_from_sim = true;
|
||||
|
||||
/** @var string|null The KiCAD schematic symbol, which should be used (the path to the library) */
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $kicad_symbol = null;
|
||||
|
||||
/** @var string|null The KiCAD footprint, which should be used (the path to the library) */
|
||||
#[Column(type: Types::STRING, nullable: true)]
|
||||
private ?string $kicad_footprint = null;
|
||||
|
||||
public function __construct(
|
||||
|
||||
) {
|
||||
public function __construct()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
|
|
|
@ -38,6 +38,7 @@ use ApiPlatform\OpenApi\Model\Operation;
|
|||
use ApiPlatform\Serializer\Filter\PropertyFilter;
|
||||
use App\ApiPlatform\Filter\LikeFilter;
|
||||
use App\Entity\Attachments\Attachment;
|
||||
use App\Entity\EDA\EDACategoryInfo;
|
||||
use App\Entity\EDA\EDAPartInfo;
|
||||
use App\Repository\Parts\CategoryRepository;
|
||||
use Doctrine\DBAL\Types\Types;
|
||||
|
@ -187,8 +188,18 @@ class Category extends AbstractPartsContainingDBElement
|
|||
#[Groups(['category:read'])]
|
||||
protected ?\DateTimeInterface $lastModified = null;
|
||||
|
||||
#[Column(type: 'json_document', options: ['jsonb' => true])]
|
||||
protected ?EDAPartInfo $eda_info = null;
|
||||
#[Assert\Valid]
|
||||
#[ORM\Embedded(class: EDACategoryInfo::class)]
|
||||
protected EDACategoryInfo $eda_info;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct();
|
||||
$this->children = new ArrayCollection();
|
||||
$this->attachments = new ArrayCollection();
|
||||
$this->parameters = new ArrayCollection();
|
||||
$this->eda_info = new EDACategoryInfo();
|
||||
}
|
||||
|
||||
public function getPartnameHint(): string
|
||||
{
|
||||
|
@ -282,14 +293,17 @@ class Category extends AbstractPartsContainingDBElement
|
|||
public function setDefaultComment(string $default_comment): self
|
||||
{
|
||||
$this->default_comment = $default_comment;
|
||||
|
||||
return $this;
|
||||
}
|
||||
public function __construct()
|
||||
|
||||
public function getEdaInfo(): EDACategoryInfo
|
||||
{
|
||||
parent::__construct();
|
||||
$this->children = new ArrayCollection();
|
||||
$this->attachments = new ArrayCollection();
|
||||
$this->parameters = new ArrayCollection();
|
||||
return $this->eda_info;
|
||||
}
|
||||
|
||||
public function setEdaInfo(EDACategoryInfo $eda_info): Category
|
||||
{
|
||||
$this->eda_info = $eda_info;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -39,6 +39,8 @@ use ApiPlatform\Serializer\Filter\PropertyFilter;
|
|||
use App\ApiPlatform\Filter\LikeFilter;
|
||||
use App\Entity\Attachments\Attachment;
|
||||
use App\Entity\Attachments\AttachmentTypeAttachment;
|
||||
use App\Entity\EDA\EDACategoryInfo;
|
||||
use App\Entity\EDA\EDAFootprintInfo;
|
||||
use App\Entity\EDA\EDAPartInfo;
|
||||
use App\Repository\Parts\FootprintRepository;
|
||||
use App\Entity\Base\AbstractStructuralDBElement;
|
||||
|
@ -139,8 +141,18 @@ class Footprint extends AbstractPartsContainingDBElement
|
|||
#[Groups(['footprint:read'])]
|
||||
protected ?\DateTimeInterface $lastModified = null;
|
||||
|
||||
#[Column(type: 'json_document', options: ['jsonb' => true])]
|
||||
protected ?EDAPartInfo $eda_info = null;
|
||||
#[Assert\Valid]
|
||||
#[ORM\Embedded(class: EDAFootprintInfo::class)]
|
||||
protected EDAFootprintInfo $eda_info;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct();
|
||||
$this->children = new ArrayCollection();
|
||||
$this->attachments = new ArrayCollection();
|
||||
$this->parameters = new ArrayCollection();
|
||||
$this->eda_info = new EDAFootprintInfo();
|
||||
}
|
||||
|
||||
/****************************************
|
||||
* Getters
|
||||
|
@ -170,11 +182,15 @@ class Footprint extends AbstractPartsContainingDBElement
|
|||
|
||||
return $this;
|
||||
}
|
||||
public function __construct()
|
||||
|
||||
public function getEdaInfo(): EDAFootprintInfo
|
||||
{
|
||||
parent::__construct();
|
||||
$this->children = new ArrayCollection();
|
||||
$this->attachments = new ArrayCollection();
|
||||
$this->parameters = new ArrayCollection();
|
||||
return $this->eda_info;
|
||||
}
|
||||
|
||||
public function setEdaInfo(EDAFootprintInfo $eda_info): Footprint
|
||||
{
|
||||
$this->eda_info = $eda_info;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -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\EDA\EDAPartInfo;
|
||||
use App\Entity\Parts\PartTraits\AssociationTrait;
|
||||
use App\Entity\Parts\PartTraits\EDATrait;
|
||||
use App\Repository\PartRepository;
|
||||
|
@ -175,6 +176,7 @@ class Part extends AttachmentContainingDBElement
|
|||
|
||||
//By default, the part has no provider
|
||||
$this->providerReference = InfoProviderReference::noProvider();
|
||||
$this->eda_info = new EDAPartInfo();
|
||||
}
|
||||
|
||||
public function __clone()
|
||||
|
@ -210,6 +212,7 @@ class Part extends AttachmentContainingDBElement
|
|||
|
||||
//Deep clone info provider
|
||||
$this->providerReference = clone $this->providerReference;
|
||||
$this->eda_info = clone $this->eda_info;
|
||||
}
|
||||
parent::__clone();
|
||||
}
|
||||
|
|
|
@ -25,13 +25,14 @@ namespace App\Entity\Parts\PartTraits;
|
|||
|
||||
use App\Entity\EDA\EDAPartInfo;
|
||||
use Doctrine\ORM\Mapping\Column;
|
||||
use Doctrine\ORM\Mapping\Embedded;
|
||||
use Symfony\Component\Validator\Constraints\Valid;
|
||||
|
||||
trait EDATrait
|
||||
{
|
||||
#[Column(type: 'json_document', options: ['jsonb' => true])]
|
||||
#[Valid]
|
||||
protected ?EDAPartInfo $eda_info = null;
|
||||
#[Embedded(class: EDAPartInfo::class)]
|
||||
protected EDAPartInfo $eda_info;
|
||||
|
||||
public function getEdaInfo(): ?EDAPartInfo
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue