Part-DB-server/src/Entity/Storelocation.php

90 lines
2.4 KiB
PHP
Raw Normal View History

2019-02-23 22:41:13 +01:00
<?php
namespace App\Entity;
use Doctrine\ORM\Mapping as ORM;
/**
* Class Storelocation
* @package App\Entity
*
* @ORM\Entity()
* @ORM\Table("storelocations")
*/
class Storelocation extends PartsContainingDBElement
{
/**
* @ORM\OneToMany(targetEntity="Storelocation", mappedBy="parent")
*/
protected $children;
/**
* @ORM\ManyToOne(targetEntity="Storelocation", inversedBy="children")
* @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
*/
protected $parent;
/**
* @ORM\OneToMany(targetEntity="Part", mappedBy="storelocation")
*/
protected $parts;
/**
* @var bool
* @ORM\Column(type="boolean")
*/
protected $is_full;
/********************************************************************************
*
* Getters
*
*********************************************************************************/
/**
* Get the "is full" attribute
*
* @note "is_full == true" means that there is no more space in this storelocation.
* @note This attribute is only for information, it has no effect.
*
* @return boolean @li true if the storelocation is full
* @li false if the storelocation isn't full
*/
public function getIsFull() : bool
{
return (bool) $this->is_full;
}
/********************************************************************************
*
* Setters
*
*********************************************************************************/
/**
* Change the "is full" attribute of this storelocation
*
* @note "is_full" = true means that there is no more space in this storelocation.
* @note This attribute is only for information, it has no effect.
*
* @param boolean $new_is_full @li true means that the storelocation is full
* @li false means that the storelocation isn't full
*
* @throws Exception if there was an error
*/
public function setIsFull(bool $new_is_full) : self
2019-02-23 22:41:13 +01:00
{
$this->is_full = $new_is_full;
return $this;
2019-02-23 22:41:13 +01: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
{
return 'L' . sprintf('%06d', $this->getID());
}
}