Improved documentation of entity fields

src/Entity/Base/AbstractCompany.php

@@ -86,7 +86,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
     protected string $comment = '';
 
     /**
-     * @var string
+     * @var string The link to the website of an article. Use %PARTNUMBER% as placeholder for the part number.
      */
     #[ORM\Column(type: Types::STRING)]
     protected string $auto_product_url = '';

src/Entity/Base/AbstractNamedDBElement.php

@@ -40,7 +40,7 @@ abstract class AbstractNamedDBElement extends AbstractDBElement implements Named
     use TimestampTrait;
 
     /**
-     * @var string the name of this element
+     * @var string The name of this element
      */
     #[Assert\NotBlank]
     #[Groups(['simple', 'extended', 'full', 'import', 'api:basic:read', 'api:basic:write'])]

src/Entity/Base/AbstractPartsContainingDBElement.php

@@ -40,6 +40,9 @@ use Symfony\Component\Serializer\Annotation\Groups;
 #[ORM\MappedSuperclass(repositoryClass: AbstractPartsContainingRepository::class)]
 abstract class AbstractPartsContainingDBElement extends AbstractStructuralDBElement
 {
+    /**
+     * @var Collection|ArrayCollection The parameters of this element
+     */
     #[Groups(['full'])]
     protected Collection $parameters;
 

src/Entity/Parts/Category.php

@@ -93,56 +93,56 @@ class Category extends AbstractPartsContainingDBElement
     protected string $comment = '';
 
     /**
-     * @var string
+     * @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
+     * @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 bool
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @var string The default comment for parts in this category.
      */
     #[Groups(['full', 'import', 'category:read', 'category:write'])]
     #[ORM\Column(type: Types::TEXT)]

src/Entity/Parts/PartLot.php

@@ -113,7 +113,7 @@ class PartLot extends AbstractDBElement implements TimeStampableInterface, Named
     protected bool $instock_unknown = false;
 
     /**
-     * @var float For continuous sizes (length, volume, etc.) the instock is saved here.
+     * @var float The amount of parts in this lot. For integer-quantities this value is rounded to the next integer.
      */
     #[Assert\PositiveOrZero]
     #[Groups(['simple', 'extended', 'full', 'import', 'part_lot:read', 'part_lot:write'])]

src/Entity/Parts/PartTraits/AdvancedPropertyTrait.php

@@ -43,14 +43,14 @@ trait AdvancedPropertyTrait
     protected bool $needs_review = false;
 
     /**
-     * @var string a comma separated list of tags, associated with the part
+     * @var string A comma separated list of tags, associated with the part
      */
     #[Groups(['extended', 'full', 'import', 'part:read', 'part:write'])]
     #[ORM\Column(type: Types::TEXT)]
     protected string $tags = '';
 
     /**
-     * @var float|null how much a single part unit weighs in grams
+     * @var float|null How much a single part unit weighs in grams
      */
     #[Assert\PositiveOrZero]
     #[Groups(['extended', 'full', 'import', 'part:read', 'part:write'])]

src/Entity/Parts/PartTraits/InstockTrait.php

@@ -36,7 +36,7 @@ use Symfony\Component\Validator\Constraints as Assert;
 trait InstockTrait
 {
     /**
-     * @var Collection|PartLot[] A list of part lots where this part is stored
+     * @var Collection<int, PartLot> A list of part lots where this part is stored
      */
     #[Assert\Valid]
     #[Groups(['extended', 'full', 'import'])]

src/Entity/Parts/PartTraits/ManufacturerTrait.php

@@ -46,7 +46,7 @@ trait ManufacturerTrait
     protected ?Manufacturer $manufacturer = null;
 
     /**
-     * @var string the url to the part on the manufacturer's homepage
+     * @var string The url to the part on the manufacturer's homepage
      */
     #[Assert\Url]
     #[Groups(['full', 'import', 'part:read', 'part:write'])]

src/Entity/Parts/PartTraits/OrderTrait.php

@@ -36,7 +36,7 @@ use Doctrine\ORM\Mapping as ORM;
 trait OrderTrait
 {
     /**
-     * @var Collection<int, Orderdetail> the details about how and where you can order this part
+     * @var Collection<int, Orderdetail> The details about how and where you can order this part
      */
     #[Assert\Valid]
     #[Groups(['extended', 'full', 'import'])]

src/Entity/Parts/StorageLocation.php

@@ -108,21 +108,21 @@ class StorageLocation extends AbstractPartsContainingDBElement
     protected Collection $parameters;
 
     /**
-     * @var bool
+     * @var bool When this attribute is set, it is not possible to add additional parts or increase the instock of existing parts.
      */
     #[Groups(['full', 'import', 'location:read', 'location:write'])]
     #[ORM\Column(type: Types::BOOLEAN)]
     protected bool $is_full = false;
 
     /**
-     * @var bool
+     * @var bool When this property is set, only one part (but many instock) is allowed to be stored in this store location.
      */
     #[Groups(['full', 'import', 'location:read', 'location:write'])]
     #[ORM\Column(type: Types::BOOLEAN)]
     protected bool $only_single_part = false;
 
     /**
-     * @var bool
+     * @var bool When this property is set, it is only possible to increase the instock of parts, that are already stored here.
      */
     #[Groups(['full', 'import', 'location:read', 'location:write'])]
     #[ORM\Column(type: Types::BOOLEAN)]

src/Entity/Parts/Supplier.php

@@ -108,7 +108,7 @@ class Supplier extends AbstractCompany
     protected ?Currency $default_currency = null;
 
     /**
-     * @var BigDecimal|null the shipping costs that have to be paid, when ordering via this supplier
+     * @var BigDecimal|null The shipping costs that have to be paid, when ordering via this supplier
      */
     #[Groups(['extended', 'full', 'import'])]
     #[ORM\Column(name: 'shipping_costs', nullable: true, type: 'big_decimal', precision: 11, scale: 5)]

src/Entity/PriceInformations/Orderdetail.php

@@ -89,21 +89,21 @@ class Orderdetail extends AbstractDBElement implements TimeStampableInterface, N
     protected Collection $pricedetails;
 
     /**
-     * @var string
+     * @var string The order number of the part at the supplier
      */
     #[Groups(['extended', 'full', 'import', 'orderdetail:read', 'orderdetail:write'])]
     #[ORM\Column(type: Types::STRING)]
     protected string $supplierpartnr = '';
 
     /**
-     * @var bool
+     * @var bool True if this part is obsolete/not available anymore at the supplier
      */
     #[Groups(['extended', 'full', 'import', 'orderdetail:read', 'orderdetail:write'])]
     #[ORM\Column(type: Types::BOOLEAN)]
     protected bool $obsolete = false;
 
     /**
-     * @var string
+     * @var string The URL to the product on the supplier's website
      */
     #[Assert\Url]
     #[Groups(['full', 'import', 'orderdetail:read', 'orderdetail:write'])]
@@ -111,7 +111,7 @@ class Orderdetail extends AbstractDBElement implements TimeStampableInterface, N
     protected string $supplier_product_url = '';
 
     /**
-     * @var Part|null
+     * @var Part|null The part with which this orderdetail is associated
      */
     #[Assert\NotNull]
     #[ORM\ManyToOne(targetEntity: Part::class, inversedBy: 'orderdetails')]
@@ -120,7 +120,7 @@ class Orderdetail extends AbstractDBElement implements TimeStampableInterface, N
     protected ?Part $part = null;
 
     /**
-     * @var Supplier|null
+     * @var Supplier|null The supplier of this orderdetail
      */
     #[Assert\NotNull(message: 'validator.orderdetail.supplier_must_not_be_null')]
     #[Groups(['extended', 'full', 'import', 'orderdetail:read', 'orderdetail:write'])]

src/Entity/PriceInformations/Pricedetail.php

@@ -90,7 +90,7 @@ class Pricedetail extends AbstractDBElement implements TimeStampableInterface
     protected ?Currency $currency = null;
 
     /**
-     * @var float
+     * @var float The amount/quantity for which the price is for (in part unit)
      */
     #[Assert\Positive]
     #[Groups(['extended', 'full', 'import', 'pricedetail:read', 'pricedetail:write'])]
@@ -98,7 +98,7 @@ class Pricedetail extends AbstractDBElement implements TimeStampableInterface
     protected float $price_related_quantity = 1.0;
 
     /**
-     * @var float
+     * @var float The minimum amount/quantity, which is needed to get this discount (in part unit)
      */
     #[Assert\Positive]
     #[Groups(['extended', 'full', 'import', 'pricedetail:read', 'pricedetail:write'])]