groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-12-25 12:29:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improved documentation of entity fields

Browse source
This commit is contained in:
Jan Böhmer 2023-09-17 12:50:32 +02:00
parent 219fbe5fca
commit f01ec9dbe4
13 changed files with 30 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/Entity/Parts/Category.php
View file

@ -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)]