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

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\ActivitySessionInterface;
  8. use App\Entity\Core\FolderAwareInterface;
  9. use App\Entity\Core\FolderAwareTrait;
  10. use App\Entity\Core\SelfStudy\SelfStudyExamQuiz;
  11. use App\Entity\Core\SelfStudy\SelfStudyTopic;
  12. use App\Entity\Core\SelfStudy\SelfStudyTypicalExamProblem;
  13. use App\Entity\Core\TemplateMathproblem;
  14. use App\Entity\User\User;
  15. use DateTime;
  16. use DateTimeZone;
  17. use Doctrine\Common\Collections\ArrayCollection;
  18. use Doctrine\ORM\Mapping as ORM;
  19. use Exception;
  20. use JsonSerializable;
  22. #[ORM\Table('quiz_session')]
  23. #[ORM\Entity(repositoryClass: QuizSessionRepository::class)]
  24. class QuizSession implements JsonSerializable, FolderAwareInterface, ActivitySessionInterface
  25. {
  26. use FolderAwareTrait;
  28. private const FOLDER_ACTIVITY_TYPE = 'quiz';
  30. /**
  31. * @var int
  32. */
  33. #[ORM\Column(name: 'id', type: 'integer')]
  34. #[ORM\Id]
  35. #[ORM\GeneratedValue(strategy: 'AUTO')]
  36. private int $id;
  38. /**
  39. * @var Quiz
  40. */
  41. #[ORM\JoinColumn(name: 'quiz', referencedColumnName: 'id', onDelete: 'CASCADE', nullable: true)]
  42. #[ORM\ManyToOne(targetEntity: Quiz::class, inversedBy: 'quizSessions')]
  43. private ?Quiz $quiz;
  45. /**
  46. * @var User
  47. */
  48. #[ORM\JoinColumn(name: 'created_by', referencedColumnName: 'id')]
  49. #[ORM\ManyToOne(targetEntity: User::class)]
  50. private ?User $createdBy;
  52. /**
  53. * @var Classroom
  54. */
  55. #[ORM\JoinColumn(name: 'classroom', referencedColumnName: 'id', onDelete: 'CASCADE')]
  56. #[ORM\ManyToOne(targetEntity: Classroom::class, inversedBy: 'quizSessions')]
  57. private ?Classroom $classroom;
  59. /**
  60. * @var bool
  61. */
  62. #[ORM\Column(name: 'dormant', type: 'boolean', nullable: true)]
  63. private ?bool $dormant;
  65. /**
  66. * @var int
  67. */
  68. #[ORM\Column(type: 'smallint', nullable: true)]
  69. private ?int $duration;
  71. /**
  72. * @var DateTime|null
  73. */
  74. #[ORM\Column(name: 'startTime', type: 'datetime', nullable: true)]
  75. private ?DateTime $startTime;
  77. #[ORM\Column(type: 'datetime', nullable: true)]
  78. private ?DateTime $deadline;
  80. #[ORM\Column(type: 'string', length: 255, nullable: true)]
  81. private ?string $name;
  83. /**
  84. * @var DateTime
  85. */
  86. #[ORM\Column(name: 'createdAt', type: 'datetime', nullable: false)]
  87. private DateTime $createdAt;
  89. /**
  90. * @var integer
  91. * [0 - created, in phase of editing; 1 - ready to start, if it's dormant ; 2 - startTime set]
  92. */
  93. #[ORM\Column(type: 'integer', nullable: false, options: ['default' => 0])]
  94. private int $status = 0;
  96. /**
  97. * @var integer
  98. */
  99. #[ORM\Column(type: 'integer', nullable: false, options: ['default' => 1])]
  100. private int $isEnabled = 1;
  102. #[ORM\Column(type: 'boolean', nullable: true, options: ['default' => false])]
  103. private ?bool $deleted = false;
  105. /**
  106. * @var QuizUnit[]
  107. */
  108. #[ORM\OneToMany(targetEntity: QuizUnit::class, mappedBy: 'quizSession', cascade: ['persist'])]
  109. private $quizUnits;
  111. /**
  112. * @var bool
  113. */
  114. #[ORM\Column(type: 'boolean', nullable: true)]
  115. private ?bool $durationIgnored;
  117. /**
  118. * @var bool
  119. */
  120. #[ORM\Column(name: 'hints_available', type: 'boolean', nullable: true)]
  121. private ?bool $hintsAvailable;
  123. #[ORM\Column(name: 'results_available_before_deadline', type: 'boolean', nullable: true)]
  124. private ?bool $resultsAvailableBeforeDeadline;
  126. /**
  127. * @var string|null
  128. */
  129. #[ORM\Column(name: 'isbn', type: 'string', length: 255, nullable: true)]
  130. private ?string $isbn;
  132. /**
  133. * @var DateTime
  134. */
  135. #[ORM\Column(name: 'updated_at', type: 'datetime', nullable: true)]
  136. private DateTime $updatedAt;
  138. /**
  139. * @var User
  140. */
  141. #[ORM\JoinColumn(name: 'updated_by', referencedColumnName: 'id')]
  142. #[ORM\ManyToOne(targetEntity: User::class)]
  143. private User $updatedBy;
  145. /**
  146. * @var string|null
  147. */
  148. #[ORM\Column(name: 'description', type: 'text', nullable: true)]
  149. private ?string $description;
  151. /**
  152. * @var DateTime
  153. */
  154. #[ORM\Column(name: 'result_view_open_at', type: 'datetime', nullable: true)]
  155. private ?DateTime $resultViewOpenAt;
  157. /**
  158. * @var ?bool
  159. */
  160. #[ORM\Column(name: 'extra_teachers', type: 'boolean', nullable: true)]
  161. private ?bool $extraTeachers = null;
  163. /**
  164. * possible values: 'self_study_exam', 'self_study_topic', 'self_study_typical_problem'
  165. * If it is null then it is a regular quiz
  166. */
  167. #[ORM\Column(name: 'type', type: 'string', length: 255, nullable: true, options: ['default' => ''])]
  168. private ?string $type = '';
  170. /**
  171. * @var SelfStudyTopic
  172. */
  173. #[ORM\JoinColumn(name: 'self_study_topic', referencedColumnName: 'id')]
  174. #[ORM\ManyToOne(targetEntity: SelfStudyTopic::class)]
  175. private $selfStudyTopic = null;
  177. /**
  178. * @var SelfStudyTypicalExamProblem
  179. */
  180. #[ORM\JoinColumn(name: 'self_study_typical_exam_problem', referencedColumnName: 'id')]
  181. #[ORM\ManyToOne(targetEntity: SelfStudyTypicalExamProblem::class)]
  182. private $selfStudyTypicalExamProblem = null;
  184. /**
  185. * @var SelfStudyExamQuiz
  186. */
  187. #[ORM\JoinColumn(name: 'self_study_exam', referencedColumnName: 'id')]
  188. #[ORM\ManyToOne(targetEntity: SelfStudyExamQuiz::class)]
  189. private $selfStudyExam = null;
  191. /**
  192. * @var bool
  193. */
  194. #[ORM\Column(name: 'deactivated_questions', type: 'boolean', nullable: true)]
  195. private ?bool $deactivatedProblems = null;
  197. /**
  198. * @var bool
  199. */
  200. #[ORM\Column(name: 'is_archived', type: 'boolean', nullable: true)]
  201. private ?bool $isArchived = null;
  204. /**
  205. * @var int|null
  206. */
  207. #[ORM\Column(name: 'copy_of', type: 'integer', nullable: true)]
  208. private ?int $copyOfSession = null;
  210. /**
  211. * @var bool|null
  212. */
  213. #[ORM\Column(name: 'is_shared_quiz', type: 'boolean', nullable: true)]
  214. private ?bool $isSharedQuiz = null;
  216. /**
  217. * @var bool|null
  218. */
  219. #[ORM\Column(name: 'is_pinned', type: 'boolean', nullable: true)]
  220. private ?bool $isPinned = null;
  222. #[ORM\Column(name: 'can_pause', type: 'boolean', options: ['default' => false])]
  223. private bool $canPause = false;
  225. /**
  226. */
  227. public function __construct(?int $duration)
  228. {
  229. $this->createdAt = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  230. $this->updatedAt = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  231. $this->quizUnits = new ArrayCollection();
  232. $this->duration = $duration;
  233. }
  235. public function getCopyOfSession(): ?int
  236. {
  237. return $this->copyOfSession;
  238. }
  240. public function setCopyOfSession(?int $copyOfSession): void
  241. {
  242. $this->copyOfSession = $copyOfSession;
  243. }
  245. public function getId(): int
  246. {
  247. return $this->id;
  248. }
  250. /**
  251. * @return Quiz
  252. */
  253. public function getQuiz(): ?Quiz
  254. {
  255. return $this->quiz;
  256. }
  258. /**
  259. * @param Quiz $quiz
  260. * @return $this
  261. */
  262. public function setQuiz(?Quiz $quiz): static
  263. {
  264. $this->quiz = $quiz;
  265. return $this;
  266. }
  268. /**
  269. * @return User
  270. */
  271. public function getCreatedBy(): ?User
  272. {
  273. return $this->createdBy;
  274. }
  276. /**
  277. * @param User $createdBy
  278. * @return $this
  279. */
  280. public function setCreatedBy(?User $createdBy): static
  281. {
  282. $this->createdBy = $createdBy;
  283. return $this;
  284. }
  286. /**
  287. * @return Classroom
  288. */
  289. public function getClassroom(): ?Classroom
  290. {
  291. return $this->classroom;
  292. }
  294. /**
  295. * @param Classroom $classroom
  296. * @return $this
  297. */
  298. public function setClassroom(?Classroom $classroom)
  299. {
  300. $this->classroom = $classroom;
  301. return $this;
  302. }
  304. /**
  305. * @return boolean
  306. */
  307. public function isDormant(): ?bool
  308. {
  309. return $this->dormant;
  310. }
  312. /**
  313. * @param boolean $dormant
  314. * @return $this
  315. */
  316. public function setDormant(?bool $dormant)
  317. {
  318. $this->dormant = $dormant;
  319. return $this;
  320. }
  322. /**
  323. * @return DateTime
  324. */
  325. public function getStartTime(): ?DateTime
  326. {
  327. return $this->startTime;
  328. }
  330. /**
  331. * @param DateTime $startTime
  332. * @return $this
  333. */
  334. public function setStartTime(?DateTime $startTime)
  335. {
  336. $this->startTime = $startTime;
  337. return $this;
  338. }
  340. public function getCreatedAt(): DateTime
  341. {
  342. return $this->createdAt;
  343. }
  345. public function setCreatedAt(DateTime $createdAt): void
  346. {
  347. $this->createdAt = $createdAt;
  348. }
  350. public function getStatus(): int
  351. {
  352. return $this->status;
  353. }
  355. /**
  356. * @return $this
  357. */
  358. public function setStatus(int $status): static
  359. {
  360. $this->status = $status;
  361. return $this;
  362. }
  364. /**
  365. * @return QuizUnit[]
  366. */
  367. public function getQuizUnits()
  368. {
  369. return $this->quizUnits;
  370. }
  372. /**
  373. * @param QuizUnit[] $quizUnits
  374. * @return $this
  375. */
  376. public function setQuizUnits($quizUnits)
  377. {
  378. $this->quizUnits = $quizUnits;
  379. return $this;
  380. }
  382. /**
  383. * @return $this
  384. */
  385. public function addQuizUnit(QuizUnit $quizUnit)
  386. {
  387. $quizUnit->setQuizSession($this);
  388. $this->quizUnits->add($quizUnit);
  390. return $this;
  391. }
  393. public function getEndTime()
  394. {
  395. if ($this->getDeadline() !== null) {
  396. return $this->getDeadline();
  397. }
  399. $endTime = clone $this->startTime;
  400. return $endTime->modify(sprintf('+%d minutes', $this->getDuration()));
  401. }
  403. public function setIsEnabled(int $isEnabled): void
  404. {
  405. $this->isEnabled = $isEnabled;
  406. }
  408. public function getIsEnabled(): int
  409. {
  410. return $this->isEnabled;
  411. }
  413. public function isDeleted(): ?bool
  414. {
  415. return $this->deleted;
  416. }
  418. public function setDeleted(bool $deleted): void
  419. {
  420. $this->deleted = $deleted;
  421. }
  423. public function getDeadline(): ?DateTime
  424. {
  425. return $this->deadline;
  426. }
  428. public function setDeadline(?DateTime $deadline = null): void
  429. {
  430. $this->deadline = $deadline;
  431. }
  433. public function isDurationIgnored(): ?bool
  434. {
  435. return $this->durationIgnored;
  436. }
  438. public function setDurationIgnored(bool $durationIgnored): void
  439. {
  440. $this->durationIgnored = $durationIgnored;
  441. }
  443. public function getDuration(): ?int
  444. {
  445. return $this->duration;
  446. }
  448. public function setDuration(?int $duration): void
  449. {
  450. $this->duration = $duration;
  451. }
  453. public function isHintsAvailable(): ?bool
  454. {
  455. return $this->hintsAvailable;
  456. }
  458. public function setHintsAvailable(bool $hintsAvailable): void
  459. {
  460. $this->hintsAvailable = $hintsAvailable;
  461. }
  463. public function areResultsAvailableBeforeDeadline(): bool
  464. {
  465. return (bool)$this->resultsAvailableBeforeDeadline;
  466. }
  468. public function setResultsAvailableBeforeDeadline(?bool $resultsAvailableBeforeDeadline): void
  469. {
  470. $this->resultsAvailableBeforeDeadline = $resultsAvailableBeforeDeadline;
  471. }
  473. public function getName(): ?string
  474. {
  475. return $this->name;
  476. }
  478. public function setName(?string $name): void
  479. {
  480. $this->name = $name;
  481. }
  483. public function isHomework(): bool
  484. {
  485. return (bool)$this->deadline;
  486. }
  488. public function getType(): string
  489. {
  490. return $this->type;
  491. }
  493. public function isSelfStudyExamQuiz(): bool
  494. {
  495. return $this->type === 'self_study_exam';
  496. }
  498. public function isSelfStudyTopicQuiz(): bool
  499. {
  500. return $this->type === 'self_study_topic';
  501. }
  503. public function isSelfStudyTypicalProblemQuiz(): bool
  504. {
  505. return $this->type === 'self_study_typical_exam_problem';
  506. }
  508. public function isSelfStudyQuiz(): bool
  509. {
  510. return $this->isSelfStudyExamQuiz() || $this->isSelfStudyTopicQuiz() || $this->isSelfStudyTypicalProblemQuiz();
  511. }
  513. public function setTypeToSelfStudyExamQuiz(): void
  514. {
  515. $this->type = 'self_study_exam';
  516. }
  518. public function setTypeToSelfStudyTopicQuiz(): void
  519. {
  520. $this->type = 'self_study_topic';
  521. }
  523. public function setTypeToSelfStudyTypicalProblemQuiz(): void
  524. {
  525. $this->type = 'self_study_typical_problem';
  526. }
  528. public function setType(?string $type): void
  529. {
  530. $this->type = $type;
  531. }
  533. public function getSelfStudyTopic(): ?SelfStudyTopic
  534. {
  535. return $this->selfStudyTopic;
  536. }
  538. public function setSelfStudyTopic(?SelfStudyTopic $selfStudyTopic): void
  539. {
  540. $this->selfStudyTopic = $selfStudyTopic;
  541. }
  543. public function getSelfStudyTypicalExamProblem(): ?SelfStudyTypicalExamProblem
  544. {
  545. return $this->selfStudyTypicalExamProblem;
  546. }
  548. public function setSelfStudyTypicalExamProblem(?SelfStudyTypicalExamProblem $selfStudyTypicalExamProblem): void
  549. {
  550. $this->selfStudyTypicalExamProblem = $selfStudyTypicalExamProblem;
  551. }
  553. public function getSelfStudyExam(): ?SelfStudyExamQuiz
  554. {
  555. return $this->selfStudyExam;
  556. }
  558. public function setSelfStudyExam(?SelfStudyExamQuiz $selfStudyExam): void
  559. {
  560. $this->selfStudyExam = $selfStudyExam;
  561. }
  563. /**
  564. * @throws Exception
  565. */
  566. public function jsonSerialize(): mixed
  567. {
  568. $topics = [];
  569. $quiz = $this->getQuiz();
  570. if ($quiz) {
  571. foreach ($quiz->getSortedMathproblems() as $problem) {
  572. $template = $problem->getTemplate();
  573. if (!$template) {
  574. continue;
  575. }
  577. $this->getUniqueTopics($template, $topics);
  578. }
  579. $topics = array_values($topics);
  580. }
  582. return [
  583. "duration" => $this->getDuration(),
  584. "id" => $this->getId(),
  585. "name" => $this->prefixNameWithFolderSortOrder($this->getName(), self::FOLDER_ACTIVITY_TYPE, $this->getQuiz()?->getId()),
  586. "startTime" => $this->getStartTime(),
  587. 'deadline' => $this->getDeadline() ?? $this->getEndTime(),
  588. 'isHomework' => $this->isHomework(),
  589. 'secondsUntilDeadline' => $this->getSecondsUntilDeadline(),
  590. 'durationIgnored' => $this->isDurationIgnored(),
  591. 'session_type' => basename(str_replace('\\', '/', __CLASS__)),
  592. 'activity_type' => 'quiz',
  593. 'start' => $this->getStartTime()->getTimestamp(),
  594. 'topics' => $topics
  595. ];
  596. }
  598. public function getSortOrderInFolder(): ?int
  599. {
  600. return $this->getFolderSortOrder(self::FOLDER_ACTIVITY_TYPE, $this->getQuiz()?->getId());
  601. }
  603. public function setISBN(?string $isbn = null): void
  604. {
  605. $this->isbn = $isbn;
  606. }
  608. public function getISBN(): ?string
  609. {
  610. return $this->isbn;
  611. }
  613. public function getUpdatedAt(): DateTime
  614. {
  615. return $this->updatedAt;
  616. }
  618. public function setUpdatedAt(DateTime $updatedAt): void
  619. {
  620. $this->updatedAt = $updatedAt;
  621. }
  623. public function getUpdatedBy(): User
  624. {
  625. return $this->updatedBy;
  626. }
  628. public function setUpdatedBy(User $updatedBy): void
  629. {
  630. $this->updatedBy = $updatedBy;
  631. }
  633. public function getDescription(): string
  634. {
  635. return $this->description;
  636. }
  638. public function setDescription(string $description): void
  639. {
  640. $this->description = $description;
  641. }
  643. public function getResultViewOpenAt(): ?DateTime
  644. {
  645. return $this->resultViewOpenAt;
  646. }
  648. public function setResultViewOpenAt(?DateTime $resultViewOpenAt): void
  649. {
  650. $this->resultViewOpenAt = $resultViewOpenAt;
  651. }
  653. public function hasExtraTeachers(): ?bool
  654. {
  655. return $this->extraTeachers;
  656. }
  658. public function setExtraTeachers(?bool $extraTeachers): void
  659. {
  660. $this->extraTeachers = $extraTeachers;
  661. }
  663. public function hasDeactivatedProblems(): ?bool
  664. {
  665. return $this->deactivatedProblems;
  666. }
  668. public function setDeactivatedProblems(?bool $deactivatedProblems): void
  669. {
  670. $this->deactivatedProblems = $deactivatedProblems;
  671. }
  673. public function isArchived(): ?bool
  674. {
  675. return $this->isArchived;
  676. }
  678. public function setIsArchived(?bool $isArchived): void
  679. {
  680. $this->isArchived = $isArchived;
  681. }
  683. public function isSharedQuiz(): ?bool
  684. {
  685. return $this->isSharedQuiz;
  686. }
  688. public function setIsSharedQuiz(bool $isSharedQuiz): void
  689. {
  690. $this->isSharedQuiz = $isSharedQuiz;
  691. }
  693. public function getIsPinned(): ?bool
  694. {
  695. return $this->isPinned;
  696. }
  698. public function setIsPinned(?bool $isPinned): void
  699. {
  700. $this->isPinned = $isPinned;
  701. }
  703. public function getNameOrDefaultToQuizName(): ?string
  704. {
  705. return trim($this->getName() ?? '') === '' ? $this->getQuiz()->getName() : $this->getName();
  706. }
  708. public function getCanPause(): bool
  709. {
  710. return $this->canPause;
  711. }
  713. public function canPause(): bool
  714. {
  715. return $this->canPause;
  716. }
  718. /**
  719. * @param bool $canPause
  720. */
  721. public function setCanPause(?bool $canPause): void
  722. {
  723. $this->canPause = $canPause;
  724. }
  726. /**
  727. * @throws Exception
  728. */
  729. public function getSecondsUntilDeadline():int
  730. {
  731. if($this->getDeadline() === null){
  732. return 0;
  733. }
  734. $now = new DateTime('now', new DateTimeZone('Europe/Copenhagen'));
  735. $interval = $now->diff($this->getDeadline());
  736. $seconds = ($interval->days * 24 * 60 * 60) + ($interval->h * 60 * 60) + ($interval->i * 60) + $interval->s;
  737. if($interval->invert){
  738. return 0;
  739. }
  740. return $seconds;
  741. }
  743. public function getProblemCount(){
  744. return $this->quiz->getProblemCount();
  745. }
  747. private function getUniqueTopics(TemplateMathproblem $template, array &$topics): void
  748. {
  749. if($topic = $template->getTopic()){
  750. $topics[$topic->getId()] = $topic->jsonSerialize();
  751. }
  752. }
  753. }