src/Entity/LogEntry.php line 20

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Exception\InvalidArgumentException;
  6. use DateTime;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Symfony\Component\Validator\Constraints as Assert;
  10. /**
  11.  * @ORM\Entity(
  12.  *     repositoryClass="App\Repository\LogEntryRepository"
  13.  * )
  14.  * @ORM\Table(
  15.  *     name="log_entry",
  16.  *     options={"collate"="utf8_swedish_ci"}
  17.  * )
  18.  * @ORM\HasLifecycleCallbacks
  19.  */
  20. class LogEntry implements EntityInterface
  21. {
  22.     const TYPE_CREATE = 'create';
  23.     const TYPE_STATUS = 'status';
  24.     const TYPE_UPDATE = 'update';
  26.     /**
  27.      * @ORM\Id
  28.      * @ORM\Column(
  29.      *     type="integer"
  30.      * )
  31.      * @ORM\GeneratedValue(
  32.      *     strategy="AUTO"
  33.      * )
  34.      *
  35.      * @var int|null
  36.      */
  37.     protected ?int $id = null;
  39.     /**
  40.      * @ORM\Column(
  41.      *     type="string",
  42.      *     length=2000,
  43.      *     nullable=true
  44.      * )
  45.      *
  46.      * @var string|null
  47.      */
  48.     protected ?string $note = null;
  50.     /**
  51.      * @ORM\Column(
  52.      *     type="datetime"
  53.      * )
  54.      * @Assert\NotNull
  55.      *
  56.      * @var DateTime
  57.      */
  58.     protected DateTime $time;
  60.     /**
  61.      * @ORM\Column(
  62.      *     type="string",
  63.      *     length=10
  64.      * )
  65.      *
  66.      * @var string
  67.      */
  68.     protected string $type = self::TYPE_UPDATE;
  70.     /**
  71.      * @ORM\ManyToOne(
  72.      *     targetEntity="User"
  73.      * )
  74.      * @ORM\JoinColumn(
  75.      *     name="user_id",
  76.      *     referencedColumnName="id",
  77.      *     onDelete="SET NULL"
  78.      * )
  79.      *
  80.      * @var User|null
  81.      */
  82.     protected ?User $user = null;
  84.     /**
  85.      * @ORM\Column(
  86.      *     name="user_name",
  87.      *     type="string",
  88.      *     length=200
  89.      * )
  90.      * @Assert\NotNull
  91.      *
  92.      * @var string
  93.      */
  94.     protected string $userName;
  96.     /**
  97.      * @param User        $user
  98.      * @param string      $type
  99.      * @param string|null $note
  100.      *
  101.      * @throws InvalidArgumentException
  102.      */
  103.     public function __construct(User $user, string $type = self::TYPE_UPDATE, ?string $note = null)
  104.     {
  105.         $this->setUser($user);
  106.         $this->setType($type);
  107.         $this->setNote($note);
  108.         $this->time = new DateTime();
  109.     }
  111.     /**
  112.      * @return string|null
  113.      */
  114.     public function getNote(): ?string
  115.     {
  116.         return $this->note;
  117.     }
  119.     /**
  120.      * @return int|null
  121.      */
  122.     public function getId(): ?int
  123.     {
  124.         return $this->id;
  125.     }
  127.     /**
  128.      * @return DateTime
  129.      */
  130.     public function getTime(): DateTime
  131.     {
  132.         return $this->time;
  133.     }
  135.     /**
  136.      * @return string
  137.      */
  138.     public function getType(): string
  139.     {
  140.         return $this->type;
  141.     }
  143.     /**
  144.      * @return User|null
  145.      */
  146.     public function getUser(): ?User
  147.     {
  148.         return $this->user;
  149.     }
  151.     /**
  152.      * @return string|null
  153.      */
  154.     public function getUserName(): ?string
  155.     {
  156.         if (null !== $this->user) {
  157.             return $this->user->getName();
  158.         }
  160.         return $this->userName;
  161.     }
  163.     /**
  164.      * @param string|null $note
  165.      */
  166.     public function setNote(?string $note)
  167.     {
  168.         $this->note = $note;
  169.     }
  171.     /**
  172.      * @param DateTime $time
  173.      */
  174.     public function setTime(DateTime $time)
  175.     {
  176.         $this->time = $time;
  177.     }
  179.     /**
  180.      * @param string $type
  181.      *
  182.      * @throws InvalidArgumentException
  183.      */
  184.     public function setType(string $type)
  185.     {
  186.         if ($type != self::TYPE_CREATE && $type != self::TYPE_STATUS && $type != self::TYPE_UPDATE) {
  187.             throw new InvalidArgumentException('Invalid log entry type.');
  188.         }
  189.         $this->type = $type;
  190.     }
  192.     /**
  193.      * @param User $user
  194.      */
  195.     public function setUser(User $user)
  196.     {
  197.         $this->user = $user;
  198.         $this->userName = $user->getName();
  199.     }
  200. }