src/Cms/SystemBundle/Entity/Announcement/SystemAnnouncement.php line 25

Open in your IDE?
  1. <?php
  3. namespace Cms\SystemBundle\Entity\Announcement;
  5. use Cms\CoreBundle\Entity\SystemEntity;
  6. use Cms\CoreBundle\Util\DateTimeUtils;
  7. use Cms\TenantBundle\Entity\Tenant;
  8. use DateTimeInterface;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\ORM\Mapping as ORM;
  13. /**
  14.  * Class SystemAnnouncement
  15.  * @package Cms\SystemBundle\Entity\Announcement
  16.  *
  17.  * @ORM\Entity(
  18.  *     repositoryClass = "Cms\SystemBundle\Doctrine\Announcement\SystemAnnouncementRepository"
  19.  * )
  20.  * @ORM\HasLifecycleCallbacks
  21.  * @ORM\Table(
  22.  *     name = "cms__system__announcements"
  23.  * )
  24.  */
  25. class SystemAnnouncement extends SystemEntity
  26. {
  27.     const STATES = [
  28.         self::STATES__SUCCESS,
  29.         self::STATES__INFO,
  30.         self::STATES__WARNING,
  31.         self::STATES__DANGER,
  32.     ];
  33.     const STATES__SUCCESS = 'success';
  34.     const STATES__INFO = 'info';
  35.     const STATES__WARNING = 'warning';
  36.     const STATES__DANGER = 'danger';
  38.     /**
  39.      * @var Collection|Tenant[]
  40.      *
  41.      * @ORM\ManyToMany(
  42.      *     targetEntity = "Cms\TenantBundle\Entity\Tenant",
  43.      * )
  44.      * @ORM\JoinTable(
  45.      *     name = "cms__tenant__system__announcement",
  46.      *     joinColumns = {
  47.      *         @ORM\JoinColumn(
  48.      *             name = "announcement_id",
  49.      *             referencedColumnName = "id",
  50.      *             onDelete = "CASCADE",
  51.      *         )
  52.      *     },
  53.      *     inverseJoinColumns = {
  54.      *         @ORM\JoinColumn(
  55.      *             name = "tenant_id",
  56.      *             referencedColumnName = "id",
  57.      *             onDelete = "CASCADE",
  58.      *         )
  59.      *     },
  60.      * )
  61.      */
  62.     protected Collection $tenants;
  64.     /**
  65.      * @var string|null
  66.      *
  67.      * @ORM\Column(
  68.      *     type = "string",
  69.      *     nullable = false,
  70.      * )
  71.      */
  72.     protected ?string $title = null;
  74.     /**
  75.      * @var string|null
  76.      *
  77.      * @ORM\Column(
  78.      *     type = "text",
  79.      *     nullable = true,
  80.      * )
  81.      */
  82.     protected ?string $description = null;
  84.     /**
  85.      * @var DateTimeInterface|null
  86.      *
  87.      * @ORM\Column(
  88.      *     type = "datetime",
  89.      *     nullable = false,
  90.      * )
  91.      */
  92.     protected ?DateTimeInterface $startTimestamp;
  94.     /**
  95.      * @var DateTimeInterface|null
  96.      *
  97.      * @ORM\Column(
  98.      *     type = "datetime",
  99.      *     nullable = false,
  100.      * )
  101.      */
  102.     protected ?DateTimeInterface $endTimestamp = null;
  104.     /**
  105.      * @var string
  106.      *
  107.      * @ORM\Column(
  108.      *     type = "string",
  109.      *     nullable = false,
  110.      *     options = {
  111.      *         "default" = self::STATES__INFO,
  112.      *     },
  113.      * )
  114.      */
  115.     protected string $state = self::STATES__INFO;
  117.     /**
  118.      *
  119.      */
  120.     public function __construct()
  121.     {
  122.         $this->tenants = new ArrayCollection();
  123.     }
  125.     /**
  126.      * Returns a list of related tenants
  127.      *
  128.      * @return Collection|Tenant[]
  129.      */
  130.     public function getTenants(): Collection
  131.     {
  132.         return $this->tenants;
  133.     }
  135.     /**
  136.      * Sets up tenants
  137.      *
  138.      * @param Collection|Tenant[] $tenants
  139.      * @return $this
  140.      */
  141.     public function setTenants(Collection $tenants): self
  142.     {
  143.         $this->tenants = $tenants;
  144.         return $this;
  145.     }
  147.     /**
  148.      * @return string|null
  149.      */
  150.     public function getTitle(): ?string
  151.     {
  152.         return $this->title;
  153.     }
  155.     /**
  156.      * @return string|null
  157.      */
  158.     public function getDescription(): ?string
  159.     {
  160.         return $this->description;
  161.     }
  163.     /**
  164.      * @return DateTimeInterface|null
  165.      */
  166.     public function getStartTimestamp(): ?DateTimeInterface
  167.     {
  168.         return $this->startTimestamp;
  169.     }
  171.     /**
  172.      * @return DateTimeInterface|null
  173.      */
  174.     public function getEndTimestamp(): ?DateTimeInterface
  175.     {
  176.         return $this->endTimestamp;
  177.     }
  179.     /**
  180.      * @return string
  181.      */
  182.     public function getState(): string
  183.     {
  184.         return $this->state;
  185.     }
  187.     /**
  188.      * @param string|null $title
  189.      * @return $this
  190.      */
  191.     public function setTitle(?string $title): self
  192.     {
  193.         $this->title = $title ?: null;
  194.         return $this;
  195.     }
  197.     /**
  198.      * @param string|null $description
  199.      * @return $this
  200.      */
  201.     public function setDescription(?string $description): self
  202.     {
  203.         $this->description = $description ?: null;
  204.         return $this;
  205.     }
  207.     /**
  208.      * @param DateTimeInterface|null $startTimestamp
  209.      * @return $this
  210.      */
  211.     public function setStartTimestamp(?DateTimeInterface $startTimestamp): self
  212.     {
  213.         $this->startTimestamp = $startTimestamp;
  214.         return $this;
  215.     }
  217.     /**
  218.      * @param DateTimeInterface|null $endTimestamp
  219.      * @return $this
  220.      */
  221.     public function setEndTimestamp(?DateTimeInterface $endTimestamp): self
  222.     {
  223.         $this->endTimestamp = $endTimestamp;
  224.         return $this;
  225.     }
  227.     /**
  228.      * @param string $state
  229.      * @return $this
  230.      * @throws \Exception
  231.      */
  232.     public function setState(string $state): self
  233.     {
  234.         if ( ! in_array(strtolower($state), self::STATES)) {
  235.             throw new \Exception(sprintf(
  236.                 'Invalid state of "%s".',
  237.                 $state
  238.             ));
  239.         }
  240.         $this->state = $state;
  241.         return $this;
  242.     }
  244.     /**
  245.      * @return bool
  246.      */
  247.     public function isValid(): bool
  248.     {
  249.         $now = DateTimeUtils::now();
  250.         return ($this->startTimestamp <= $now && $this->endTimestamp >= $now);
  251.     }
  252. }