mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2026-01-13 21:59:34 +00:00
87d26e7eac
- Remove inheritance from AbstractPartsContainingDBElement - Add explicit trait usage: DBElementTrait, NamedElementTrait, TimestampTrait, AttachmentsTrait, MasterAttachmentTrait, StructuralElementTrait, ParametersTrait - Implement all required interfaces directly - Initialize traits in constructor - Add custom __clone and jsonSerialize methods Co-authored-by: jbtronics <5410681+jbtronics@users.noreply.github.com>
375 lines
13 KiB
PHP
375 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
|
*
|
|
* Copyright (C) 2019 - 2022 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\Parts;
|
|
|
|
use Doctrine\Common\Collections\Criteria;
|
|
use ApiPlatform\Doctrine\Common\Filter\DateFilterInterface;
|
|
use ApiPlatform\Doctrine\Orm\Filter\DateFilter;
|
|
use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
|
|
use ApiPlatform\Metadata\ApiFilter;
|
|
use ApiPlatform\Metadata\ApiProperty;
|
|
use ApiPlatform\Metadata\ApiResource;
|
|
use ApiPlatform\Metadata\Delete;
|
|
use ApiPlatform\Metadata\Get;
|
|
use ApiPlatform\Metadata\GetCollection;
|
|
use ApiPlatform\Metadata\Link;
|
|
use ApiPlatform\Metadata\Patch;
|
|
use ApiPlatform\Metadata\Post;
|
|
use ApiPlatform\OpenApi\Model\Operation;
|
|
use ApiPlatform\Serializer\Filter\PropertyFilter;
|
|
use App\ApiPlatform\Filter\LikeFilter;
|
|
use App\Entity\Attachments\Attachment;
|
|
use App\Entity\Base\AttachmentsTrait;
|
|
use App\Entity\Base\DBElementTrait;
|
|
use App\Entity\Base\MasterAttachmentTrait;
|
|
use App\Entity\Base\NamedElementTrait;
|
|
use App\Entity\Base\StructuralElementTrait;
|
|
use App\Entity\Base\TimestampTrait;
|
|
use App\Entity\Contracts\DBElementInterface;
|
|
use App\Entity\Contracts\HasAttachmentsInterface;
|
|
use App\Entity\Contracts\HasMasterAttachmentInterface;
|
|
use App\Entity\Contracts\HasParametersInterface;
|
|
use App\Entity\Contracts\NamedElementInterface;
|
|
use App\Entity\Contracts\StructuralElementInterface;
|
|
use App\Entity\Contracts\TimeStampableInterface;
|
|
use App\Entity\EDA\EDACategoryInfo;
|
|
use App\Entity\Parameters\ParametersTrait;
|
|
use App\EntityListeners\TreeCacheInvalidationListener;
|
|
use App\Repository\Parts\CategoryRepository;
|
|
use App\Validator\Constraints\UniqueObjectCollection;
|
|
use Doctrine\DBAL\Types\Types;
|
|
use Doctrine\Common\Collections\ArrayCollection;
|
|
use App\Entity\Attachments\CategoryAttachment;
|
|
use App\Entity\Parameters\CategoryParameter;
|
|
use Doctrine\Common\Collections\Collection;
|
|
use Doctrine\ORM\Mapping as ORM;
|
|
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
|
|
use Symfony\Component\Serializer\Annotation\Groups;
|
|
use Symfony\Component\Validator\Constraints as Assert;
|
|
|
|
/**
|
|
* This entity describes a category, a part can belong to, which is used to group parts by their function.
|
|
*/
|
|
#[ORM\Entity(repositoryClass: CategoryRepository::class)]
|
|
#[ORM\Table(name: '`categories`')]
|
|
#[ORM\Index(columns: ['name'], name: 'category_idx_name')]
|
|
#[ORM\Index(columns: ['parent_id', 'name'], name: 'category_idx_parent_name')]
|
|
#[ORM\HasLifecycleCallbacks]
|
|
#[ORM\EntityListeners([TreeCacheInvalidationListener::class])]
|
|
#[UniqueEntity(fields: ['name', 'parent'], message: 'structural.entity.unique_name', ignoreNull: false)]
|
|
#[ApiResource(
|
|
operations: [
|
|
new Get(security: 'is_granted("read", object)'),
|
|
new GetCollection(security: 'is_granted("@categories.read")'),
|
|
new Post(securityPostDenormalize: 'is_granted("create", object)'),
|
|
new Patch(security: 'is_granted("edit", object)'),
|
|
new Delete(security: 'is_granted("delete", object)'),
|
|
],
|
|
normalizationContext: ['groups' => ['category:read', 'api:basic:read'], 'openapi_definition_name' => 'Read'],
|
|
denormalizationContext: ['groups' => ['category:write', 'api:basic:write', 'attachment:write', 'parameter:write'], 'openapi_definition_name' => 'Write'],
|
|
)]
|
|
#[ApiResource(
|
|
uriTemplate: '/categories/{id}/children.{_format}',
|
|
operations: [
|
|
new GetCollection(
|
|
openapi: new Operation(summary: 'Retrieves the children elements of a category.'),
|
|
security: 'is_granted("@categories.read")'
|
|
)
|
|
],
|
|
uriVariables: [
|
|
'id' => new Link(fromProperty: 'children', fromClass: Category::class)
|
|
],
|
|
normalizationContext: ['groups' => ['category:read', 'api:basic:read'], 'openapi_definition_name' => 'Read']
|
|
)]
|
|
#[ApiFilter(PropertyFilter::class)]
|
|
#[ApiFilter(LikeFilter::class, properties: ["name", "comment"])]
|
|
#[ApiFilter(DateFilter::class, strategy: DateFilterInterface::EXCLUDE_NULL)]
|
|
#[ApiFilter(OrderFilter::class, properties: ['name', 'id', 'addedDate', 'lastModified'])]
|
|
class Category implements DBElementInterface, NamedElementInterface, TimeStampableInterface, HasAttachmentsInterface, HasMasterAttachmentInterface, StructuralElementInterface, HasParametersInterface, \Stringable, \JsonSerializable
|
|
{
|
|
use DBElementTrait;
|
|
use NamedElementTrait;
|
|
use TimestampTrait;
|
|
use AttachmentsTrait;
|
|
use MasterAttachmentTrait;
|
|
use StructuralElementTrait;
|
|
use ParametersTrait;
|
|
|
|
#[ORM\OneToMany(mappedBy: 'parent', targetEntity: self::class)]
|
|
#[ORM\OrderBy(['name' => Criteria::ASC])]
|
|
protected Collection $children;
|
|
|
|
#[ORM\ManyToOne(targetEntity: self::class, inversedBy: 'children')]
|
|
#[ORM\JoinColumn(name: 'parent_id')]
|
|
#[Groups(['category:read', 'category:write'])]
|
|
#[ApiProperty(readableLink: false, writableLink: false)]
|
|
protected ?self $parent = null;
|
|
|
|
#[Groups(['category:read', 'category:write'])]
|
|
protected string $comment = '';
|
|
|
|
/**
|
|
* @var string The hint which is shown as hint under the partname field, when a part is created in this category.
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::TEXT)]
|
|
protected string $partname_hint = '';
|
|
|
|
/**
|
|
* @var string The regular expression which is used to validate the partname of a part in this category.
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::TEXT)]
|
|
protected string $partname_regex = '';
|
|
|
|
/**
|
|
* @var string The prefix for ipn generation for created parts in this category.
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::STRING, length: 255, nullable: false, options: ['default' => ''])]
|
|
protected string $part_ipn_prefix = '';
|
|
|
|
/**
|
|
* @var bool Set to true, if the footprints should be disabled for parts this category (not implemented yet).
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::BOOLEAN)]
|
|
protected bool $disable_footprints = false;
|
|
|
|
/**
|
|
* @var bool Set to true, if the manufacturers should be disabled for parts this category (not implemented yet).
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::BOOLEAN)]
|
|
protected bool $disable_manufacturers = false;
|
|
|
|
/**
|
|
* @var bool Set to true, if the autodatasheets should be disabled for parts this category (not implemented yet).
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::BOOLEAN)]
|
|
protected bool $disable_autodatasheets = false;
|
|
|
|
/**
|
|
* @var bool Set to true, if the properties should be disabled for parts this category (not implemented yet).
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::BOOLEAN)]
|
|
protected bool $disable_properties = false;
|
|
|
|
/**
|
|
* @var string The default description for parts in this category.
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::TEXT)]
|
|
protected string $default_description = '';
|
|
|
|
/**
|
|
* @var string The default comment for parts in this category.
|
|
*/
|
|
#[Groups(['full', 'import', 'category:read', 'category:write'])]
|
|
#[ORM\Column(type: Types::TEXT)]
|
|
protected string $default_comment = '';
|
|
|
|
/**
|
|
* @var Collection<int, CategoryAttachment>
|
|
*/
|
|
#[Assert\Valid]
|
|
#[Groups(['full', 'category:read', 'category:write'])]
|
|
#[ORM\OneToMany(mappedBy: 'element', targetEntity: CategoryAttachment::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
|
|
#[ORM\OrderBy(['name' => Criteria::ASC])]
|
|
protected Collection $attachments;
|
|
|
|
#[ORM\ManyToOne(targetEntity: CategoryAttachment::class)]
|
|
#[ORM\JoinColumn(name: 'id_preview_attachment', onDelete: 'SET NULL')]
|
|
#[Groups(['category:read', 'category:write'])]
|
|
protected ?Attachment $master_picture_attachment = null;
|
|
|
|
/** @var Collection<int, CategoryParameter>
|
|
*/
|
|
#[Assert\Valid]
|
|
#[UniqueObjectCollection(fields: ['name', 'group', 'element'])]
|
|
#[Groups(['full', 'category:read', 'category:write'])]
|
|
#[ORM\OneToMany(mappedBy: 'element', targetEntity: CategoryParameter::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
|
|
#[ORM\OrderBy(['group' => Criteria::ASC, 'name' => 'ASC'])]
|
|
protected Collection $parameters;
|
|
|
|
#[Groups(['category:read'])]
|
|
protected ?\DateTimeImmutable $addedDate = null;
|
|
#[Groups(['category:read'])]
|
|
protected ?\DateTimeImmutable $lastModified = null;
|
|
|
|
#[Assert\Valid]
|
|
#[ORM\Embedded(class: EDACategoryInfo::class)]
|
|
#[Groups(['full', 'category:read', 'category:write'])]
|
|
protected EDACategoryInfo $eda_info;
|
|
|
|
public function __construct()
|
|
{
|
|
$this->initializeAttachments();
|
|
$this->initializeStructuralElement();
|
|
$this->children = new ArrayCollection();
|
|
$this->attachments = new ArrayCollection();
|
|
$this->parameters = new ArrayCollection();
|
|
$this->eda_info = new EDACategoryInfo();
|
|
}
|
|
|
|
public function __clone()
|
|
{
|
|
if ($this->id) {
|
|
$this->cloneDBElement();
|
|
$this->cloneAttachments();
|
|
|
|
// We create a new object, so give it a new creation date
|
|
$this->addedDate = null;
|
|
|
|
//Deep clone parameters
|
|
$parameters = $this->parameters;
|
|
$this->parameters = new ArrayCollection();
|
|
foreach ($parameters as $parameter) {
|
|
$this->addParameter(clone $parameter);
|
|
}
|
|
}
|
|
}
|
|
|
|
public function jsonSerialize(): array
|
|
{
|
|
return ['@id' => $this->getID()];
|
|
}
|
|
|
|
public function getPartnameHint(): string
|
|
{
|
|
return $this->partname_hint;
|
|
}
|
|
|
|
public function setPartnameHint(string $partname_hint): self
|
|
{
|
|
$this->partname_hint = $partname_hint;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getPartnameRegex(): string
|
|
{
|
|
return $this->partname_regex;
|
|
}
|
|
|
|
public function setPartnameRegex(string $partname_regex): self
|
|
{
|
|
$this->partname_regex = $partname_regex;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getPartIpnPrefix(): string
|
|
{
|
|
return $this->part_ipn_prefix;
|
|
}
|
|
|
|
public function setPartIpnPrefix(string $part_ipn_prefix): void
|
|
{
|
|
$this->part_ipn_prefix = $part_ipn_prefix;
|
|
}
|
|
|
|
public function isDisableFootprints(): bool
|
|
{
|
|
return $this->disable_footprints;
|
|
}
|
|
|
|
public function setDisableFootprints(bool $disable_footprints): self
|
|
{
|
|
$this->disable_footprints = $disable_footprints;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function isDisableManufacturers(): bool
|
|
{
|
|
return $this->disable_manufacturers;
|
|
}
|
|
|
|
public function setDisableManufacturers(bool $disable_manufacturers): self
|
|
{
|
|
$this->disable_manufacturers = $disable_manufacturers;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function isDisableAutodatasheets(): bool
|
|
{
|
|
return $this->disable_autodatasheets;
|
|
}
|
|
|
|
public function setDisableAutodatasheets(bool $disable_autodatasheets): self
|
|
{
|
|
$this->disable_autodatasheets = $disable_autodatasheets;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function isDisableProperties(): bool
|
|
{
|
|
return $this->disable_properties;
|
|
}
|
|
|
|
public function setDisableProperties(bool $disable_properties): self
|
|
{
|
|
$this->disable_properties = $disable_properties;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getDefaultDescription(): string
|
|
{
|
|
return $this->default_description;
|
|
}
|
|
|
|
public function setDefaultDescription(string $default_description): self
|
|
{
|
|
$this->default_description = $default_description;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getDefaultComment(): string
|
|
{
|
|
return $this->default_comment;
|
|
}
|
|
|
|
public function setDefaultComment(string $default_comment): self
|
|
{
|
|
$this->default_comment = $default_comment;
|
|
return $this;
|
|
}
|
|
|
|
public function getEdaInfo(): EDACategoryInfo
|
|
{
|
|
return $this->eda_info;
|
|
}
|
|
|
|
public function setEdaInfo(EDACategoryInfo $eda_info): Category
|
|
{
|
|
$this->eda_info = $eda_info;
|
|
return $this;
|
|
}
|
|
}
|