Part-DB.Part-DB-server/src/Entity/LabelSystem/LabelOptions.php

234 lines
5.7 KiB
PHP
Raw Normal View History

<?php
2022-11-29 21:21:26 +01:00
/*
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
2020-05-10 21:39:31 +02:00
declare(strict_types=1);
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
2022-11-29 22:28:53 +01:00
* Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
namespace App\Entity\LabelSystem;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
/**
* @ORM\Embeddable()
*/
class LabelOptions
{
2020-05-07 23:27:40 +02:00
public const BARCODE_TYPES = ['none', /*'ean8',*/ 'qr', 'code39', 'datamatrix', 'code93', 'code128'];
public const SUPPORTED_ELEMENTS = ['part', 'part_lot', 'storelocation'];
public const PICTURE_TYPES = ['none', 'element_picture', 'main_attachment'];
public const LINES_MODES = ['html', 'twig'];
/**
* @var float The page size of the label in mm
* @Assert\Positive()
* @ORM\Column(type="float")
*/
2022-09-18 22:59:31 +02:00
protected float $width = 50.0;
/**
* @var float The page size of the label in mm
* @Assert\Positive()
* @ORM\Column(type="float")
*/
2022-09-18 22:59:31 +02:00
protected float $height = 30.0;
/**
* @var string The type of the barcode that should be used in the label (e.g. 'qr')
* @Assert\Choice(choices=LabelOptions::BARCODE_TYPES)
* @ORM\Column(type="string")
*/
2022-09-18 22:59:31 +02:00
protected string $barcode_type = 'none';
/**
* @var string What image should be shown along the
* @Assert\Choice(choices=LabelOptions::PICTURE_TYPES)
* @ORM\Column(type="string")
*/
2022-09-18 22:59:31 +02:00
protected string $picture_type = 'none';
/**
* @var string
* @Assert\Choice(choices=LabelOptions::SUPPORTED_ELEMENTS)
* @ORM\Column(type="string")
*/
2022-09-18 22:59:31 +02:00
protected string $supported_element = 'part';
/**
2020-08-21 21:36:22 +02:00
* @var string any additional CSS for the label
* @ORM\Column(type="text")
*/
2022-09-18 22:59:31 +02:00
protected string $additional_css = '';
2020-08-21 21:36:22 +02:00
/** @var string The mode that will be used to interpret the lines
* @Assert\Choice(choices=LabelOptions::LINES_MODES)
* @ORM\Column(type="string")
*/
2022-09-18 22:59:31 +02:00
protected string $lines_mode = 'html';
/**
* @var string
* @ORM\Column(type="text")
*/
2022-09-18 22:59:31 +02:00
protected string $lines = '';
public function getWidth(): float
{
return $this->width;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setWidth(float $width): self
{
$this->width = $width;
2020-05-10 21:39:31 +02:00
return $this;
}
public function getHeight(): float
{
return $this->height;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setHeight(float $height): self
{
$this->height = $height;
2020-05-10 21:39:31 +02:00
return $this;
}
public function getBarcodeType(): string
{
return $this->barcode_type;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setBarcodeType(string $barcode_type): self
{
$this->barcode_type = $barcode_type;
2020-05-10 21:39:31 +02:00
return $this;
}
public function getPictureType(): string
{
return $this->picture_type;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setPictureType(string $picture_type): self
{
$this->picture_type = $picture_type;
2020-05-10 21:39:31 +02:00
return $this;
}
public function getSupportedElement(): string
{
return $this->supported_element;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setSupportedElement(string $supported_element): self
{
$this->supported_element = $supported_element;
2020-05-10 21:39:31 +02:00
return $this;
}
public function getLines(): string
{
return $this->lines;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setLines(string $lines): self
{
$this->lines = $lines;
2020-05-10 21:39:31 +02:00
return $this;
}
/**
2020-05-10 21:39:31 +02:00
* Gets additional CSS (it will simply be attached.
*/
public function getAdditionalCss(): string
{
return $this->additional_css;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setAdditionalCss(string $additional_css): self
{
$this->additional_css = $additional_css;
2020-05-10 21:39:31 +02:00
return $this;
}
public function getLinesMode(): string
{
return $this->lines_mode;
}
/**
* @return LabelOptions
*/
2020-05-10 21:39:31 +02:00
public function setLinesMode(string $lines_mode): self
{
$this->lines_mode = $lines_mode;
2020-05-10 21:39:31 +02:00
return $this;
}
2020-05-10 21:39:31 +02:00
}