symfony-doge/veslo

<?php

/*
 * This file is part of the Veslo project <https://github.com/symfony-doge/veslo>.
 *
 * (C) 2019 Pavel Petrov <itnelo@gmail.com>.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://opensource.org/licenses/GPL-3.0 GPL-3.0
 */

declare(strict_types=1);

namespace Veslo\SanityBundle\Entity\Vacancy;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
use Veslo\SanityBundle\Entity\Vacancy\Tag\Group;
use Veslo\SanityBundle\Entity\Vacancy\Tag\Translation\Entry;

/**
 * Sanity tag
 *
 * @ORM\Table(name="sanity_vacancy_tag")
 * @ORM\Entity(readOnly=true)
 * @ORM\Cache(usage="READ_ONLY", region="index")
 * @Gedmo\TranslationEntity(class="Veslo\SanityBundle\Entity\Vacancy\Tag\Translation\Entry")
 */
class Tag
{
    /**
     * Sanity tag identifier
     *
     * @var int
     *
     * @ORM\Column(name="id", type="integer", options={"comment": "Sanity tag identifier"})
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * Group to which sanity tag belongs to
     *
     * @var Group
     *
     * @ORM\ManyToOne(targetEntity="Veslo\SanityBundle\Entity\Vacancy\Tag\Group", inversedBy="tags")
     * @ORM\JoinColumn(name="group_id", referencedColumnName="id", onDelete="CASCADE")
     */
    private $group;

    /**
     * Sanity tag name
     *
     * @var string
     *
     * @ORM\Column(name="name", type="string", length=255, unique=true, options={"comment": "Sanity tag name"})
     */
    private $name;

    /**
     * Sanity tag title
     *
     * @var string
     *
     * @ORM\Column(name="title", type="string", length=255, options={"comment": "Sanity tag title"})
     * @Gedmo\Translatable
     */
    private $title;

    /**
     * Sanity tag description
     *
     * @var string
     *
     * @ORM\Column(name="description", type="text", options={"comment": "Sanity tag description"})
     * @Gedmo\Translatable
     */
    private $description;

    /**
     * Sanity tag color
     *
     * @var string
     *
     * @ORM\Column(name="color", type="string", length=255, options={"comment": "Sanity tag color"})
     */
    private $color;

    /**
     * Sanity tag image URL
     *
     * @var string
     *
     * @ORM\Column(name="image_url", type="string", length=255, options={"comment": "Sanity tag image URL"})
     */
    private $imageUrl;

    /**
     * Translation entries for sanity tag fields
     *
     * @var Collection<Entry>
     *
     * @ORM\OneToMany(
     *     targetEntity="Veslo\SanityBundle\Entity\Vacancy\Tag\Translation\Entry",
     *     mappedBy="object",
     *     cascade={"persist"}
     * )
     */
    private $translations;

    /**
     * Indexes to which sanity tag was offered by indexation result
     *
     * @var Collection<Index>
     *
     * @ORM\ManyToMany(targetEntity="Veslo\SanityBundle\Entity\Vacancy\Index", mappedBy="tags")
     */
    private $indexes;

    /**
     * Tag constructor.
     */
    public function __construct()
    {
        $this->translations = new ArrayCollection();
        $this->indexes      = new ArrayCollection();
    }

    /**
     * Returns sanity tag identifier
     *
     * @return int
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * Returns group to which sanity tag belongs to
     *
     * @return Group
     */
    public function getGroup(): Group
    {
        return $this->group;
    }

    /**
     * Sets group to which sanity tag belongs to
     *
     * @param Group $group Group to which sanity tag belongs to
     *
     * @return void
     */
    public function setGroup(Group $group): void
    {
        // Group change for sanity tag normally should not happen.
        // We do not directly control sanity index data, it comes from external source.
        if ($this->group instanceof Group) {
            return;
        }

        $this->group = $group;
        $group->addTag($this);
    }

    /**
     * Returns sanity tag name
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Sets sanity tag name
     *
     * @param string $name Sanity tag name
     *
     * @return void
     */
    public function setName(string $name): void
    {
        $this->name = $name;
    }

    /**
     * Returns sanity tag title
     *
     * @return string
     */
    public function getTitle(): string
    {
        return $this->title;
    }

    /**
     * Sets sanity tag title
     *
     * @param string $title Sanity tag title
     *
     * @return void
     */
    public function setTitle(string $title): void
    {
        $this->title = $title;
    }

    /**
     * Returns sanity tag description
     *
     * @return string
     */
    public function getDescription(): string
    {
        return $this->description;
    }

    /**
     * Sets sanity tag description
     *
     * @param string $description Sanity tag description
     */
    public function setDescription(string $description): void
    {
        $this->description = $description;
    }

    /**
     * Returns sanity tag color
     *
     * @return string
     */
    public function getColor(): string
    {
        return $this->color;
    }

    /**
     * Sets sanity tag color
     *
     * @param string $color Sanity tag color
     *
     * @return void
     */
    public function setColor(string $color): void
    {
        $this->color = $color;
    }

    /**
     * Returns sanity tag image URL
     *
     * @return string
     */
    public function getImageUrl(): string
    {
        return $this->imageUrl;
    }

    /**
     * Sets sanity tag image URL
     *
     * @param string $imageUrl Sanity tag image URL
     *
     * @return void
     */
    public function setImageUrl(string $imageUrl): void
    {
        $this->imageUrl = $imageUrl;
    }

    /**
     * Returns translation entries for sanity tag fields
     *
     * @return Entry[]
     */
    public function getTranslations(): array
    {
        return $this->translations->toArray();
    }

    /**
     * Adds a translation entry for sanity tag field
     *
     * @param Entry $translation Sanity tag translation entry
     *
     * @return void
     */
    public function addTranslation(Entry $translation): void
    {
        if ($this->translations->contains($translation)) {
            return;
        }

        $this->translations->add($translation);
        $translation->setObject($this);
    }

    /**
     * Returns indexes to which sanity tag was offered
     *
     * @return Index[]
     */
    public function getIndexes(): array
    {
        return $this->indexes->toArray();
    }

    /**
     * Adds an index to which sanity tag was offered
     *
     * @param Index $index Index to which sanity tag was offered
     *
     * @return void
     */
    public function addIndex(Index $index): void
    {
        if ($this->indexes->contains($index)) {
            return;
        }

        $this->indexes->add($index);
        $index->addTag($this);
    }
}