2019-08-12 15:47:57 +02:00
|
|
|
<?php
|
|
|
|
/**
|
2019-11-09 00:47:20 +01:00
|
|
|
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
2019-08-12 15:47:57 +02:00
|
|
|
*
|
2019-11-01 13:40:30 +01:00
|
|
|
* Copyright (C) 2019 Jan Böhmer (https://github.com/jbtronics)
|
2019-08-12 15:47:57 +02:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* 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 General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace App\Entity\Parts;
|
|
|
|
|
2019-09-24 13:39:49 +02:00
|
|
|
use App\Entity\Attachments\MeasurementUnitAttachment;
|
2019-08-14 18:31:46 +02:00
|
|
|
use App\Entity\Base\PartsContainingDBElement;
|
2019-09-24 13:39:49 +02:00
|
|
|
use Doctrine\Common\Collections\Collection;
|
2019-08-12 15:47:57 +02:00
|
|
|
use Doctrine\ORM\Mapping as ORM;
|
|
|
|
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
|
2019-08-14 18:31:46 +02:00
|
|
|
use Symfony\Component\Validator\Constraints as Assert;
|
2019-08-12 15:47:57 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This unit represents the unit in which the amount of parts in stock are measured.
|
|
|
|
* This could be something like N, gramms, meters, etc...
|
|
|
|
*
|
|
|
|
* @ORM\Entity(repositoryClass="App\Repository\StructuralDBElementRepository")
|
|
|
|
* @ORM\Table(name="`measurement_units`")
|
|
|
|
* @UniqueEntity("unit")
|
|
|
|
*/
|
2019-08-14 18:31:46 +02:00
|
|
|
class MeasurementUnit extends PartsContainingDBElement
|
2019-08-12 15:47:57 +02:00
|
|
|
{
|
2019-09-24 13:39:49 +02:00
|
|
|
/**
|
|
|
|
* @var Collection|MeasurementUnitAttachment[]
|
2019-09-24 18:28:35 +02:00
|
|
|
* @ORM\OneToMany(targetEntity="App\Entity\Attachments\MeasurementUnitAttachment", mappedBy="element", cascade={"persist", "remove"}, orphanRemoval=true)
|
2019-09-24 13:39:49 +02:00
|
|
|
*/
|
|
|
|
protected $attachments;
|
|
|
|
|
2019-08-12 15:47:57 +02:00
|
|
|
/**
|
|
|
|
* @var string The unit symbol that should be used for the Unit. This could be something like "", g (for gramms)
|
2019-11-09 00:47:20 +01:00
|
|
|
* or m (for meters).
|
2019-08-14 18:31:46 +02:00
|
|
|
* @ORM\Column(type="string", name="unit", nullable=true)
|
|
|
|
* @Assert\Length(max=10)
|
2019-08-12 15:47:57 +02:00
|
|
|
*/
|
|
|
|
protected $unit;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var bool Determines if the amount value associated with this unit should be treated as integer.
|
2019-11-09 00:47:20 +01:00
|
|
|
* Set to false, to measure continuous sizes likes masses or lengthes.
|
2019-08-12 15:47:57 +02:00
|
|
|
* @ORM\Column(type="boolean", name="is_integer")
|
|
|
|
*/
|
2019-08-14 18:31:46 +02:00
|
|
|
protected $is_integer = false;
|
2019-08-12 15:47:57 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var bool Determines if the unit can be used with SI Prefixes (kilo, giga, milli, etc.).
|
2019-11-09 00:47:20 +01:00
|
|
|
* Useful for sizes like meters.
|
2019-08-12 15:47:57 +02:00
|
|
|
* @ORM\Column(type="boolean", name="use_si_prefix")
|
|
|
|
*/
|
2019-08-14 18:31:46 +02:00
|
|
|
protected $use_si_prefix = false;
|
2019-08-12 15:47:57 +02:00
|
|
|
|
2019-08-12 23:45:21 +02:00
|
|
|
/**
|
|
|
|
* @ORM\OneToMany(targetEntity="MeasurementUnit", mappedBy="parent", cascade={"persist"})
|
|
|
|
*/
|
|
|
|
protected $children;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @ORM\ManyToOne(targetEntity="MeasurementUnit", inversedBy="children")
|
|
|
|
* @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
|
|
|
|
*/
|
|
|
|
protected $parent;
|
|
|
|
|
2019-09-04 19:37:35 +02:00
|
|
|
/**
|
|
|
|
* @ORM\OneToMany(targetEntity="Part", mappedBy="partUnit", fetch="EXTRA_LAZY")
|
|
|
|
*/
|
|
|
|
protected $parts;
|
|
|
|
|
2019-08-12 15:47:57 +02:00
|
|
|
/**
|
|
|
|
* Returns the ID as an string, defined by the element class.
|
|
|
|
* This should have a form like P000014, for a part with ID 14.
|
|
|
|
*
|
|
|
|
* @return string The ID as a string;
|
|
|
|
*/
|
|
|
|
public function getIDString(): string
|
|
|
|
{
|
2019-11-09 00:47:20 +01:00
|
|
|
return 'MU'.$this->getID();
|
2019-08-12 15:47:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
2019-08-14 18:31:46 +02:00
|
|
|
public function getUnit(): ?string
|
2019-08-12 15:47:57 +02:00
|
|
|
{
|
|
|
|
return $this->unit;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $unit
|
2019-11-09 00:47:20 +01:00
|
|
|
*
|
2019-08-12 15:47:57 +02:00
|
|
|
* @return MeasurementUnit
|
|
|
|
*/
|
2019-11-09 00:47:20 +01:00
|
|
|
public function setUnit(?string $unit): self
|
2019-08-12 15:47:57 +02:00
|
|
|
{
|
|
|
|
$this->unit = $unit;
|
2019-11-09 00:47:20 +01:00
|
|
|
|
2019-08-12 15:47:57 +02:00
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isInteger(): bool
|
|
|
|
{
|
2019-08-14 18:31:46 +02:00
|
|
|
return $this->is_integer;
|
2019-08-12 15:47:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return MeasurementUnit
|
|
|
|
*/
|
2019-11-09 00:47:20 +01:00
|
|
|
public function setIsInteger(bool $isInteger): self
|
2019-08-12 15:47:57 +02:00
|
|
|
{
|
2019-08-20 18:39:57 +02:00
|
|
|
$this->is_integer = $isInteger;
|
2019-11-09 00:47:20 +01:00
|
|
|
|
2019-08-12 15:47:57 +02:00
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return bool
|
|
|
|
*/
|
2019-08-14 18:31:46 +02:00
|
|
|
public function isUseSIPrefix(): bool
|
2019-08-12 15:47:57 +02:00
|
|
|
{
|
2019-08-14 18:31:46 +02:00
|
|
|
return $this->use_si_prefix;
|
2019-08-12 15:47:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return MeasurementUnit
|
|
|
|
*/
|
2019-11-09 00:47:20 +01:00
|
|
|
public function setUseSIPrefix(bool $usesSIPrefixes): self
|
2019-08-12 15:47:57 +02:00
|
|
|
{
|
2019-08-20 18:39:57 +02:00
|
|
|
$this->use_si_prefix = $usesSIPrefixes;
|
2019-11-09 00:47:20 +01:00
|
|
|
|
2019-08-12 15:47:57 +02:00
|
|
|
return $this;
|
|
|
|
}
|
2019-11-09 00:47:20 +01:00
|
|
|
}
|