src/Entity/Term/AbstractTerm.php line 15

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Term;
  5. use Doctrine\ORM\Mapping as ORM;
  6. use JMS\Serializer\Annotation as Serializer;
  7. use Symfony\Component\Validator\Constraints as Assert;
  8. use App\Entity\Core\AbstractOrganization;
  10. /**
  11.  * Class AbstractTerm.
  12.  *
  13.  * @ORM\MappedSuperclass()
  14.  */
  15. abstract class AbstractTerm implements VocabularyInterface
  16. {
  17.     use SortableTrait;
  19.     /**
  20.      * @var string
  21.      */
  22.     protected $vocabularyId;
  24.     /**
  25.      * @var int
  26.      *
  27.      * @ORM\Column(name="id", type="integer")
  28.      * @ORM\Id
  29.      * @ORM\GeneratedValue(strategy="AUTO")
  30.      * @Serializer\Groups({"Default", "api"})
  31.      */
  32.     private $id;
  34.     /**
  35.      * @var string
  36.      *
  37.      * @ORM\Column(name="name", type="string", length=255)
  38.      * @Assert\NotBlank()
  39.      * @Serializer\Groups({"Default", "api"})
  40.      */
  41.     private $name;
  43.     /**
  44.      * @var bool
  45.      * @ORM\Column(name="private", type="boolean")
  46.      * @Serializer\Groups({"Default", "api"})
  47.      */
  48.     private $private = false;
  50.     private $label = null;
  52.     /**
  53.      * @var AbstractOrganization
  54.      * @ORM\ManyToOne(targetEntity="App\Entity\Core\AbstractOrganization")
  55.      * @ORM\JoinColumn(nullable=true, onDelete="CASCADE")
  56.      */
  57.     protected $organization;
  59.     /**
  60.      * @var string
  61.      * @ORM\Column(name="machine_name", type="string", length=255, nullable=true)
  62.      */
  63.     protected $machinename;
  65.     /**
  66.      * @return mixed
  67.      */
  68.     abstract public function getVocabularyName();
  70.     /**
  71.      * @param $label
  72.      */
  73.     public function setVocabularyLabel($label)
  74.     {
  75.         $this->label = $label;
  76.     }
  78.     /**
  79.      * @return string
  80.      */
  81.     public function getVocabularyLabel()
  82.     {
  83.         return $this->label ? $this->label : $this->getVocabularyName();
  84.     }
  86.     /**
  87.      * @return string
  88.      */
  89.     public function __toString()
  90.     {
  91.         return $this->getName();
  92.     }
  94.     /**
  95.      * @param int $id
  96.      */
  97.     public function setId($id)
  98.     {
  99.         $this->id = $id;
  100.     }
  102.     /**
  103.      * @return int
  104.      */
  105.     public function getId()
  106.     {
  107.         return $this->id;
  108.     }
  110.     /**
  111.      * @param string $name
  112.      */
  113.     public function setName($name)
  114.     {
  115.         $this->name = $name;
  116.     }
  118.     /**
  119.      * @return string
  120.      */
  121.     public function getName()
  122.     {
  123.         return $this->name;
  124.     }
  126.     /**
  127.      * @return mixed
  128.      */
  129.     public function getPrivate()
  130.     {
  131.         return $this->private;
  132.     }
  134.     /**
  135.      * @param mixed $private
  136.      */
  137.     public function setPrivate($private)
  138.     {
  139.         $this->private = $private;
  140.     }
  142.     /**
  143.      * @param AbstractOrganization $organization
  144.      */
  145.     public function setOrganization($organization)
  146.     {
  147.         $this->organization = $organization;
  148.     }
  150.     /**
  151.      * @return AbstractOrganization
  152.      */
  153.     public function getOrganization()
  154.     {
  155.         return $this->organization;
  156.     }
  158.     /**
  159.      * api helper.
  160.      *
  161.      * @Serializer\VirtualProperty
  162.      * @Serializer\Groups({"Default", "api"})
  163.      *
  164.      * @return int
  165.      */
  166.     public function getOrganizationId()
  167.     {
  168.         return $this->getOrganization() ? $this->getOrganization()->getId() : null;
  169.     }
  171.     /**
  172.      * @return string|null
  173.      */
  174.     public function getMachinename()
  175.     {
  176.         return $this->machinename;
  177.     }
  179.     /**
  180.      * @param string
  181.      */
  182.     public function setMachinename($machineName)
  183.     {
  184.         $this->machinename = $machineName;
  185.     }
  187.     /**
  188.      * If term is used for internal system processes.
  189.      *
  190.      * @return bool
  191.      */
  192.     public function isLocked($machineName = null)
  193.     {
  194.         return !empty($this->machinename);
  195.     }
  197.     /**
  198.      * Check machine name match.
  199.      *
  200.      * @param $machineName
  201.      *
  202.      * @return bool
  203.      */
  204.     public function isMachinename($machineName)
  205.     {
  206.         return $this->machinename === $machineName;
  207.     }
  209.     /**
  210.      * @return mixed
  211.      */
  212.     public function getVocabularyId()
  213.     {
  214.         return $this->vocabularyId;
  215.     }
  217.     /**
  218.      * @param string $id
  219.      */
  220.     public function setVocabularyId($id)
  221.     {
  222.         $this->vocabularyId = $id;
  223.     }
  225.     /**
  226.      * @return mixed
  227.      *               This static method is used to set a specific order field
  228.      *               when fetch terms
  229.      */
  230.     public static function orderBy()
  231.     {
  232.         return 'name';
  233.     }
  234. }