src/Entity/LearningCourses/LearningCourse.php line 35

Open in your IDE?
  1. <?php
  3. namespace App\Entity\LearningCourses;
  5. use App\Annotation\SiteAware;
  6. use App\Entity\AbstractBase;
  7. use App\Entity\Interfaces\SiteInterface;
  8. use App\Entity\MiniAbstractBase;
  9. use App\Entity\Traits\ActiveTrait;
  10. use App\Entity\Traits\DescriptionTrait;
  11. use App\Entity\Traits\ImageFileNameTrait;
  12. use App\Entity\Traits\ImageFileTrait;
  13. use App\Entity\Traits\NameTrait;
  14. use App\Entity\Traits\SiteTrait;
  15. use App\Entity\User;
  16. use App\Enum\LearningCourseTypeEnum;
  17. use App\Repository\LearningCourses\LearningCourseRepository;
  18. use DateTimeImmutable;
  19. use DateTimeInterface;
  20. use Doctrine\Common\Collections\ArrayCollection;
  21. use Doctrine\Common\Collections\Collection;
  22. use Doctrine\ORM\Mapping as ORM;
  23. use Gedmo\Mapping\Annotation as Gedmo;
  24. use Symfony\Component\HttpFoundation\File\File;
  25. use Symfony\Component\Security\Core\User\UserInterface;
  26. use Vich\UploaderBundle\Mapping\Annotation as Vich;
  28. /**
  29.  * @ORM\Table(name="vulco_learning_course", indexes={@ORM\Index(name="learning_course_site_idx", columns={"site"})})
  30.  * @ORM\Entity(repositoryClass=LearningCourseRepository::class)
  31.  * @Gedmo\SoftDeleteable(fieldName="removedAt", timeAware=false)
  32.  * @SiteAware(siteFieldName="site")
  33.  * @Vich\Uploadable
  34.  */
  35. class LearningCourse extends AbstractBase implements SiteInterface
  36. {
  37.     use ActiveTrait;
  38.     use DescriptionTrait;
  39.     use ImageFileTrait;
  40.     use ImageFileNameTrait;
  41.     use NameTrait;
  42.     use SiteTrait;
  44.     /**
  45.      * @ORM\ManyToMany(targetEntity="App\Entity\User")
  46.      * @ORM\JoinTable(name="vulco_learning_courses_users",
  47.      *     joinColumns={@ORM\JoinColumn(name="learning_course_id", referencedColumnName="id")},
  48.      *     inverseJoinColumns={@ORM\JoinColumn(name="user_id", referencedColumnName="id")}
  49.      * )
  50.      */
  51.     private ?Collection $associatedUsers;
  53.     /**
  54.      * @ORM\ManyToOne(targetEntity="LearningCourseCategory", inversedBy="courses")
  55.      */
  56.     private ?LearningCourseCategory $category = null;
  58.     /**
  59.      * @ORM\OneToMany(targetEntity="LearningCourseRegistration", mappedBy="course", cascade={"persist", "remove"})
  60.      */
  61.     private ?Collection $registrations; // order here is important because cascade remove will remove registrations before sessions
  63.     /**
  64.      * @ORM\OneToMany(targetEntity="LearningCourseSession", mappedBy="course", cascade={"persist", "remove"})
  65.      * @ORM\OrderBy({"date": "ASC"})
  66.      */
  67.     private ?Collection $sessions;
  69.     /**
  70.      * @ORM\Column(type="string", length=255, nullable=false)
  71.      */
  72.     private string $name;
  74.     /**
  75.      * @ORM\Column(type="text", length=10000, nullable=true)
  76.      */
  77.     private ?string $description;
  79.     /**
  80.      * @Vich\UploadableField(mapping="learning_course_image", fileNameProperty="imageFileName")
  81.      */
  82.     private ?File $imageFile = null;
  84.     /**
  85.      * @ORM\Column(type="string", length=255, nullable=true)
  86.      */
  87.     private ?string $imageFileName = null;
  89.     /**
  90.      * @ORM\Column(type="integer", nullable=false, options={"default": 0})
  91.      */
  92.     private int $type = 0;
  94.     /**
  95.      * @ORM\Column(type="integer", nullable=false, options={"default": 0})
  96.      */
  97.     private int $status = 0;
  99.     /**
  100.      * @ORM\Column(type="string", length=255, nullable=true)
  101.      */
  102.     private ?string $totalHours = '';
  104.     /**
  105.      * @ORM\Column(type="integer", nullable=false, options={"default": 0})
  106.      */
  107.     private int $maximumCapacity = 0;
  109.     /**
  110.      * @ORM\Column(type="boolean", nullable=false, options={"default": 1})
  111.      */
  112.     private bool $limitRegistrationsPerGarage = true;
  114.     /**
  115.      * @ORM\Column(type="datetime", nullable=true)
  116.      */
  117.     private ?DateTimeInterface $endRegistrationPeriod;
  119.     /**
  120.      * @ORM\Column(type="boolean", nullable=false, options={"default": 1})
  121.      */
  122.     private bool $active = true;
  124.     public function __construct()
  125.     {
  126.         $this->associatedUsers = new ArrayCollection();
  127.         $this->sessions = new ArrayCollection();
  128.         $this->registrations = new ArrayCollection();
  129.     }
  131.     public function getAssociatedUsersAmount(): int
  132.     {
  133.         return $this->getAssociatedUsers()->count();
  134.     }
  136.     public function getAssociatedUsers(): Collection
  137.     {
  138.         return $this->associatedUsers;
  139.     }
  141.     public function setAssociatedUsers(?Collection $associatedUsers): self
  142.     {
  143.         $this->associatedUsers = $associatedUsers;
  145.         return $this;
  146.     }
  148.     public function addAssociatedUser(User $associatedUser): self
  149.     {
  150.         if (!$this->associatedUsers->contains($associatedUser)) {
  151.             $this->associatedUsers->add($associatedUser);
  152.         }
  154.         return $this;
  155.     }
  157.     public function removeAssociatedUser(User $associatedUser): self
  158.     {
  159.         if ($this->associatedUsers->contains($associatedUser)) {
  160.             $this->associatedUsers->removeElement($associatedUser);
  161.         }
  163.         return $this;
  164.     }
  166.     public function getSessions(): Collection
  167.     {
  168.         return $this->sessions;
  169.     }
  171.     public function addSession(LearningCourseSession $session): self
  172.     {
  173.         if (!$this->getSessions()->contains($session)) {
  174.             $session->setCourse($this);
  175.             $this->sessions->add($session);
  176.         }
  178.         return $this;
  179.     }
  181.     public function removeSession(LearningCourseSession $session): self
  182.     {
  183.         if ($this->getSessions()->contains($session)) {
  184.             $this->sessions->removeElement($session);
  185.         }
  187.         return $this;
  188.     }
  190.     public function getSessionsAmount(): int
  191.     {
  192.         return $this->getSessions()->count();
  193.     }
  195.     public function getRegistrations(): Collection
  196.     {
  197.         return $this->registrations;
  198.     }
  200.     public function getRegistrationsAmount(): int
  201.     {
  202.         return $this->getRegistrations()->count();
  203.     }
  205.     public function addRegistration(LearningCourseRegistration $registration): self
  206.     {
  207.         if (!$this->getRegistrations()->contains($registration)) {
  208.             $registration->setCourse($this);
  209.             $this->getRegistrations()->add($registration);
  210.         }
  212.         return $this;
  213.     }
  215.     public function removeRegistration(LearningCourseRegistration $registration): self
  216.     {
  217.         if ($this->getRegistrations()->contains($registration)) {
  218.             $this->getRegistrations()->removeElement($registration);
  219.         }
  221.         return $this;
  222.     }
  224.     public function getCategory(): ?LearningCourseCategory
  225.     {
  226.         return $this->category;
  227.     }
  229.     public function getCategoryName(): string
  230.     {
  231.         return $this->getCategory() ? $this->getCategory()->getName() : MiniAbstractBase::DEFAULT_EMPTY_STRING;
  232.     }
  234.     public function setCategory(?LearningCourseCategory $category): self
  235.     {
  236.         $this->category = $category;
  238.         return $this;
  239.     }
  241.     public function getType(): int
  242.     {
  243.         return $this->type;
  244.     }
  246.     public function getTypeAsTranlationKeyString(): string
  247.     {
  248.         return LearningCourseTypeEnum::getTranslatedEnumArray()[$this->getType()];
  249.     }
  251.     public function setType(int $type): self
  252.     {
  253.         $this->type = $type;
  255.         return $this;
  256.     }
  258.     public function getStatus(): int
  259.     {
  260.         return $this->status;
  261.     }
  263.     public function setStatus(int $status): self
  264.     {
  265.         $this->status = $status;
  267.         return $this;
  268.     }
  270.     public function getTotalHours(): ?string
  271.     {
  272.         return $this->totalHours;
  273.     }
  275.     public function setTotalHours(?string $totalHours): self
  276.     {
  277.         $this->totalHours = $totalHours;
  279.         return $this;
  280.     }
  282.     public function getMaximumCapacity(): int
  283.     {
  284.         return $this->maximumCapacity;
  285.     }
  287.     public function getCurrentCapacity(): int
  288.     {
  289.         return $this->getRegistrationsAmount();
  290.     }
  292.     public function getAvailableRegistersAmount(): int
  293.     {
  294.         return $this->getMaximumCapacity() - $this->getRegistrationsAmount();
  295.     }
  297.     public function isFull(): bool
  298.     {
  299.         return $this->getAvailableRegistersAmount() <= 0;
  300.     }
  302.     public function isRegistered(UserInterface $user): bool
  303.     {
  304.         /** @var LearningCourseRegistration $registration */
  305.         foreach ($this->getRegistrations() as $registration) {
  306.             if ($registration->getAssociatedUser() === $user) {
  307.                 return true;
  308.             }
  309.         }
  311.         return false;
  312.     }
  314.     public function setMaximumCapacity(int $maximumCapacity): self
  315.     {
  316.         $this->maximumCapacity = $maximumCapacity;
  318.         return $this;
  319.     }
  321.     public function isLimitRegistrationsPerGarage(): bool
  322.     {
  323.         return $this->limitRegistrationsPerGarage;
  324.     }
  326.     public function setLimitRegistrationsPerGarage(bool $limitRegistrationsPerGarage): LearningCourse
  327.     {
  328.         $this->limitRegistrationsPerGarage = $limitRegistrationsPerGarage;
  329.         return $this;
  330.     }
  332.     public function getEndRegistrationPeriod(): ?DateTimeInterface
  333.     {
  334.         return $this->endRegistrationPeriod;
  335.     }
  337.     public function isEndRegistrationPeriodExpired(): bool
  338.     {
  339.         return $this->getEndRegistrationPeriod() && (new DateTimeImmutable())->format('Y/m/d') > $this->getEndRegistrationPeriod()->format('Y/m/d');
  340.     }
  342.     public function getEndRegistrationPeriodAsString(): string
  343.     {
  344.         return $this->getDateAsString($this->endRegistrationPeriod);
  345.     }
  347.     public function setEndRegistrationPeriod(?DateTimeInterface $endRegistrationPeriod): self
  348.     {
  349.         $this->endRegistrationPeriod = $endRegistrationPeriod;
  351.         return $this;
  352.     }
  354.     public function getCourseBeginDate(): ?DateTimeInterface
  355.     {
  356.         $firstDate = null;
  357.         if ($this->getSessionsAmount() > 0) {
  358.             /** @var LearningCourseSession $session */
  359.             foreach ($this->getSessions() as $session) {
  360.                 if (is_null($firstDate)) {
  361.                     $firstDate = $session->getDate();
  362.                 } elseif ($firstDate->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT) > $session->getDate()->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT)) {
  363.                     $firstDate = $session->getDate();
  364.                 }
  365.             }
  366.         }
  368.         return $firstDate;
  369.     }
  371.     public function getCourseBeginDateAsString(): string
  372.     {
  373.         return $this->getDateAsString($this->getCourseBeginDate());
  374.     }
  376.     public function getCourseEndDate(): ?DateTimeInterface
  377.     {
  378.         $lastDate = null;
  379.         if ($this->getSessionsAmount() > 0) {
  380.             /** @var LearningCourseSession $session */
  381.             foreach ($this->getSessions() as $session) {
  382.                 if (is_null($lastDate)) {
  383.                     $lastDate = $session->getDate();
  384.                 } elseif ($lastDate->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT) <= $session->getDate()->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT)) {
  385.                     $lastDate = $session->getDate();
  386.                 }
  387.             }
  388.         }
  390.         return $lastDate;
  391.     }
  393.     public function getCourseEndDateAsString(): string
  394.     {
  395.         return $this->getDateAsString($this->getCourseEndDate());
  396.     }
  398.     public function isExpired(): bool
  399.     {
  400.         return $this->getCourseEndDate() && (new DateTimeImmutable())->format('Y/m/d') > $this->getCourseEndDate()->format('Y/m/d');
  401.     }
  402. }