src/Entity/TemperatureNotification.php line 36

Open in your IDE?
  1. <?php
  2. /**
  3.  * @license Silk Software House Sp. Z O.O.
  4.  */
  6. declare(strict_types=1);
  8. namespace App\Entity;
  10. use App\Entity\Interfaces\ChannelInterface;
  11. use App\Entity\Traits\IdTrait;
  12. use App\Entity\Traits\TimePreUpdateTrait;
  13. use App\Entity\Traits\TimeTrait;
  14. use App\Validator\Constraints as AppAssert;
  15. use DateTime;
  16. use Doctrine\ORM\Mapping as ORM;
  17. use Symfony\Component\Validator\Constraints as Assert;
  19. /**
  20.  * A one-shot temperature alarm for one configured measurement channel.
  21.  *
  22.  * @ORM\Entity(repositoryClass="App\Repository\TemperatureNotificationRepository")
  23.  * @ORM\Table(
  24.  *     name="temperature_notifications",
  25.  *     indexes={
  26.  *         @ORM\Index(name="IDX_TEMPERATURE_NOTIFICATION_USER", columns={"user_id"}),
  27.  *         @ORM\Index(name="IDX_TEMPERATURE_NOTIFICATION_CHANNEL", columns={"channel_setting_id"}),
  28.  *         @ORM\Index(name="IDX_TEMPERATURE_NOTIFICATION_PENDING", columns={"channel_setting_id", "id"}, options={"where": "(triggered_at IS NULL)"})
  29.  *     },
  30.  *     uniqueConstraints={
  31.  *         @ORM\UniqueConstraint(name="UNIQ_TEMPERATURE_NOTIFICATION_PENDING", columns={"user_id", "channel_setting_id", "temperature_trigger", "direction", "email"}, options={"where": "(triggered_at IS NULL)"})
  32.  *     }
  33.  * )
  34.  * @ORM\HasLifecycleCallbacks()
  35.  */
  36. class TemperatureNotification implements ChannelInterface
  37. {
  38.     use IdTrait;
  39.     use TimeTrait;
  40.     use TimePreUpdateTrait;
  42.     public const DIRECTION_ABOVE = 'above';
  43.     public const DIRECTION_BELOW = 'below';
  44.     public const DIRECTIONS = [
  45.         self::DIRECTION_ABOVE,
  46.         self::DIRECTION_BELOW,
  47.     ];
  49.     public const MINIMUM_TEMPERATURE = -273.15;
  50.     public const MAXIMUM_TEMPERATURE = 1416833.0;
  52.     /**
  53.      * @ORM\ManyToOne(targetEntity="App\Entity\User", cascade={"persist"})
  54.      * @ORM\JoinColumn(name="user_id", nullable=false)
  55.      */
  56.     private User $user;
  58.     /**
  59.      * @AppAssert\ChannelNotBlank()
  60.      *
  61.      * @ORM\ManyToOne(targetEntity="App\Entity\ChannelSetting", cascade={"persist"})
  62.      * @ORM\JoinColumn(name="channel_setting_id", nullable=false)
  63.      */
  64.     private ChannelSetting $channelSetting;
  66.     /**
  67.      * @Assert\NotNull()
  68.      * @Assert\Range(min="-273.15", max="1416833")
  69.      *
  70.      * @ORM\Column(name="temperature_trigger", type="float", nullable=false, options={"comment": "Temperature in degrees Celsius that triggers this notification."})
  71.      */
  72.     private float $temperatureTrigger;
  74.     /**
  75.      * @Assert\Choice(choices={"above", "below"})
  76.      *
  77.      * @ORM\Column(name="direction", type="string", length=16, nullable=false, options={"default": "above", "comment": "Alarm direction: above or below."})
  78.      */
  79.     private string $direction = self::DIRECTION_ABOVE;
  81.     /**
  82.      * @ORM\Column(name="triggered_at", type="datetime", nullable=true, options={"comment": "When this notification was triggered."})
  83.      */
  84.     private ?DateTime $triggeredAt = null;
  86.     /**
  87.      * @Assert\Email()
  88.      *
  89.      * @ORM\Column(name="email", type="string", length=255, nullable=true)
  90.      */
  91.     private ?string $email = null;
  93.     public function getUser(): ?User
  94.     {
  95.         return $this->user ?? null;
  96.     }
  98.     public function setUser(User $user): self
  99.     {
  100.         $this->user = $user;
  102.         return $this;
  103.     }
  105.     public function getChannelSetting(): ?ChannelSetting
  106.     {
  107.         return $this->channelSetting ?? null;
  108.     }
  110.     public function setChannelSetting(ChannelSetting $channelSetting): self
  111.     {
  112.         $this->channelSetting = $channelSetting;
  114.         return $this;
  115.     }
  117.     public function getTemperatureTrigger(): ?float
  118.     {
  119.         return $this->temperatureTrigger ?? null;
  120.     }
  122.     public function setTemperatureTrigger(float $temperatureTrigger): self
  123.     {
  124.         $this->temperatureTrigger = $temperatureTrigger;
  126.         return $this;
  127.     }
  129.     public function getDirection(): string
  130.     {
  131.         return $this->direction;
  132.     }
  134.     public function setDirection(string $direction): self
  135.     {
  136.         $this->direction = $direction;
  138.         return $this;
  139.     }
  141.     public function getTriggeredAt(): ?DateTime
  142.     {
  143.         return $this->triggeredAt;
  144.     }
  146.     public function setTriggeredAt(?DateTime $triggeredAt): self
  147.     {
  148.         $this->triggeredAt = $triggeredAt;
  150.         return $this;
  151.     }
  153.     public function getIsTriggered(): bool
  154.     {
  155.         return null !== $this->triggeredAt;
  156.     }
  158.     public function isTriggeredBy(float $temperature): bool
  159.     {
  160.         if (!isset($this->temperatureTrigger)) {
  161.             return false;
  162.         }
  164.         if (self::DIRECTION_ABOVE === $this->direction) {
  165.             return $temperature >= $this->temperatureTrigger;
  166.         }
  168.         return self::DIRECTION_BELOW === $this->direction
  169.             && $temperature <= $this->temperatureTrigger;
  170.     }
  172.     public function getEmail(): ?string
  173.     {
  174.         return $this->email;
  175.     }
  177.     public function setEmail(?string $email): self
  178.     {
  179.         $this->email = $email;
  181.         return $this;
  182.     }
  184.     public function getMeasurement(): ?Measurement
  185.     {
  186.         if (!isset($this->channelSetting) || !$this->channelSetting->getMeasurementSetting()) {
  187.             return null;
  188.         }
  190.         return $this->channelSetting->getMeasurementSetting()->getMeasurement();
  191.     }
  193.     public function hasChannel(): bool
  194.     {
  195.         return isset($this->channelSetting);
  196.     }
  197. }