Files
kimai2/src/Entity/ColorTrait.php
Kevin Papst afb5a0bba4 Release 2.45 (#5721)
Co-authored-by: Henning Klein <info@henningklein.de>
2025-12-21 16:42:34 +01:00

63 lines
1.6 KiB
PHP

<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Entity;
use App\Constants;
use App\Export\Annotation as Exporter;
use App\Utils\Color;
use App\Validator\Constraints as Constraints;
use Doctrine\DBAL\Types\Types;
use Doctrine\ORM\Mapping as ORM;
use JMS\Serializer\Annotation as Serializer;
trait ColorTrait
{
/**
* The assigned color in HTML hex format, e.g. #dd1d00
*/
#[ORM\Column(name: 'color', type: Types::STRING, length: 7, nullable: true)]
#[Serializer\Exclude]
#[Exporter\Expose(label: 'color')]
#[Constraints\HexColor]
private ?string $color = null;
public function getColor(): ?string
{
if ($this->color === Constants::DEFAULT_COLOR) {
return null;
}
return $this->color;
}
public function hasColor(): bool
{
return null !== $this->color && $this->color !== Constants::DEFAULT_COLOR;
}
public function setColor(?string $color = null): void
{
$this->color = $color;
}
abstract public function getName(): ?string;
/**
* Internal value: this color will never be empty and is generated by the tag name if not set explicit.
*/
#[Serializer\VirtualProperty]
#[Serializer\SerializedName('color')]
#[Serializer\Groups(['Default'])]
public function getColorSafe(): string
{
return $this->getColor() ?? (new Color())->getRandom($this->getName());
}
}