Fixed some inspection issues.

This commit is contained in:
Jan Böhmer 2019-11-10 14:00:56 +01:00
parent 3438f15274
commit 6ddc937ec5
32 changed files with 111 additions and 208 deletions

View file

@ -37,14 +37,14 @@ trait AdvancedPropertyTrait
protected $needs_review = false;
/**
* @var string A comma seperated list of tags, assocciated with the part.
* @var string A comma separated list of tags, associated with the part.
* @ORM\Column(type="text")
* @ColumnSecurity(type="string", prefix="tags", placeholder="")
*/
protected $tags = '';
/**
* @var float|null How much a single part unit weighs in gramms.
* @var float|null How much a single part unit weighs in grams.
* @ORM\Column(type="float", nullable=true)
* @ColumnSecurity(type="float", placeholder=null)
* @Assert\PositiveOrZero()
@ -63,7 +63,7 @@ trait AdvancedPropertyTrait
/**
* Sets the "needs review" status of this part.
*
* @param bool $needs_review The new status
* @return Part|self
*/
public function setNeedsReview(bool $needs_review): self
@ -86,6 +86,7 @@ trait AdvancedPropertyTrait
/**
* Sets a comma separated list of tags, that are assigned to this part.
*
* @param string $tags The new tags
* @return self
*/
public function setTags(string $tags): self
@ -110,6 +111,7 @@ trait AdvancedPropertyTrait
* Sets the mass of a single part unit.
* Sett to null, if the mass is unknown.
*
* @param float|null $mass The new mass.
* @return self
*/
public function setMass(?float $mass): self

View file

@ -70,6 +70,7 @@ trait InstockTrait
* Adds the given part lot, to the list of part lots.
* The part lot is assigned to this part.
*
* @param PartLot $lot
* @return self
*/
public function addPartLot(PartLot $lot): self
@ -109,6 +110,7 @@ trait InstockTrait
* Sets the measurement unit in which the part's amount should be measured.
* Set to null, if the part should be measured in quantities.
*
* @param MeasurementUnit|null $partUnit
* @return self
*/
public function setPartUnit(?MeasurementUnit $partUnit): self

View file

@ -99,7 +99,7 @@ trait ManufacturerTrait
* (Similar to https://designspark.zendesk.com/hc/en-us/articles/213584805-What-are-the-Lifecycle-Status-definitions-)
* * "": Status unknown
* * "announced": Part has been announced, but is not in production yet
* * "active": Part is in production and will be for the forseeable future
* * "active": Part is in production and will be for the foreseeable future
* * "nrfnd": Not recommended for new designs.
* * "eol": Part will become discontinued soon
* * "discontinued": Part is obsolete/discontinued by the manufacturer.
@ -115,6 +115,7 @@ trait ManufacturerTrait
* Sets the manufacturing status for this part
* See getManufacturingStatus() for valid values.
*
* @param string $manufacturing_status
* @return Part
*/
public function setManufacturingStatus(string $manufacturing_status): self
@ -147,6 +148,7 @@ trait ManufacturerTrait
/**
* Sets the manufacturer product number (MPN) for this part.
*
* @param string $manufacturer_product_number
* @return Part
*/
public function setManufacturerProductNumber(string $manufacturer_product_number): self

View file

@ -32,7 +32,7 @@ use Doctrine\Common\Collections\Collection;
trait OrderTrait
{
/**
* @var Orderdetail[] The details about how and where you can order this part.
* @var Orderdetail[]|Collection The details about how and where you can order this part.
* @ORM\OneToMany(targetEntity="App\Entity\PriceInformations\Orderdetail", mappedBy="part", cascade={"persist", "remove"}, orphanRemoval=true)
* @Assert\Valid()
* @ColumnSecurity(prefix="orderdetails", type="collection")
@ -137,6 +137,7 @@ trait OrderTrait
/**
* Removes the given orderdetail from the list of orderdetails.
*
* @param Orderdetail $orderdetail
* @return OrderTrait
*/
public function removeOrderdetail(Orderdetail $orderdetail): self