src/Entity/Core/Quiz/QuizSession.php line 23

Open in your IDE?
  1. <?php
  2. declare(strict_types=1);
  4. namespace App\Entity\Core\Quiz;
  6. use App\Entity\Core\Classroom\Classroom;
  7. use App\Entity\Core\FolderAwareInterface;
  8. use App\Entity\Core\FolderAwareTrait;
  9. use App\Entity\Core\SelfStudy\SelfStudyExamQuiz;
  10. use App\Entity\Core\SelfStudy\SelfStudyTopic;
  11. use App\Entity\Core\SelfStudy\SelfStudyTypicalExamProblem;
  12. use App\Entity\Core\TemplateMathproblem;
  13. use App\Entity\User\User;
  14. use DateTime;
  15. use DateTimeZone;
  16. use Doctrine\Common\Collections\ArrayCollection;
  17. use Doctrine\ORM\Mapping as ORM;
  18. use Exception;
  19. use JsonSerializable;
  21. #[ORM\Table('quiz_session')]
  22. #[ORM\Entity(repositoryClass: QuizSessionRepository::class)]
  23. class QuizSession implements JsonSerializable, FolderAwareInterface
  24. {
  25. use FolderAwareTrait;
  27. private const FOLDER_ACTIVITY_TYPE = 'quiz';
  29. /**
  30. * @var int
  31. */
  32. #[ORM\Column(name: 'id', type: 'integer')]
  33. #[ORM\Id]
  34. #[ORM\GeneratedValue(strategy: 'AUTO')]
  35. private int $id;
  37. /**
  38. * @var Quiz
  39. */
  40. #[ORM\JoinColumn(name: 'quiz', referencedColumnName: 'id', onDelete: 'CASCADE', nullable: true)]
  41. #[ORM\ManyToOne(targetEntity: Quiz::class, inversedBy: 'quizSessions')]
  42. private ?Quiz $quiz;
  44. /**
  45. * @var User
  46. */
  47. #[ORM\JoinColumn(name: 'created_by', referencedColumnName: 'id')]
  48. #[ORM\ManyToOne(targetEntity: User::class)]
  49. private ?User $createdBy;
  51. /**
  52. * @var Classroom
  53. */
  54. #[ORM\JoinColumn(name: 'classroom', referencedColumnName: 'id', onDelete: 'CASCADE')]
  55. #[ORM\ManyToOne(targetEntity: Classroom::class, inversedBy: 'quizSessions')]
  56. private ?Classroom $classroom;
  58. /**
  59. * @var bool
  60. */
  61. #[ORM\Column(name: 'dormant', type: 'boolean', nullable: true)]
  62. private ?bool $dormant;
  64. /**
  65. * @var int
  66. */
  67. #[ORM\Column(type: 'smallint', nullable: true)]
  68. private ?int $duration;
  70. /**
  71. * @var DateTime|null
  72. */
  73. #[ORM\Column(name: 'startTime', type: 'datetime', nullable: true)]
  74. private ?DateTime $startTime;
  76. #[ORM\Column(type: 'datetime', nullable: true)]
  77. private ?DateTime $deadline;
  79. #[ORM\Column(type: 'string', length: 255, nullable: true)]
  80. private ?string $name;
  82. /**
  83. * @var DateTime
  84. */
  85. #[ORM\Column(name: 'createdAt', type: 'datetime', nullable: false)]
  86. private DateTime $createdAt;
  88. /**
  89. * @var integer
  90. * [0 - created, in phase of editing; 1 - ready to start, if it's dormant ; 2 - startTime set]
  91. */
  92. #[ORM\Column(type: 'integer', nullable: false, options: ['default' => 0])]
  93. private int $status = 0;
  95. /**
  96. * @var integer
  97. */
  98. #[ORM\Column(type: 'integer', nullable: false, options: ['default' => 1])]
  99. private int $isEnabled = 1;
  101. #[ORM\Column(type: 'boolean', nullable: true, options: ['default' => false])]
  102. private ?bool $deleted = false;
  104. /**
  105. * @var QuizUnit[]
  106. */
  107. #[ORM\OneToMany(targetEntity: QuizUnit::class, mappedBy: 'quizSession', cascade: ['persist'])]
  108. private $quizUnits;
  110. /**
  111. * @var bool
  112. */
  113. #[ORM\Column(type: 'boolean', nullable: true)]
  114. private ?bool $durationIgnored;
  116. /**
  117. * @var bool
  118. */
  119. #[ORM\Column(name: 'hints_available', type: 'boolean', nullable: true)]
  120. private ?bool $hintsAvailable;
  122. #[ORM\Column(name: 'results_available_before_deadline', type: 'boolean', nullable: true)]
  123. private ?bool $resultsAvailableBeforeDeadline;
  125. /**
  126. * @var string|null
  127. */
  128. #[ORM\Column(name: 'isbn', type: 'string', length: 255, nullable: true)]
  129. private ?string $isbn;
  131. /**
  132. * @var DateTime
  133. */
  134. #[ORM\Column(name: 'updated_at', type: 'datetime', nullable: true)]
  135. private DateTime $updatedAt;
  137. /**
  138. * @var User
  139. */
  140. #[ORM\JoinColumn(name: 'updated_by', referencedColumnName: 'id')]
  141. #[ORM\ManyToOne(targetEntity: User::class)]
  142. private User $updatedBy;
  144. /**
  145. * @var string|null
  146. */
  147. #[ORM\Column(name: 'description', type: 'text', nullable: true)]
  148. private ?string $description;
  150. /**
  151. * @var DateTime
  152. */
  153. #[ORM\Column(name: 'result_view_open_at', type: 'datetime', nullable: true)]
  154. private ?DateTime $resultViewOpenAt;
  156. /**
  157. * @var ?bool
  158. */
  159. #[ORM\Column(name: 'extra_teachers', type: 'boolean', nullable: true)]
  160. private ?bool $extraTeachers = null;
  162. /**
  163. * possible values: 'self_study_exam', 'self_study_topic', 'self_study_typical_problem'
  164. * If it is null then it is a regular quiz
  165. */
  166. #[ORM\Column(name: 'type', type: 'string', length: 255, nullable: true, options: ['default' => ''])]
  167. private ?string $type = '';
  169. /**
  170. * @var SelfStudyTopic
  171. */
  172. #[ORM\JoinColumn(name: 'self_study_topic', referencedColumnName: 'id')]
  173. #[ORM\ManyToOne(targetEntity: SelfStudyTopic::class)]
  174. private $selfStudyTopic = null;
  176. /**
  177. * @var SelfStudyTypicalExamProblem
  178. */
  179. #[ORM\JoinColumn(name: 'self_study_typical_exam_problem', referencedColumnName: 'id')]
  180. #[ORM\ManyToOne(targetEntity: SelfStudyTypicalExamProblem::class)]
  181. private $selfStudyTypicalExamProblem = null;
  183. /**
  184. * @var SelfStudyExamQuiz
  185. */
  186. #[ORM\JoinColumn(name: 'self_study_exam', referencedColumnName: 'id')]
  187. #[ORM\ManyToOne(targetEntity: SelfStudyExamQuiz::class)]
  188. private $selfStudyExam = null;
  190. /**
  191. * @var bool
  192. */
  193. #[ORM\Column(name: 'deactivated_questions', type: 'boolean', nullable: true)]
  194. private ?bool $deactivatedProblems = null;
  196. /**
  197. * @var bool
  198. */
  199. #[ORM\Column(name: 'is_archived', type: 'boolean', nullable: true)]
  200. private ?bool $isArchived = null;
  203. /**
  204. * @var int|null
  205. */
  206. #[ORM\Column(name: 'copy_of', type: 'integer', nullable: true)]
  207. private ?int $copyOfSession = null;
  209. /**
  210. * @var bool|null
  211. */
  212. #[ORM\Column(name: 'is_shared_quiz', type: 'boolean', nullable: true)]
  213. private ?bool $isSharedQuiz = null;
  215. /**
  216. * @var bool|null
  217. */
  218. #[ORM\Column(name: 'is_pinned', type: 'boolean', nullable: true)]
  219. private ?bool $isPinned = null;
  221. #[ORM\Column(name: 'can_pause', type: 'boolean', options: ['default' => false])]
  222. private bool $canPause = false;
  224. /**
  225. */
  226. public function __construct(?int $duration)
  227. {
  228. $this->createdAt = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  229. $this->updatedAt = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  230. $this->quizUnits = new ArrayCollection();
  231. $this->duration = $duration;
  232. }
  234. public function getCopyOfSession(): ?int
  235. {
  236. return $this->copyOfSession;
  237. }
  239. public function setCopyOfSession(?int $copyOfSession): void
  240. {
  241. $this->copyOfSession = $copyOfSession;
  242. }
  244. public function getId(): int
  245. {
  246. return $this->id;
  247. }
  249. /**
  250. * @return Quiz
  251. */
  252. public function getQuiz(): ?Quiz
  253. {
  254. return $this->quiz;
  255. }
  257. /**
  258. * @param Quiz $quiz
  259. * @return $this
  260. */
  261. public function setQuiz(?Quiz $quiz): static
  262. {
  263. $this->quiz = $quiz;
  264. return $this;
  265. }
  267. /**
  268. * @return User
  269. */
  270. public function getCreatedBy(): ?User
  271. {
  272. return $this->createdBy;
  273. }
  275. /**
  276. * @param User $createdBy
  277. * @return $this
  278. */
  279. public function setCreatedBy(?User $createdBy): static
  280. {
  281. $this->createdBy = $createdBy;
  282. return $this;
  283. }
  285. /**
  286. * @return Classroom
  287. */
  288. public function getClassroom(): ?Classroom
  289. {
  290. return $this->classroom;
  291. }
  293. /**
  294. * @param Classroom $classroom
  295. * @return $this
  296. */
  297. public function setClassroom(?Classroom $classroom)
  298. {
  299. $this->classroom = $classroom;
  300. return $this;
  301. }
  303. /**
  304. * @return boolean
  305. */
  306. public function isDormant(): ?bool
  307. {
  308. return $this->dormant;
  309. }
  311. /**
  312. * @param boolean $dormant
  313. * @return $this
  314. */
  315. public function setDormant(?bool $dormant)
  316. {
  317. $this->dormant = $dormant;
  318. return $this;
  319. }
  321. /**
  322. * @return DateTime
  323. */
  324. public function getStartTime(): ?DateTime
  325. {
  326. return $this->startTime;
  327. }
  329. /**
  330. * @param DateTime $startTime
  331. * @return $this
  332. */
  333. public function setStartTime(?DateTime $startTime)
  334. {
  335. $this->startTime = $startTime;
  336. return $this;
  337. }
  339. public function getCreatedAt(): DateTime
  340. {
  341. return $this->createdAt;
  342. }
  344. public function setCreatedAt(DateTime $createdAt): void
  345. {
  346. $this->createdAt = $createdAt;
  347. }
  349. public function getStatus(): int
  350. {
  351. return $this->status;
  352. }
  354. /**
  355. * @return $this
  356. */
  357. public function setStatus(int $status): static
  358. {
  359. $this->status = $status;
  360. return $this;
  361. }
  363. /**
  364. * @return QuizUnit[]
  365. */
  366. public function getQuizUnits()
  367. {
  368. return $this->quizUnits;
  369. }
  371. /**
  372. * @param QuizUnit[] $quizUnits
  373. * @return $this
  374. */
  375. public function setQuizUnits($quizUnits)
  376. {
  377. $this->quizUnits = $quizUnits;
  378. return $this;
  379. }
  381. /**
  382. * @return $this
  383. */
  384. public function addQuizUnit(QuizUnit $quizUnit)
  385. {
  386. $quizUnit->setQuizSession($this);
  387. $this->quizUnits->add($quizUnit);
  389. return $this;
  390. }
  392. public function getEndTime()
  393. {
  394. if ($this->getDeadline() !== null) {
  395. return $this->getDeadline();
  396. }
  398. $endTime = clone $this->startTime;
  399. return $endTime->modify(sprintf('+%d minutes', $this->getDuration()));
  400. }
  402. public function setIsEnabled(int $isEnabled): void
  403. {
  404. $this->isEnabled = $isEnabled;
  405. }
  407. public function getIsEnabled(): int
  408. {
  409. return $this->isEnabled;
  410. }
  412. public function isDeleted(): ?bool
  413. {
  414. return $this->deleted;
  415. }
  417. public function setDeleted(bool $deleted): void
  418. {
  419. $this->deleted = $deleted;
  420. }
  422. public function getDeadline(): ?DateTime
  423. {
  424. return $this->deadline;
  425. }
  427. public function setDeadline(?DateTime $deadline = null): void
  428. {
  429. $this->deadline = $deadline;
  430. }
  432. public function isDurationIgnored(): ?bool
  433. {
  434. return $this->durationIgnored;
  435. }
  437. public function setDurationIgnored(bool $durationIgnored): void
  438. {
  439. $this->durationIgnored = $durationIgnored;
  440. }
  442. public function getDuration(): ?int
  443. {
  444. return $this->duration;
  445. }
  447. public function setDuration(?int $duration): void
  448. {
  449. $this->duration = $duration;
  450. }
  452. public function isHintsAvailable(): ?bool
  453. {
  454. return $this->hintsAvailable;
  455. }
  457. public function setHintsAvailable(bool $hintsAvailable): void
  458. {
  459. $this->hintsAvailable = $hintsAvailable;
  460. }
  462. public function areResultsAvailableBeforeDeadline(): bool
  463. {
  464. return (bool)$this->resultsAvailableBeforeDeadline;
  465. }
  467. public function setResultsAvailableBeforeDeadline(?bool $resultsAvailableBeforeDeadline): void
  468. {
  469. $this->resultsAvailableBeforeDeadline = $resultsAvailableBeforeDeadline;
  470. }
  472. public function getName(): ?string
  473. {
  474. return $this->name;
  475. }
  477. public function setName(?string $name): void
  478. {
  479. $this->name = $name;
  480. }
  482. public function isHomework(): bool
  483. {
  484. return (bool)$this->deadline;
  485. }
  487. public function getType(): string
  488. {
  489. return $this->type;
  490. }
  492. public function isSelfStudyExamQuiz(): bool
  493. {
  494. return $this->type === 'self_study_exam';
  495. }
  497. public function isSelfStudyTopicQuiz(): bool
  498. {
  499. return $this->type === 'self_study_topic';
  500. }
  502. public function isSelfStudyTypicalProblemQuiz(): bool
  503. {
  504. return $this->type === 'self_study_typical_exam_problem';
  505. }
  507. public function isSelfStudyQuiz(): bool
  508. {
  509. return $this->isSelfStudyExamQuiz() || $this->isSelfStudyTopicQuiz() || $this->isSelfStudyTypicalProblemQuiz();
  510. }
  512. public function setTypeToSelfStudyExamQuiz(): void
  513. {
  514. $this->type = 'self_study_exam';
  515. }
  517. public function setTypeToSelfStudyTopicQuiz(): void
  518. {
  519. $this->type = 'self_study_topic';
  520. }
  522. public function setTypeToSelfStudyTypicalProblemQuiz(): void
  523. {
  524. $this->type = 'self_study_typical_problem';
  525. }
  527. public function setType(?string $type): void
  528. {
  529. $this->type = $type;
  530. }
  532. public function getSelfStudyTopic(): ?SelfStudyTopic
  533. {
  534. return $this->selfStudyTopic;
  535. }
  537. public function setSelfStudyTopic(?SelfStudyTopic $selfStudyTopic): void
  538. {
  539. $this->selfStudyTopic = $selfStudyTopic;
  540. }
  542. public function getSelfStudyTypicalExamProblem(): ?SelfStudyTypicalExamProblem
  543. {
  544. return $this->selfStudyTypicalExamProblem;
  545. }
  547. public function setSelfStudyTypicalExamProblem(?SelfStudyTypicalExamProblem $selfStudyTypicalExamProblem): void
  548. {
  549. $this->selfStudyTypicalExamProblem = $selfStudyTypicalExamProblem;
  550. }
  552. public function getSelfStudyExam(): ?SelfStudyExamQuiz
  553. {
  554. return $this->selfStudyExam;
  555. }
  557. public function setSelfStudyExam(?SelfStudyExamQuiz $selfStudyExam): void
  558. {
  559. $this->selfStudyExam = $selfStudyExam;
  560. }
  562. /**
  563. * @throws Exception
  564. */
  565. public function jsonSerialize(): mixed
  566. {
  567. $topics = [];
  568. $quiz = $this->getQuiz();
  569. if ($quiz) {
  570. foreach ($quiz->getSortedMathproblems() as $problem) {
  571. $template = $problem->getTemplate();
  572. if (!$template) {
  573. continue;
  574. }
  576. $this->getUniqueTopics($template, $topics);
  577. }
  578. $topics = array_values($topics);
  579. }
  581. return [
  582. "duration" => $this->getDuration(),
  583. "id" => $this->getId(),
  584. "name" => $this->prefixNameWithFolderSortOrder($this->getName(), self::FOLDER_ACTIVITY_TYPE, $this->getQuiz()?->getId()),
  585. "startTime" => $this->getStartTime(),
  586. 'deadline' => $this->getDeadline() ?? $this->getEndTime(),
  587. 'isHomework' => $this->isHomework(),
  588. 'secondsUntilDeadline' => $this->getSecondsUntilDeadline(),
  589. 'durationIgnored' => $this->isDurationIgnored(),
  590. 'session_type' => basename(str_replace('\\', '/', __CLASS__)),
  591. 'activity_type' => 'quiz',
  592. 'start' => $this->getStartTime()->getTimestamp(),
  593. 'topics' => $topics
  594. ];
  595. }
  597. public function getSortOrderInFolder(): ?int
  598. {
  599. return $this->getFolderSortOrder(self::FOLDER_ACTIVITY_TYPE, $this->getQuiz()?->getId());
  600. }
  602. public function setISBN(?string $isbn = null): void
  603. {
  604. $this->isbn = $isbn;
  605. }
  607. public function getISBN(): ?string
  608. {
  609. return $this->isbn;
  610. }
  612. public function getUpdatedAt(): DateTime
  613. {
  614. return $this->updatedAt;
  615. }
  617. public function setUpdatedAt(DateTime $updatedAt): void
  618. {
  619. $this->updatedAt = $updatedAt;
  620. }
  622. public function getUpdatedBy(): User
  623. {
  624. return $this->updatedBy;
  625. }
  627. public function setUpdatedBy(User $updatedBy): void
  628. {
  629. $this->updatedBy = $updatedBy;
  630. }
  632. public function getDescription(): string
  633. {
  634. return $this->description;
  635. }
  637. public function setDescription(string $description): void
  638. {
  639. $this->description = $description;
  640. }
  642. public function getResultViewOpenAt(): ?DateTime
  643. {
  644. return $this->resultViewOpenAt;
  645. }
  647. public function setResultViewOpenAt(?DateTime $resultViewOpenAt): void
  648. {
  649. $this->resultViewOpenAt = $resultViewOpenAt;
  650. }
  652. public function hasExtraTeachers(): ?bool
  653. {
  654. return $this->extraTeachers;
  655. }
  657. public function setExtraTeachers(?bool $extraTeachers): void
  658. {
  659. $this->extraTeachers = $extraTeachers;
  660. }
  662. public function hasDeactivatedProblems(): ?bool
  663. {
  664. return $this->deactivatedProblems;
  665. }
  667. public function setDeactivatedProblems(?bool $deactivatedProblems): void
  668. {
  669. $this->deactivatedProblems = $deactivatedProblems;
  670. }
  672. public function isArchived(): ?bool
  673. {
  674. return $this->isArchived;
  675. }
  677. public function setIsArchived(?bool $isArchived): void
  678. {
  679. $this->isArchived = $isArchived;
  680. }
  682. public function isSharedQuiz(): ?bool
  683. {
  684. return $this->isSharedQuiz;
  685. }
  687. public function setIsSharedQuiz(bool $isSharedQuiz): void
  688. {
  689. $this->isSharedQuiz = $isSharedQuiz;
  690. }
  692. public function getIsPinned(): ?bool
  693. {
  694. return $this->isPinned;
  695. }
  697. public function setIsPinned(?bool $isPinned): void
  698. {
  699. $this->isPinned = $isPinned;
  700. }
  702. public function getNameOrDefaultToQuizName(): ?string
  703. {
  704. return trim($this->getName() ?? '') === '' ? $this->getQuiz()->getName() : $this->getName();
  705. }
  707. public function getCanPause(): bool
  708. {
  709. return $this->canPause;
  710. }
  712. public function canPause(): bool
  713. {
  714. return $this->canPause;
  715. }
  717. /**
  718. * @param bool $canPause
  719. */
  720. public function setCanPause(?bool $canPause): void
  721. {
  722. $this->canPause = $canPause;
  723. }
  725. /**
  726. * @throws Exception
  727. */
  728. public function getSecondsUntilDeadline():int
  729. {
  730. if($this->getDeadline() === null){
  731. return 0;
  732. }
  733. $now = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  734. $interval = $now->diff($this->getDeadline());
  735. $seconds = ($interval->days * 24 * 60 * 60) + ($interval->h * 60 * 60) + ($interval->i * 60) + $interval->s;
  736. if($interval->invert){
  737. return 0;
  738. }
  739. return $seconds;
  740. }
  742. public function getProblemCount(){
  743. return $this->quiz->getProblemCount();
  744. }
  746. private function getUniqueTopics(TemplateMathproblem $template, array &$topics): void
  747. {
  748. if($topic = $template->getTopic()){
  749. $topics[$topic->getId()] = $topic->jsonSerialize();
  750. }
  751. }
  752. }