src/Entity/Core/Quiz/Quiz.php line 25

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity\Core\Quiz;
  7. use App\Entity\Core\Classroom\ClassroomType;
  8. use App\Entity\Core\HasMediaInterface;
  9. use App\Entity\Core\HasMediaTraits;
  10. use App\Entity\Core\Mathproblem;
  11. use App\Entity\Core\Publication;
  12. use App\Entity\Core\RelationQuizMathproblem;
  13. use App\Entity\Core\Topic\Topic;
  14. use App\Entity\Core\VideoReference;
  15. use App\Entity\User\User;
  16. use App\Services\Core\ActivityTypeMappingService;
  17. use DateTime;
  18. use Doctrine\Common\Collections\ArrayCollection;
  19. use Doctrine\Common\Collections\Collection;
  20. use Doctrine\ORM\Mapping as ORM;
  21. use Symfony\Component\HttpFoundation\Exception\BadRequestException;
  23. #[ORM\Table('quiz')]
  24. #[ORM\Entity(repositoryClass: QuizRepository::class)]
  25. class Quiz implements HasMediaInterface
  26. {
  27. use HasMediaTraits;
  29. /**
  30. * @var int
  31. */
  32. #[ORM\Column(name: 'id', type: 'integer')]
  33. #[ORM\Id]
  34. #[ORM\GeneratedValue(strategy: 'AUTO')]
  35. private $id;
  37. /**
  38. * @var int
  39. */
  40. #[ORM\Column(type: 'integer', nullable: false, options: ['default' => 0])]
  41. private $duration;
  43. /**
  44. * @var string
  45. */
  46. #[ORM\Column(name: 'name', type: 'string', length: 255, nullable: true)]
  47. private $name;
  49. /**
  50. * @var string
  51. */
  52. #[ORM\Column(name: 'description', type: 'string', length: 500, nullable: true)]
  53. private $description;
  55. /**
  56. * @var bool
  57. */
  58. #[ORM\Column(name: 'enabled', type: 'boolean', options: ['default' => 1])]
  59. private $enabled;
  61. /**
  62. * @var Publication
  63. */
  64. #[ORM\JoinColumn(name: 'publication_id', referencedColumnName: 'id')]
  65. #[ORM\ManyToOne(targetEntity: Publication::class, inversedBy: 'quizzes')]
  66. private $publication;
  68. #[ORM\OneToMany(targetEntity: RelationQuizMathproblem::class, mappedBy: 'quiz', cascade: ['persist'])]
  69. private Collection $mathproblems;
  71. /**
  72. * @var array
  73. */
  74. #[ORM\Column(name: 'problem_order', type: 'simple_array', nullable: true)]
  75. private $problemOrder;
  77. /**
  78. * @var array
  79. */
  80. #[ORM\Column(name: 'mathproblems_for_templates', type: 'simple_array', nullable: true)]
  81. private $mathproblemsForTemplates;
  83. /**
  84. * @var bool
  85. */
  86. #[ORM\Column(name: 'reusable', type: 'boolean', nullable: false)]
  87. private $reusable;
  89. /**
  90. * @var bool
  91. */
  92. #[ORM\Column(name: 'abacus', type: 'boolean', nullable: true, options: ['default' => 0])]
  93. private $abacus;
  95. /**
  96. * @var bool
  97. */
  98. #[ORM\Column(name: 'target_student', type: 'boolean', nullable: true, options: ['default' => 0])]
  99. private $targetStudent;
  101. /**
  102. * @var Topic
  103. */
  104. #[ORM\JoinColumn(name: 'topic', referencedColumnName: 'id')]
  105. #[ORM\ManyToOne(targetEntity: Topic::class)]
  106. private $topic;
  108. /**
  109. * @var DateTime
  110. */
  111. #[ORM\Column(name: 'createdAt', type: 'datetime', nullable: false)]
  112. private $createdAt;
  114. /**
  115. * @var User
  116. */
  117. #[ORM\JoinColumn(name: 'created_by', referencedColumnName: 'id')]
  118. #[ORM\ManyToOne(targetEntity: User::class)]
  119. private $createdBy;
  121. /**
  122. * @var User[]
  123. */
  124. #[ORM\JoinTable(name: 'quiz_teacher')]
  125. #[ORM\JoinColumn(name: 'quiz_id', referencedColumnName: 'id')]
  126. #[ORM\InverseJoinColumn(name: 'teacher_id', referencedColumnName: 'id')]
  127. #[ORM\ManyToMany(targetEntity: User::class)]
  128. private $teachers;
  130. /**
  131. * @var QuizSession[]
  132. */
  133. #[ORM\OneToMany(targetEntity: QuizSession::class, mappedBy: 'quiz', cascade: ['persist'])]
  134. private $quizSessions;
  136. /**
  137. * @var ClassroomType
  138. */
  139. #[ORM\JoinColumn(name: 'level', referencedColumnName: 'id', nullable: true)]
  140. #[ORM\ManyToOne(targetEntity: ClassroomType::class)]
  141. private $level;
  143. /**
  144. * @var QuizType|null
  145. */
  146. #[ORM\JoinColumn(name: 'type', referencedColumnName: 'id', nullable: true)]
  147. #[ORM\ManyToOne(targetEntity: QuizType::class)]
  148. private $type;
  150. /**
  151. * @var array
  152. */
  153. #[ORM\Column(name: 'color_wrong_count_threshold', type: 'simple_array', nullable: true)]
  154. private $colorWrongCountThreshold;
  156. /**
  157. * @var array
  158. */
  159. #[ORM\Column(name: 'color_percentage_threshold', type: 'simple_array', nullable: true)]
  160. private $colorPercentageThreshold;
  162. /**
  163. * @var string
  164. */
  165. #[ORM\Column(name: 'ibook_id', type: 'string', length: 255, nullable: true)]
  166. private ?string $iBookId;
  168. #[ORM\JoinColumn(name: 'video_reference', referencedColumnName: 'id', nullable: true)]
  169. #[ORM\OneToOne(targetEntity: VideoReference::class, inversedBy: 'quiz')]
  170. private ?VideoReference $videoReference;
  173. public function __construct()
  174. {
  175. $this->enabled = true;
  176. $this->mathproblems = new ArrayCollection();
  177. $this->teachers = new ArrayCollection();
  178. $this->quizSessions = new ArrayCollection();
  179. $this->createdAt = new DateTime("now");
  180. $this->imageReference = null;
  181. $this->videoReference = null;
  182. $this->audioReference = null;
  183. }
  185. /**
  186. * Get id.
  187. *
  188. * @return int
  189. */
  190. public function getId()
  191. {
  192. return $this->id;
  193. }
  195. /**
  196. * @return mixed
  197. */
  198. public function getName()
  199. {
  200. return $this->name;
  201. }
  203. /**
  204. * @param string $name
  205. *
  206. * @return $this
  207. */
  208. public function setName($name)
  209. {
  210. $this->name = $name;
  212. return $this;
  213. }
  215. /**
  216. * Set duration.
  217. *
  218. * @param int $duration
  219. *
  220. * @return $this
  221. */
  222. public function setDuration($duration)
  223. {
  224. $this->duration = $duration;
  226. return $this;
  227. }
  229. /**
  230. * Get duration.
  231. *
  232. * @return int
  233. */
  234. public function getDuration()
  235. {
  236. return $this->duration;
  237. }
  239. /**
  240. * @return ArrayCollection|Mathproblem[]
  241. */
  242. public function getMathproblems(): Collection
  243. {
  244. $mathproblems = new ArrayCollection();
  246. foreach ($this->mathproblems as $mathproblem) {
  247. $mathproblems->add($mathproblem->getMathproblem());
  248. }
  250. return $mathproblems;
  251. }
  253. /**
  254. * @return ArrayCollection|Mathproblem[]
  255. */
  256. public function getEnabledMathproblems(): Collection
  257. {
  258. $mathproblems = new ArrayCollection();
  260. foreach ($this->mathproblems as $mathproblem) {
  261. if ($mathproblem->getEnabled()) {
  262. $mathproblems->add($mathproblem->getMathproblem());
  263. }
  264. }
  266. return $mathproblems;
  267. }
  269. /**
  270. * @return ArrayCollection|Mathproblem[]
  271. */
  272. public function getEnabledAndPublishedMathproblems(): Collection
  273. {
  274. $mathproblems = new ArrayCollection();
  276. foreach ($this->mathproblems as $mathproblem) {
  277. if ($mathproblem->getEnabled() && $mathproblem->getMathproblem()->isPublished()) {
  278. $mathproblems->add($mathproblem->getMathproblem());
  279. }
  280. }
  282. return $mathproblems;
  283. }
  285. /**
  286. * @return array
  287. */
  288. public function getSortedMathproblems()
  289. {
  290. $problemOrder = $this->problemOrder;
  291. $mathproblems = $this->getEnabledMathproblems();
  293. if ($problemOrder && count($problemOrder) == count($mathproblems)) {
  294. $newmathproblems = [];
  295. foreach ($mathproblems as $mp) {
  296. $newkey = array_search($mp->getID(), $problemOrder);
  297. $newmathproblems[$newkey] = $mp;
  298. }
  299. ksort($newmathproblems);
  301. return $newmathproblems;
  302. } else {
  303. return $this->getEnabledMathproblems()->toArray();
  304. }
  305. }
  307. /**
  308. * @param Mathproblem[]
  309. */
  310. public function setMathproblems(array $mathproblems)
  311. {
  312. // don't allow setting problems to a quiz that already has problems
  313. if ($this->mathproblems->count() > 0) {
  314. throw new BadRequestException('Cannot set mathproblems on a quiz that already has mathproblems');
  315. }
  317. foreach ($mathproblems as $mathproblem) {
  318. $this->addMathproblem($mathproblem);
  319. }
  320. }
  322. /**
  323. * This collection can be used to edit the relations directly,
  324. * remember to also remove the entity, when removing a relation.
  325. */
  326. public function getMathproblemRelations(): ArrayCollection|Collection
  327. {
  328. return $this->mathproblems;
  329. }
  331. /**
  332. * @param Mathproblem
  333. */
  334. public function addMathproblem($mathproblem)
  335. {
  336. $relation = new RelationQuizMathproblem();
  337. $relation->setQuiz($this);
  338. $relation->setMathproblem($mathproblem);
  339. $relation->setEnabled(true);
  340. $this->mathproblems->add($relation);
  341. }
  343. public function enableProblem(Mathproblem $problem): void
  344. {
  345. foreach ($this->mathproblems as $relation) {
  346. if ($relation->getMathproblem()->getId() === $problem->getId()) {
  347. $relation->setEnabled(true);
  348. return;
  349. }
  350. }
  351. }
  353. /**
  354. * @return bool
  355. */
  356. public function getReusable()
  357. {
  358. return $this->reusable;
  359. }
  361. /**
  362. * @param bool $reusable
  363. *
  364. * @return $this
  365. */
  366. public function setReusable($reusable)
  367. {
  368. $this->reusable = $reusable;
  370. return $this;
  371. }
  373. /**
  374. * @return DateTime
  375. */
  376. public function getCreatedAt()
  377. {
  378. return $this->createdAt;
  379. }
  381. /**
  382. * @return User
  383. */
  384. public function getCreatedBy()
  385. {
  386. return $this->createdBy;
  387. }
  389. /**
  390. * @param User $createdBy
  391. *
  392. * @return $this
  393. */
  394. public function setCreatedBy($createdBy)
  395. {
  396. $this->createdBy = $createdBy;
  398. return $this;
  399. }
  401. public function getTeachers(): Collection
  402. {
  403. return $this->teachers;
  404. }
  406. /**
  407. * @return $this
  408. */
  409. public function addTeacher(User $teacher)
  410. {
  411. $this->teachers->add($teacher);
  413. return $this;
  414. }
  416. public function getQuizSessions(): Collection
  417. {
  418. return $this->quizSessions;
  419. }
  421. /**
  422. * @param QuizSession[] $quizSessions
  423. *
  424. * @return $this
  425. */
  426. public function setQuizSessions($quizSessions)
  427. {
  428. $this->quizSessions = $quizSessions;
  430. return $this;
  431. }
  433. /**
  434. * @return $this
  435. */
  436. public function addQuizSession(QuizSession $quizSession)
  437. {
  438. $this->quizSessions->add($quizSession);
  439. $quizSession->setQuiz($this);
  441. return $this;
  442. }
  444. /**
  445. * @return bool
  446. */
  447. public function isAbacus()
  448. {
  449. return $this->abacus;
  450. }
  452. /**
  453. * @param bool $abacus
  454. */
  455. public function setAbacus($abacus)
  456. {
  457. $this->abacus = $abacus;
  458. }
  460. /**
  461. * @return bool | null
  462. */
  463. public function isTargetStudent()
  464. {
  465. return $this->targetStudent;
  466. }
  468. public function setTargetStudent(bool $targetStudent)
  469. {
  470. $this->targetStudent = $targetStudent;
  471. }
  473. /**
  474. * @return Topic | null
  475. */
  476. public function getTopic()
  477. {
  478. return $this->topic;
  479. }
  481. public function setTopic(Topic $topic)
  482. {
  483. $this->topic = $topic;
  484. }
  486. public function getLevel(): ?ClassroomType
  487. {
  488. return $this->level;
  489. }
  491. public function setLevel(?ClassroomType $level): void
  492. {
  493. $this->level = $level;
  494. }
  496. public function getProblemOrder(): ?array
  497. {
  498. return $this->problemOrder;
  499. }
  501. public function setProblemOrder(array $problemOrder)
  502. {
  503. $this->problemOrder = $problemOrder;
  504. }
  506. /** Removes IDs of disabled/removed problems and appends IDs of enabled problems not yet in the order. */
  507. public function syncProblemOrder(): void
  508. {
  509. $enabledIds = $this->getEnabledMathproblems()->map(fn($mp) => $mp->getId())->toArray();
  510. $order = array_values(array_filter($this->problemOrder ?? [], fn($id) => in_array($id, $enabledIds)));
  511. $missing = array_diff($enabledIds, $order);
  512. $this->problemOrder = array_merge($order, array_values($missing));
  513. }
  515. public function getType(): QuizType | null
  516. {
  517. return $this->type;
  518. }
  520. public function setType(?QuizType $type): void
  521. {
  522. $this->type = $type;
  523. }
  525. /**
  526. * @return array|null
  527. */
  528. public function getMathproblemsForTemplates()
  529. {
  530. return $this->mathproblemsForTemplates;
  531. }
  533. public function setMathproblemsForTemplates(array $mathproblemsForTemplates): void
  534. {
  535. $this->mathproblemsForTemplates = $mathproblemsForTemplates;
  536. }
  538. public function getDescription(): string | null
  539. {
  540. return $this->description;
  541. }
  543. public function setDescription(string $description): void
  544. {
  545. $this->description = $description;
  546. }
  548. public function getColorWrongCountThreshold(): ?array
  549. {
  550. return $this->colorWrongCountThreshold;
  551. }
  553. public function getColorPercentageThreshold(): ?array
  554. {
  555. return $this->colorPercentageThreshold;
  556. }
  559. public function getPublication(): ?Publication
  560. {
  561. return $this->publication;
  562. }
  564. public function setPublication(Publication $publication): void
  565. {
  566. $this->publication = $publication;
  567. }
  569. public function getEnabled(): bool
  570. {
  571. return $this->enabled;
  572. }
  574. public function setEnabled(string $enabled): void
  575. {
  576. $this->enabled = $enabled;
  577. }
  579. public function __toString()
  580. {
  581. return ($this->name ? $this->name . ' ' : '') . '(' . $this->id . ')';
  582. }
  584. public function getCmsImagePath(): string
  585. {
  586. if (!$this->imageReference) {
  587. return 'Mangler';
  588. }
  590. if (!$this->imageReference->getFilePath()) {
  591. return 'Mangler fil';
  592. }
  594. return $this->getImagePath();
  595. }
  597. public function getVideoReference(): ?VideoReference
  598. {
  599. return $this->videoReference;
  600. }
  602. public function setVideoReference(?VideoReference $videoReference): void
  603. {
  604. $this->videoReference = $videoReference;
  605. }
  607. public function getIBookId(): ?string
  608. {
  609. return $this->iBookId;
  610. }
  612. public function setIBookId(): void
  613. {
  614. $part1 = bin2hex(random_bytes(4));
  615. $part2 = $this->id;
  617. $this->iBookId = $part1 . '_' . $part2;
  618. }
  620. public function isABaCusQuiz(): bool
  621. {
  622. // abacus/kvik quizzes have abacus=1 and targetStudent=0
  623. return $this->abacus && !$this->targetStudent;
  624. }
  626. public function setIsABaCusQuiz($isABaCusQuiz): void
  627. {
  628. if ($isABaCusQuiz) {
  629. $this->abacus = true;
  630. $this->targetStudent = false;
  631. } else {
  632. $this->abacus = null;
  633. $this->targetStudent = null;
  635. }
  636. }
  638. public function getProblemCount(): int
  639. {
  640. return count($this->getEnabledMathproblems());
  641. }
  643. public function toLightweightArray(ActivityTypeMappingService $activityTypeMappingService): array
  644. {
  645. return [
  646. 'id' => $this->getId(),
  647. 'type' => $activityTypeMappingService->getActivityTypeFromClass(Quiz::class),
  648. 'name' => $this->getName(),
  649. 'description' => $this->getDescription(),
  650. 'duration' => $this->getDuration(),
  651. 'enabled' => $this->getEnabled(),
  652. 'problemCount' => $this->getProblemCount(),
  653. 'classroomType' => $this->getLevel()?->getId(),
  654. ];
  655. }
  656. }