src/Entity/LessonModule.php line 322

Open in your IDE?
  1. <?php
  3. namespace EADPlataforma\Entity;
  5. use Doctrine\ORM\Mapping as ORM;
  6. use Symfony\Component\Validator\Constraints as Assert;
  7. use EADPlataforma\Validator\Constraints as EADAssert;
  8. use EADPlataforma\Services\FileService;
  9. use EADPlataforma\Enum\LessonModuleEnum;
  10. use EADPlataforma\Util\StringUtil;
  11. use \DateTime;
  13. /**
  14.  * LessonModule
  15.  *
  16.  * @ORM\Table(name="lesson_module", indexes={
  17.  *      @ORM\Index(name="fk_lesson_module_user_id", columns={"user_id"}), 
  18.  *      @ORM\Index(name="fk_lesson_module_course_id", columns={"course_id"}),
  19.  *      @ORM\Index(name="fk_lesson_module_user_delete_id", columns={"user_delete_id"})
  20.  * })
  21.  *
  22.  * @ORM\Entity(repositoryClass="EADPlataforma\Repository\LessonModuleRepository")
  23.  */
  24. class LessonModule
  25. {
  26.     /**
  27.      * @var int
  28.      *
  29.      * @ORM\Column(name="id", type="integer", nullable=false)
  30.      * @ORM\Id
  31.      * @ORM\GeneratedValue(strategy="IDENTITY")
  32.      */
  33.     private $id;
  35.     /**
  36.      * @Assert\NotBlank(
  37.      *      message = "Deleted not informed"
  38.      * )
  39.      *
  40.      * @Assert\Choice(
  41.      *      choices = { 
  42.      *                      LessonModuleEnum::ITEM_NO_DELETED, 
  43.      *                      LessonModuleEnum::ITEM_ON_TRASH,
  44.      *                      LessonModuleEnum::ITEM_DELETED
  45.      *                },
  46.      *      message = "Delete Option Invalid"
  47.      * )
  48.      *
  49.      * @var int
  50.      *
  51.      * @ORM\Column(name="deleted", type="integer", nullable=false, options={"default"="0"})
  52.      */
  53.     private $deleted = LessonModuleEnum::ITEM_NO_DELETED;
  55.     /**
  56.      * @Assert\NotBlank(
  57.      *      message = "Order not informed"
  58.      * )
  59.      *
  60.      * @var int
  61.      *
  62.      * @ORM\Column(name="`order`", type="integer", nullable=false)
  63.      */
  64.     private $order;
  66.     /**
  67.      * @Assert\NotBlank(
  68.      *    message = "Title not informed"
  69.      * )
  70.      * 
  71.      * @Assert\Length(
  72.      *      min = 0,
  73.      *      max = 250
  74.      * )
  75.      *
  76.      * @var string
  77.      *
  78.      * @ORM\Column(name="title", type="string", length=255, nullable=false)
  79.      */
  80.     private $title;
  82.     /**
  83.      * @var string|null
  84.      *
  85.      * @ORM\Column(name="workload", type="string", length=10, nullable=true)
  86.      */
  87.     private $workload;
  89.     /**
  90.      * @Assert\NotBlank(
  91.      *    message = "Status not informed"
  92.      * )
  93.      *
  94.      * @Assert\Choice(
  95.      *      choices = { LessonModuleEnum::DRAFT, LessonModuleEnum::PUBLISHED },
  96.      *      message = "Status Invalid"
  97.      * )
  98.      *
  99.      * @var int
  100.      *
  101.      * @ORM\Column(name="status", type="integer", nullable=false, options={"default"="0"})
  102.      */
  103.     private $status = LessonModuleEnum::DRAFT;
  105.     /**
  106.      * @var string|null
  107.      *
  108.      * @ORM\Column(name="description", type="text", length=65535, nullable=true)
  109.      */
  110.     private $description;
  112.     /**
  113.      * @Assert\NotBlank(
  114.      *    message = "Course not informed"
  115.      * )
  116.      *
  117.      * @Assert\Valid
  118.      *
  119.      * @var \Course
  120.      *
  121.      * @ORM\ManyToOne(targetEntity="Course")
  122.      * @ORM\JoinColumns({
  123.      *   @ORM\JoinColumn(name="course_id", referencedColumnName="id", nullable=false)
  124.      * })
  125.      */
  126.     private $course;
  128.     /**
  129.      * @Assert\NotBlank(
  130.      *    message = "User not informed"
  131.      * )
  132.      *
  133.      * @Assert\Valid
  134.      *
  135.      * @var \User
  136.      *
  137.      * @ORM\ManyToOne(targetEntity="User")
  138.      * @ORM\JoinColumns({
  139.      *   @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=false)
  140.      * })
  141.      */
  142.     private $user;
  144.     /**
  145.      * @Assert\Valid
  146.      *
  147.      * @var \EADPlataforma\Entity\User
  148.      *
  149.      * @ORM\ManyToOne(targetEntity="User")
  150.      * @ORM\JoinColumns({
  151.      *   @ORM\JoinColumn(name="user_delete_id", referencedColumnName="id", nullable=true)
  152.      * })
  153.      */
  154.     private $userDelete;
  156.     /**
  157.      * @Assert\Choice(
  158.      *      choices = { 
  159.      *                      LessonModuleEnum::INDIVIDUAL, 
  160.      *                      LessonModuleEnum::CASCADE
  161.      *                },
  162.      *      message = "Type Delete Invalid"
  163.      * )
  164.      *
  165.      * @var int
  166.      *
  167.      * @ORM\Column(name="type_delete", type="integer", nullable=true)
  168.      */
  169.     private $typeDelete;
  171.     /**
  172.      * @EADAssert\DateTimeEAD(
  173.      *      message = "Date Delete Invalid"
  174.      * )
  175.      *
  176.      * @var \DateTime|null
  177.      *
  178.      * @ORM\Column(name="date_delete", type="datetime", nullable=true)
  179.      */
  180.     private $dateDelete;
  182.     /**
  183.      * @Assert\NotBlank(
  184.      *    message = "Control Requirement not informed"
  185.      * )
  186.      *
  187.      * @Assert\Choice(
  188.      *      choices = { LessonModuleEnum::NO, LessonModuleEnum::YES },
  189.      *      message = "Control Requirement Invalid"
  190.      * )
  191.      *
  192.      * @var int
  193.      *
  194.      * @ORM\Column(name="control_requirement", type="integer", nullable=false, options={"default"="0"})
  195.      */
  196.     private $controlRequirement = LessonModuleEnum::NO;
  198.     /**
  199.      * @Assert\NotBlank(
  200.      *    message = "Control Release Type not informed"
  201.      * )
  202.      *
  203.      * @Assert\Choice(
  204.      *      choices = { LessonModuleEnum::RELEASED, LessonModuleEnum::FIXED_DATE, LessonModuleEnum::FLEXIBLE_DATE },
  205.      *      message = "Control Release Type Invalid"
  206.      * )
  207.      *
  208.      * @var int
  209.      *
  210.      * @ORM\Column(name="control_release_type", type="integer", nullable=false, options={"default"="0"})
  211.      */
  212.     private $controlReleaseType = LessonModuleEnum::RELEASED;
  214.     /**
  215.      * @Assert\NotBlank(
  216.      *    message = "Control Release After Type not informed",
  217.      *    groups  = "lssonControlReleaseTypeFlex",
  218.      * )
  219.      *
  220.      * @Assert\Choice(
  221.      *      choices = { LessonModuleEnum::ENROLLMENT, LessonModuleEnum::LAST_MODULE },
  222.      *      message = "Control Release After Type Invalid",
  223.      *      groups  = "lssonControlReleaseTypeFlex",
  224.      * )
  225.      *
  226.      * @var int
  227.      *
  228.      * @ORM\Column(name="control_release_after_type", type="integer", nullable=false, options={"default"="1"})
  229.      */
  230.     private $controlReleaseAfterType = LessonModuleEnum::LAST_MODULE;
  232.     /**
  233.      * @Assert\NotBlank(
  234.      *    message = "Control Release Date not informed",
  235.      *    groups  = "lssonControlReleaseTypeFixed",
  236.      * )
  237.      *
  238.      * @EADAssert\DateTimeEAD(
  239.      *      message = "Control Release Date Invalid"
  240.      * )
  241.      *
  242.      * @var \DateTime|null
  243.      *
  244.      * @ORM\Column(name="control_date_release", type="datetime", nullable=true)
  245.      */
  246.     private $controlDateRelease;
  248.     /**
  249.      * @Assert\NotBlank(
  250.      *    message = "Control Release Period not informed",
  251.      *    groups  = "lssonControlReleaseTypeFlex",
  252.      * )
  253.      *
  254.      * @var int|null
  255.      *
  256.      * @ORM\Column(name="control_release_period", type="integer", nullable=true)
  257.      */
  258.     private $controlReleasePeriod;
  260.     /**
  261.      * @var int|null
  262.      *
  263.      * @ORM\Column(name="control_close_period", type="integer", nullable=true)
  264.      */
  265.     private $controlClosePeriod;
  267.     public function getId(): ?int
  268.     {
  269.         return $this->id;
  270.     }
  272.     public function getOrder(): ?int
  273.     {
  274.         return $this->order;
  275.     }
  277.     public function setOrder(int $order): self
  278.     {
  279.         $this->order = $order;
  281.         return $this;
  282.     }
  284.     public function getTitle(): ?string
  285.     {
  286.         return StringUtil::fromUnicode(StringUtil::encodeStringStatic($this->title));
  287.     }
  289.     public function setTitle(string $title): self
  290.     {
  291.         $this->title = StringUtil::toUnicode($title);
  293.         return $this;
  294.     }
  296.     public function getWorkload(): ?string
  297.     {
  298.         return $this->workload;
  299.     }
  301.     public function setWorkload(?string $workload): self
  302.     {
  303.         $this->workload = $workload;
  305.         return $this;
  306.     }
  308.     public function getStatus(): ?int
  309.     {
  310.         return $this->status;
  311.     }
  313.     public function setStatus(int $status): self
  314.     {
  315.         $this->status = $status;
  317.         return $this;
  318.     }
  320.     public function getDescription(): ?string
  321.     {
  322.         return StringUtil::fromUnicode(StringUtil::encodeStringStatic($this->description));
  323.     }
  325.     public function setDescription(?string $description): self
  326.     {
  327.         $this->description = StringUtil::toUnicode($description);
  330.         return $this;
  331.     }
  333.     public function getControlRequirement(): ?int
  334.     {
  335.         return $this->controlRequirement;
  336.     }
  338.     public function setControlRequirement(int $controlRequirement): self
  339.     {
  340.         $this->controlRequirement = $controlRequirement;
  342.         return $this;
  343.     }
  345.     public function getControlReleaseType(): ?int
  346.     {
  347.         return $this->controlReleaseType;
  348.     }
  350.     public function setControlReleaseType(int $controlReleaseType): self
  351.     {
  352.         $this->controlReleaseType = $controlReleaseType;
  354.         return $this;
  355.     }
  357.     public function getControlReleaseAfterType(): ?int
  358.     {
  359.         return $this->controlReleaseAfterType;
  360.     }
  362.     public function setControlReleaseAfterType(int $controlReleaseAfterType): self
  363.     {
  364.         $this->controlReleaseAfterType = $controlReleaseAfterType;
  366.         return $this;
  367.     }
  369.     public function getControlDateRelease($dateFormat = 'Y-m-d H:i:s')
  370.     {
  371.         if($this->controlDateRelease){
  372.             return $this->controlDateRelease->format($dateFormat);
  373.         }
  374.         return $this->controlDateRelease;
  375.     }
  377.     public function setControlDateRelease($controlDateRelease): self
  378.     {
  379.         if($controlDateRelease){
  380.             $controlDateRelease = DateTime::createFromFormat('Y-m-d H:i:s', $controlDateRelease);
  381.         }
  382.         
  383.         $this->controlDateRelease = $controlDateRelease;
  385.         return $this;
  386.     }
  388.     public function getControlReleasePeriod(): ?int
  389.     {
  390.         return $this->controlReleasePeriod;
  391.     }
  393.     public function setControlReleasePeriod(?int $controlReleasePeriod): self
  394.     {
  395.         $this->controlReleasePeriod = $controlReleasePeriod;
  397.         return $this;
  398.     }
  400.     public function getControlClosePeriod(): ?int
  401.     {
  402.         return $this->controlClosePeriod;
  403.     }
  405.     public function setControlClosePeriod(?int $controlClosePeriod): self
  406.     {
  407.         $this->controlClosePeriod = $controlClosePeriod;
  409.         return $this;
  410.     }
  413.     public function getCourse(): ?Course
  414.     {
  415.         return $this->course;
  416.     }
  418.     public function setCourse(?Course $course): self
  419.     {
  420.         $this->course = $course;
  422.         return $this;
  423.     }
  425.     public function getUser(): ?User
  426.     {
  427.         return $this->user;
  428.     }
  430.     public function setUser(?User $user): self
  431.     {
  432.         $this->user = $user;
  434.         return $this;
  435.     }
  437.     public function getUserDelete(): ?User
  438.     {
  439.         return $this->userDelete;
  440.     }
  442.     public function setUserDelete(?User $userDelete): self
  443.     {
  444.         $this->userDelete = $userDelete;
  446.         return $this;
  447.     }
  449.     public function getDateDelete($dateFormat = 'Y-m-d H:i:s')
  450.     {
  451.         if($this->dateDelete){
  452.             return $this->dateDelete->format($dateFormat);
  453.         }
  454.         return $this->dateDelete;
  455.     }
  457.     public function setDateDelete($dateDelete): self
  458.     {
  459.         if(!empty($dateDelete)){
  460.             $dateDelete = DateTime::createFromFormat('Y-m-d H:i:s', $dateDelete);
  461.         }
  462.         
  463.         $this->dateDelete = $dateDelete;
  465.         return $this;
  466.     }
  468.     public function individual(): self
  469.     {
  470.         $this->typeDelete = LessonModuleEnum::INDIVIDUAL;
  472.         return $this;
  473.     }
  475.     public function cascade(): self
  476.     {
  477.         $this->typeDelete = LessonModuleEnum::CASCADE;
  479.         return $this;
  480.     }
  482.     public function isLive(): bool
  483.     {
  484.         return ($this->deleted == LessonModuleEnum::ITEM_NO_DELETED);
  485.     }
  487.     public function isOnTrash(): bool
  488.     {
  489.         return ($this->deleted == LessonModuleEnum::ITEM_ON_TRASH);
  490.     }
  492.     public function isDeleted(): bool
  493.     {
  494.         return ($this->deleted == LessonModuleEnum::ITEM_DELETED);
  495.     }
  497.     public function restore(): self
  498.     {
  499.         $this->deleted = LessonModuleEnum::ITEM_NO_DELETED;
  501.         return $this;
  502.     }
  504.     public function trash(): self
  505.     {
  506.         $this->deleted = LessonModuleEnum::ITEM_ON_TRASH;
  508.         return $this;
  509.     }
  511.     public function delete(): self
  512.     {
  513.         $this->deleted = LessonModuleEnum::ITEM_DELETED;
  515.         return $this;
  516.     }
  518.     public function isPublic(): bool
  519.     {
  520.         return ($this->status == LessonModuleEnum::PUBLISHED);
  521.     }
  522.     
  523.     public function toReturn(){
  525.         $data = [
  526.             "id" => $this->id,
  527.             "deleted" => $this->deleted,
  528.             "order" => $this->order,
  529.             "title" => $this->getTitle(),
  530.             "workload" => $this->workload,
  531.             "status" => $this->status,
  532.             "description" => $this->getDescription(),
  533.             "controlRequirement" => $this->controlRequirement,
  534.             "controlReleaseType" => $this->controlReleaseType,
  535.             "controlReleaseAfterType" => $this->controlReleaseAfterType,
  536.             "controlDateRelease" => $this->getControlDateRelease(),
  537.             "controlReleasePeriod" => $this->controlReleasePeriod,
  538.             "controlClosePeriod" => $this->controlClosePeriod,
  539.             "course" => ( $this->course ? $this->course->getId() : null ),
  540.             "courseTitle" => ( $this->course ? $this->course->getTitle() : null ),
  541.             "user" => ( $this->user ? $this->user->getId() : null ),
  542.             "userName" => ( $this->user ? $this->user->getName() : null ),
  543.             "userPhoto" => (
  544.                 $this->user ? 
  545.                     FileService::getFilePathComplete(
  546.                         $this->user->getPhoto(), 
  547.                         LessonModuleEnum::PATH_PROFILES, 
  548.                         true, 
  549.                         true
  550.                     )
  551.                 : null 
  552.             ),
  553.             "userUsername" => ( $this->user ? $this->user->getUsername() : null ),
  554.             "userDelete" => ( $this->userDelete ? $this->userDelete->getId() : null ),
  555.             "typeDelete" => $this->typeDelete,
  556.             "dateDelete" => $this->getDateDelete()
  557.         ];
  559.         return $data;
  560.     }
  562.     public function toReturnApi(): array
  563.     {
  564.         return [
  565.             "curso_id" => ( $this->course ? $this->course->getId() : null ),
  566.             "curso_titulo" => ( $this->course ? $this->course->getTitle() : null ),
  567.             "carga_horaria" => ( $this->course ? $this->course->getWorkload() : null ),
  568.             "modulo_id" => $this->id,
  569.             "ordem" => $this->getOrder(),
  570.             "modulo_titulo" => $this->getTitle(),
  571.             "descricao" => $this->getDescription(),
  572.             "status" => $this->getStatus(),
  573.         ];
  574.     }
  575. }