src/CoreBundle/Entity/QuizSession.php line 18

Open in your IDE?
  1. <?php
  2. declare(strict_types=1);
  4. namespace CoreBundle\Entity;
  6. use DateTime;
  7. use DateTimeZone;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Exception;
  10. use UserBundle\Entity\User;
  11. use Doctrine\Common\Collections\ArrayCollection;
  12. use JsonSerializable;
  14. /**
  15. * @ORM\Table("quiz_session")
  16. * @ORM\Entity(repositoryClass="CoreBundle\Entity\QuizSessionRepository")
  17. */
  18. class QuizSession implements JsonSerializable
  19. {
  20. /**
  21. * @var int
  22. *
  23. * @ORM\Column(name="id", type="integer")
  24. * @ORM\Id
  25. * @ORM\GeneratedValue(strategy="AUTO")
  26. */
  27. private int $id;
  29. /**
  30. * @var Quiz
  31. *
  32. * @ORM\ManyToOne(targetEntity="CoreBundle\Entity\Quiz", inversedBy="quizSessions")
  33. * @ORM\JoinColumn(name="quiz", referencedColumnName="id", onDelete="CASCADE", nullable=true)
  34. */
  35. private ?Quiz $quiz;
  37. /**
  38. * @var User
  39. *
  40. * @ORM\ManyToOne(targetEntity="UserBundle\Entity\User")
  41. * @ORM\JoinColumn(name="created_by", referencedColumnName="id")
  42. */
  43. private ?User $createdBy;
  45. /**
  46. * @var Classroom
  47. *
  48. * @ORM\ManyToOne(targetEntity="Classroom", inversedBy="quizSessions")
  49. * @ORM\JoinColumn(name="classroom", referencedColumnName="id", onDelete="CASCADE")
  50. */
  51. private ?Classroom $classroom;
  53. /**
  54. * @var bool
  55. *
  56. * @ORM\Column(name="dormant", type="boolean", nullable=true)
  57. */
  58. private ?bool $dormant;
  60. /**
  61. * @var int
  62. *
  63. * @ORM\Column(type="smallint", nullable=true)
  64. */
  65. private ?int $duration;
  67. /**
  68. * @var DateTime|null
  69. *
  70. * @ORM\Column(name="startTime", type="datetime", nullable=true)
  71. */
  72. private ?DateTime $startTime;
  74. /**
  75. * @ORM\Column(type="datetime", nullable=true)
  76. */
  77. private ?DateTime $deadline;
  79. /**
  80. * @ORM\Column(type="string", length=255, nullable=true)
  81. */
  82. private ?string $name;
  84. /**
  85. * @var DateTime
  86. *
  87. * @ORM\Column(name="createdAt", type="datetime", nullable=false)
  88. */
  89. private DateTime $createdAt;
  91. /**
  92. * @var integer
  93. * [0 - created, in phase of editing; 1 - ready to start, if it's dormant ; 2 - startTime set]
  94. *
  95. * @ORM\Column(type="integer", nullable=false, options={"default"=0})
  96. */
  97. private int $status = 0;
  99. /**
  100. * @var integer
  101. *
  102. * @ORM\Column(type="integer", nullable=false, options={"default"=1})
  103. */
  104. private int $isEnabled = 1;
  106. /**
  107. * @var QuizUnit[]
  108. *
  109. * @ORM\OneToMany(targetEntity="CoreBundle\Entity\QuizUnit", mappedBy="quizSession", cascade={"persist"})
  110. */
  111. private $quizUnits;
  113. /**
  114. * @var bool
  115. *
  116. * @ORM\Column(type="boolean", nullable=true)
  117. */
  118. private ?bool $durationIgnored;
  120. /**
  121. * @var bool
  122. *
  123. * @ORM\Column(name="hints_available", type="boolean", nullable=true)
  124. */
  125. private ?bool $hintsAvailable;
  127. /**
  128. * @ORM\Column(name="results_available_before_deadline", type="boolean", nullable=true)
  129. */
  130. private ?bool $resultsAvailableBeforeDeadline;
  132. /**
  133. * @var string|null
  134. * @ORM\Column(name="isbn", type="string", length=255, nullable=true)
  135. */
  136. private ?string $isbn;
  138. /**
  139. * @var DateTime
  140. * @ORM\Column(name="updated_at", type="datetime", nullable=true)
  141. */
  142. private DateTime $updatedAt;
  144. /**
  145. * @var User
  146. *
  147. * @ORM\ManyToOne(targetEntity="UserBundle\Entity\User")
  148. * @ORM\JoinColumn(name="updated_by", referencedColumnName="id")
  149. */
  150. private User $updatedBy;
  152. /**
  153. * @var string|null
  154. * @ORM\Column(name="description", type="text", nullable=true)
  155. */
  156. private ?string $description;
  158. /**
  159. * @var DateTime
  160. * @ORM\Column(name="result_view_open_at", type="datetime", nullable=true)
  161. */
  162. private ?DateTime $resultViewOpenAt;
  164. /**
  165. * @var ?bool
  166. * @ORM\Column(name="extra_teachers", type="boolean", nullable=true)
  167. */
  168. private ?bool $extraTeachers = null;
  170. /**
  171. * possible values: 'self_study_exam', 'self_study_topic', 'self_study_typical_problem'
  172. * If it is null then it is a regular quiz
  173. *
  174. * @ORM\Column(name="type", type="string", length=255, nullable=true, options={"default"=""})
  175. */
  176. private ?string $type = '';
  178. /**
  179. * @var SelfStudyTopic
  180. *
  181. * @ORM\ManyToOne(targetEntity="SelfStudyTopic")
  182. * @ORM\JoinColumn(name="self_study_topic", referencedColumnName="id")
  183. */
  184. private $selfStudyTopic = null;
  186. /**
  187. * @var SelfStudyTypicalExamProblem
  188. *
  189. * @ORM\ManyToOne(targetEntity="SelfStudyTypicalExamProblem")
  190. * @ORM\JoinColumn(name="self_study_typical_exam_problem", referencedColumnName="id")
  191. */
  192. private $selfStudyTypicalExamProblem = null;
  194. /**
  195. * @var SelfStudyExamQuiz
  196. *
  197. * @ORM\ManyToOne(targetEntity="SelfStudyExamQuiz")
  198. * @ORM\JoinColumn(name="self_study_exam", referencedColumnName="id")
  199. */
  200. private $selfStudyExam = null;
  202. /**
  203. * @var bool
  204. * @ORM\Column(name="deactivated_questions", type="boolean", nullable=true)
  205. */
  206. private ?bool $deactivatedProblems = null;
  208. /**
  209. * @var bool
  210. * @ORM\Column(name="is_archived", type="boolean", nullable=true)
  211. */
  212. private ?bool $isArchived = null;
  215. /**
  216. * @var int|null
  217. * @ORM\Column(name="copy_of", type="integer", nullable=true)
  218. */
  219. private ?int $copyOfSession = null;
  221. /**
  222. * @var bool|null
  223. * @ORM\Column(name="is_shared_quiz", type="boolean", nullable=true)
  224. */
  225. private ?bool $isSharedQuiz = null;
  227. /**
  228. * @var bool|null
  229. * @ORM\Column(name="is_pinned", type="boolean", nullable=true)
  230. */
  231. private ?bool $isPinned = null;
  233. /**
  234. * @ORM\Column(name="can_pause", type="boolean", options={"default"=false})
  235. */
  236. private bool $canPause = false;
  238. /**
  239. */
  240. public function __construct(?int $duration)
  241. {
  242. $this->createdAt = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  243. $this->updatedAt = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  244. $this->quizUnits = new ArrayCollection();
  245. $this->duration = $duration;
  246. }
  248. /**
  249. * @return int|null
  250. */
  251. public function getCopyOfSession(): ?int
  252. {
  253. return $this->copyOfSession;
  254. }
  256. /**
  257. * @param int|null $copyOfSession
  258. * @return void
  259. */
  260. public function setCopyOfSession(?int $copyOfSession): void
  261. {
  262. $this->copyOfSession = $copyOfSession;
  263. }
  265. /**
  266. * @return int
  267. */
  268. public function getId(): int
  269. {
  270. return $this->id;
  271. }
  273. /**
  274. * @return Quiz
  275. */
  276. public function getQuiz(): ?Quiz
  277. {
  278. return $this->quiz;
  279. }
  281. /**
  282. * @param Quiz $quiz
  283. * @return $this
  284. */
  285. public function setQuiz(?Quiz $quiz): static
  286. {
  287. $this->quiz = $quiz;
  288. return $this;
  289. }
  291. /**
  292. * @return User
  293. */
  294. public function getCreatedBy(): ?User
  295. {
  296. return $this->createdBy;
  297. }
  299. /**
  300. * @param User $createdBy
  301. * @return $this
  302. */
  303. public function setCreatedBy(?User $createdBy): static
  304. {
  305. $this->createdBy = $createdBy;
  306. return $this;
  307. }
  309. /**
  310. * @return Classroom
  311. */
  312. public function getClassroom(): ?Classroom
  313. {
  314. return $this->classroom;
  315. }
  317. /**
  318. * @param Classroom $classroom
  319. * @return $this
  320. */
  321. public function setClassroom(?Classroom $classroom)
  322. {
  323. $this->classroom = $classroom;
  324. return $this;
  325. }
  327. /**
  328. * @return boolean
  329. */
  330. public function isDormant(): ?bool
  331. {
  332. return $this->dormant;
  333. }
  335. /**
  336. * @param boolean $dormant
  337. * @return $this
  338. */
  339. public function setDormant(?bool $dormant)
  340. {
  341. $this->dormant = $dormant;
  342. return $this;
  343. }
  345. /**
  346. * @return DateTime
  347. */
  348. public function getStartTime(): ?DateTime
  349. {
  350. return $this->startTime;
  351. }
  353. /**
  354. * @param DateTime $startTime
  355. * @return $this
  356. */
  357. public function setStartTime(?DateTime $startTime)
  358. {
  359. $this->startTime = $startTime;
  360. return $this;
  361. }
  363. /**
  364. * @return DateTime
  365. */
  366. public function getCreatedAt(): DateTime
  367. {
  368. return $this->createdAt;
  369. }
  371. /**
  372. * @param DateTime $createdAt
  373. * @return void
  374. */
  375. public function setCreatedAt(DateTime $createdAt): void
  376. {
  377. $this->createdAt = $createdAt;
  378. }
  380. /**
  381. * @return int
  382. */
  383. public function getStatus(): int
  384. {
  385. return $this->status;
  386. }
  388. /**
  389. * @param int $status
  390. * @return $this
  391. */
  392. public function setStatus(int $status): static
  393. {
  394. $this->status = $status;
  395. return $this;
  396. }
  398. /**
  399. * @return QuizUnit[]
  400. */
  401. public function getQuizUnits()
  402. {
  403. return $this->quizUnits;
  404. }
  406. /**
  407. * @param QuizUnit[] $quizUnits
  408. * @return $this
  409. */
  410. public function setQuizUnits($quizUnits)
  411. {
  412. $this->quizUnits = $quizUnits;
  413. return $this;
  414. }
  416. /**
  417. * @param QuizUnit $quizUnit
  418. *
  419. * @return $this
  420. */
  421. public function addQuizUnit(QuizUnit $quizUnit)
  422. {
  423. $quizUnit->setQuizSession($this);
  424. $this->quizUnits->add($quizUnit);
  426. return $this;
  427. }
  429. public function getEndTime()
  430. {
  431. if ($this->getDeadline() !== null) {
  432. return $this->getDeadline();
  433. }
  435. $endTime = clone $this->startTime;
  436. return $endTime->modify(sprintf('+%d minutes', $this->getDuration()));
  437. }
  439. /**
  440. * @param int $isEnabled
  441. */
  442. public function setIsEnabled(int $isEnabled): void
  443. {
  444. $this->isEnabled = $isEnabled;
  445. }
  447. /**
  448. * @return int
  449. */
  450. public function getIsEnabled(): int
  451. {
  452. return $this->isEnabled;
  453. }
  455. /**
  456. * @return DateTime|null
  457. */
  458. public function getDeadline(): ?DateTime
  459. {
  460. return $this->deadline;
  461. }
  463. /**
  464. * @param DateTime|null $deadline
  465. */
  466. public function setDeadline(?DateTime $deadline = null): void
  467. {
  468. $this->deadline = $deadline;
  469. }
  471. /**
  472. * @return bool|null
  473. */
  474. public function isDurationIgnored(): ?bool
  475. {
  476. return $this->durationIgnored;
  477. }
  479. /**
  480. * @param bool $durationIgnored
  481. * @return void
  482. */
  483. public function setDurationIgnored(bool $durationIgnored): void
  484. {
  485. $this->durationIgnored = $durationIgnored;
  486. }
  488. /**
  489. * @return int|null
  490. */
  491. public function getDuration(): ?int
  492. {
  493. return $this->duration;
  494. }
  496. /**
  497. * @param int|null $duration
  498. * @return void
  499. */
  500. public function setDuration(?int $duration): void
  501. {
  502. $this->duration = $duration;
  503. }
  505. /**
  506. * @return bool|null
  507. */
  508. public function isHintsAvailable(): ?bool
  509. {
  510. return $this->hintsAvailable;
  511. }
  513. /**
  514. * @param bool $hintsAvailable
  515. * @return void
  516. */
  517. public function setHintsAvailable(bool $hintsAvailable): void
  518. {
  519. $this->hintsAvailable = $hintsAvailable;
  520. }
  522. /**
  523. * @return bool
  524. */
  525. public function areResultsAvailableBeforeDeadline(): bool
  526. {
  527. return (bool)$this->resultsAvailableBeforeDeadline;
  528. }
  530. /**
  531. * @param bool|null $resultsAvailableBeforeDeadline
  532. * @return void
  533. */
  534. public function setResultsAvailableBeforeDeadline(?bool $resultsAvailableBeforeDeadline): void
  535. {
  536. $this->resultsAvailableBeforeDeadline = $resultsAvailableBeforeDeadline;
  537. }
  539. /**
  540. * @return string|null
  541. */
  542. public function getName(): ?string
  543. {
  544. return $this->name;
  545. }
  547. /**
  548. * @param string|null $name
  549. * @return void
  550. */
  551. public function setName(?string $name): void
  552. {
  553. $this->name = $name;
  554. }
  556. public function isHomework(): bool
  557. {
  558. return (bool)$this->deadline;
  559. }
  561. public function getType(): string
  562. {
  563. return $this->type;
  564. }
  566. public function isSelfStudyExamQuiz(): bool
  567. {
  568. return $this->type === 'self_study_exam';
  569. }
  571. public function isSelfStudyTopicQuiz(): bool
  572. {
  573. return $this->type === 'self_study_topic';
  574. }
  576. public function isSelfStudyTypicalProblemQuiz(): bool
  577. {
  578. return $this->type === 'self_study_typical_exam_problem';
  579. }
  581. public function isSelfStudyQuiz(): bool
  582. {
  583. return $this->isSelfStudyExamQuiz() || $this->isSelfStudyTopicQuiz() || $this->isSelfStudyTypicalProblemQuiz();
  584. }
  586. public function setTypeToSelfStudyExamQuiz(): void
  587. {
  588. $this->type = 'self_study_exam';
  589. }
  591. public function setTypeToSelfStudyTopicQuiz(): void
  592. {
  593. $this->type = 'self_study_topic';
  594. }
  596. public function setTypeToSelfStudyTypicalProblemQuiz(): void
  597. {
  598. $this->type = 'self_study_typical_problem';
  599. }
  601. public function setType(?string $type): void
  602. {
  603. $this->type = $type;
  604. }
  606. public function getSelfStudyTopic(): ?SelfStudyTopic
  607. {
  608. return $this->selfStudyTopic;
  609. }
  611. public function setSelfStudyTopic(?SelfStudyTopic $selfStudyTopic): void
  612. {
  613. $this->selfStudyTopic = $selfStudyTopic;
  614. }
  616. public function getSelfStudyTypicalExamProblem(): ?SelfStudyTypicalExamProblem
  617. {
  618. return $this->selfStudyTypicalExamProblem;
  619. }
  621. public function setSelfStudyTypicalExamProblem(?SelfStudyTypicalExamProblem $selfStudyTypicalExamProblem): void
  622. {
  623. $this->selfStudyTypicalExamProblem = $selfStudyTypicalExamProblem;
  624. }
  626. public function getSelfStudyExam(): ?SelfStudyExamQuiz
  627. {
  628. return $this->selfStudyExam;
  629. }
  631. public function setSelfStudyExam(?SelfStudyExamQuiz $selfStudyExam): void
  632. {
  633. $this->selfStudyExam = $selfStudyExam;
  634. }
  636. /**
  637. * @throws Exception
  638. */
  639. public function jsonSerialize(): mixed
  640. {
  641. return [
  642. "duration" => $this->getDuration(),
  643. "id" => $this->getId(),
  644. "name" => $this->getName(),
  645. "startTime" => $this->getStartTime(),
  646. 'deadline' => $this->getDeadline(),
  647. 'isHomework' => $this->isHomework(),
  648. 'secondsUntilDeadline' => $this->getSecondsUntilDeadline(),
  649. 'durationIgnored' => $this->isDurationIgnored()
  650. ];
  651. }
  653. public function setISBN(?string $isbn = null): void
  654. {
  655. $this->isbn = $isbn;
  656. }
  658. public function getISBN(): ?string
  659. {
  660. return $this->isbn;
  661. }
  663. public function getUpdatedAt(): DateTime
  664. {
  665. return $this->updatedAt;
  666. }
  668. public function setUpdatedAt(DateTime $updatedAt): void
  669. {
  670. $this->updatedAt = $updatedAt;
  671. }
  673. public function getUpdatedBy(): User
  674. {
  675. return $this->updatedBy;
  676. }
  678. public function setUpdatedBy(User $updatedBy): void
  679. {
  680. $this->updatedBy = $updatedBy;
  681. }
  683. public function getDescription(): string
  684. {
  685. return $this->description;
  686. }
  688. public function setDescription(string $description): void
  689. {
  690. $this->description = $description;
  691. }
  693. public function getResultViewOpenAt(): ?DateTime
  694. {
  695. return $this->resultViewOpenAt;
  696. }
  698. public function setResultViewOpenAt(?DateTime $resultViewOpenAt): void
  699. {
  700. $this->resultViewOpenAt = $resultViewOpenAt;
  701. }
  703. public function hasExtraTeachers(): ?bool
  704. {
  705. return $this->extraTeachers;
  706. }
  708. public function setExtraTeachers(?bool $extraTeachers): void
  709. {
  710. $this->extraTeachers = $extraTeachers;
  711. }
  713. public function hasDeactivatedProblems(): ?bool
  714. {
  715. return $this->deactivatedProblems;
  716. }
  718. public function setDeactivatedProblems(?bool $deactivatedProblems): void
  719. {
  720. $this->deactivatedProblems = $deactivatedProblems;
  721. }
  723. public function isArchived(): ?bool
  724. {
  725. return $this->isArchived;
  726. }
  728. public function setIsArchived(?bool $isArchived): void
  729. {
  730. $this->isArchived = $isArchived;
  731. }
  733. public function isSharedQuiz(): ?bool
  734. {
  735. return $this->isSharedQuiz;
  736. }
  738. public function setIsSharedQuiz(bool $isSharedQuiz): void
  739. {
  740. $this->isSharedQuiz = $isSharedQuiz;
  741. }
  743. public function getIsPinned(): ?bool
  744. {
  745. return $this->isPinned;
  746. }
  748. public function setIsPinned(?bool $isPinned): void
  749. {
  750. $this->isPinned = $isPinned;
  751. }
  753. public function getNameOrDefaultToQuizName(): ?string
  754. {
  755. return trim($this->getName() ?? '') === '' ? $this->getQuiz()->getName() : $this->getName();
  756. }
  758. /**
  759. * @return bool
  760. */
  761. public function getCanPause(): bool
  762. {
  763. return $this->canPause;
  764. }
  766. /**
  767. * @return bool
  768. */
  769. public function canPause(): bool
  770. {
  771. return $this->canPause;
  772. }
  774. /**
  775. * @param bool $canPause
  776. */
  777. public function setCanPause(?bool $canPause): void
  778. {
  779. $this->canPause = $canPause;
  780. }
  782. /**
  783. * @return int
  784. * @throws Exception
  785. */
  786. public function getSecondsUntilDeadline():int
  787. {
  788. if($this->getDeadline() === null){
  789. return 0;
  790. }
  791. $now = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  792. $interval = $now->diff($this->getDeadline());
  793. $seconds = ($interval->days * 24 * 60 * 60) + ($interval->h * 60 * 60) + ($interval->i * 60) + $interval->s;
  794. if($interval->invert){
  795. return 0;
  796. }
  797. return $seconds;
  798. }
  799. }