src/Entity/Core/Mathproblem.php line 16

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity\Core;
  7. use App\Entity\Core\Topic\Topic;
  8. use Doctrine\Common\Collections\ArrayCollection;
  9. use Doctrine\Common\Collections\Collection;
  10. use Doctrine\ORM\Mapping as ORM;
  11. use JsonSerializable;
  12. use App\Services\Student\Transform;
  14. #[ORM\Table('mathproblem')]
  15. #[ORM\Entity(repositoryClass: MathproblemRepository::class)]
  16. class Mathproblem implements JsonSerializable, HasMediaInterface
  17. {
  18. use HasMediaTraits;
  20. const MATH_PROBLEM_QUIZ = 1;
  21. const MATH_PROBLEM_WORKSHEET = 2;
  22. const MATH_PROBLEM_QUIZ_AND_WORKSHEET = 3;
  24. const STATUS_PUBLISHED = 0;
  25. const STATUS_UNPUBLISHED = 1;
  26. const STATUS_DELETED = 2;
  28. /**
  29. * @var int
  30. */
  31. #[ORM\Column(name: 'id', type: 'integer')]
  32. #[ORM\Id]
  33. #[ORM\GeneratedValue(strategy: 'AUTO')]
  34. private $id;
  36. /**
  37. * @var bool
  38. */
  39. #[ORM\Column(name: 'validated', type: 'boolean', nullable: true)]
  40. private $validated;
  43. /**
  44. * @var string
  45. */
  46. #[ORM\Column(name: 'name', type: 'string', nullable: false)]
  47. private $name;
  49. /**
  50. * @var string
  51. */
  52. #[ORM\Column(name: 'description', type: 'string', length: 8000, nullable: true)]
  53. private $description;
  55. /**
  56. * The possible choices for this Mathproblem, will only be populated when type is 'multi'.
  57. *
  58. * @var ArrayCollection
  59. */
  60. #[ORM\OneToMany(targetEntity: \App\Entity\Core\Answer::class, mappedBy: 'mathproblem', cascade: ['persist', 'remove'])]
  61. private $answers;
  63. /**
  64. * @var ArrayCollection
  65. */
  66. #[ORM\OneToMany(targetEntity: \App\Entity\Core\BugReport::class, mappedBy: 'problem', cascade: ['persist', 'remove'])]
  67. private $bugReports;
  69. #[ORM\JoinColumn(nullable: true)]
  70. #[ORM\ManyToOne(targetEntity: \App\Entity\Core\Video::class)]
  71. private ?Video $video;
  73. /**
  74. * @var string
  75. */
  76. #[ORM\Column(name: 'hint', type: 'string', length: 2000, nullable: true)]
  77. private $hint;
  79. /**
  80. * @var string
  81. */
  82. #[ORM\Column(name: 'video_hint', type: 'string', length: 300, nullable: true)]
  83. private $videoHint;
  85. /**
  86. * @var string
  87. */
  88. #[ORM\Column(name: 'solution', type: 'string', length: 3000, nullable: true)]
  89. private $solution;
  91. /**
  92. * @var string
  93. */
  94. #[ORM\Column(name: 'free_text', type: 'text', nullable: true)]
  95. private $freeText;
  97. /**
  98. * @var string
  99. */
  100. #[ORM\Column(name: 'intro_text', type: 'text', nullable: true)]
  101. private $introText;
  103. /**
  104. * Mathproblem template
  105. */
  106. #[ORM\JoinColumn(name: 'template_id', referencedColumnName: 'id')]
  107. #[ORM\ManyToOne(targetEntity: \App\Entity\Core\TemplateMathproblem::class, inversedBy: 'mathproblems')]
  108. private $template;
  110. /**
  111. * Relative path to the GeoGebra problem script file.
  112. *
  113. * @var string
  114. */
  115. #[ORM\Column(type: 'string', nullable: true)]
  116. private $geogebra;
  118. /**
  119. * 0 - available/published
  120. * 1 - unpublished
  121. * 2 - deleted
  122. *
  123. * @var ?int
  124. */
  125. #[ORM\Column(name: 'status', type: 'integer', nullable: true)]
  126. private $status;
  128. /**
  129. * @var int
  130. */
  131. #[ORM\Column(name: 'subquestion_nr', type: 'smallint', nullable: true)]
  132. private $subquestionNr;
  134. /**
  135. * Flag used to check if there's any next or previous problem
  136. * @var bool
  137. */
  138. private $hasNext;
  140. /**
  141. * Flag used to control if the problem should be searchable in a quiz
  142. * @var bool
  143. */
  144. #[ORM\Column(name: 'allow_in_quiz_or_worksheet', type: 'boolean', nullable: true)]
  145. private $allowInQuizOrWorksheet;
  147. #[ORM\OneToMany(targetEntity: \App\Entity\Core\RelationQuizMathproblem::class, mappedBy: 'mathproblem')]
  148. private Collection $quizzes;
  150. /**
  151. * @var ArrayCollection
  152. */
  153. #[ORM\JoinTable(name: 'problems_appendices')]
  154. #[ORM\JoinColumn(name: 'problem_id', referencedColumnName: 'id')]
  155. #[ORM\InverseJoinColumn(name: 'appendix_id', referencedColumnName: 'id')]
  156. #[ORM\ManyToMany(targetEntity: \App\Entity\Core\Appendix::class, inversedBy: 'problems', cascade: ['persist', 'remove'])]
  157. private $appendices;
  159. #[ORM\JoinColumn(name: 'video_reference', referencedColumnName: 'id', nullable: true)]
  160. #[ORM\OneToOne(targetEntity: \App\Entity\Core\VideoReference::class, inversedBy: 'mathproblem')]
  161. private ?VideoReference $videoReference;
  163. /**
  164. * @var \DateTime
  165. */
  166. #[ORM\Column(name: 'createdAt', type: 'datetime', nullable: false)]
  167. private \DateTime $createdAt;
  169. /**
  170. * 0 = default view
  171. * 1,2,3,... = alternate views, that can vary by problem type
  172. *
  173. * @var int
  174. */
  175. #[ORM\Column(name: 'view_mode', type: 'smallint', options: ['default' => 0])]
  176. private int $viewMode = 0;
  178. public array $excludeKeys = [];
  180. protected bool $useTransform = false;
  181. protected Transform $transform;
  184. #[ORM\OneToOne(targetEntity: \App\Entity\Core\ProblemDnd::class, mappedBy: 'problem')]
  185. private $problemDnd;
  188. static function setTransform(Transform $transform){
  189. self::$transform = $transform;
  190. }
  192. public function __construct()
  193. {
  194. $this->answers = new ArrayCollection();
  195. $this->appendices = new ArrayCollection();
  196. $this->quizzes = new ArrayCollection();
  197. $this->imageReference = null;
  198. $this->videoReference = null;
  199. $this->audioReference = null;
  200. }
  202. /**
  203. * @return int
  204. */
  205. public function getId()
  206. {
  207. return $this->id;
  208. }
  210. /**
  211. * @return string
  212. */
  213. public function getName()
  214. {
  215. return $this->name;
  216. }
  218. public function setName(string $name)
  219. {
  220. $this->name = $name;
  221. }
  223. /**
  224. * @return string
  225. */
  226. public function getDescription()
  227. {
  228. return $this->description ?? '';
  229. }
  231. public function setDescription(string $description)
  232. {
  233. $this->description = $description;
  234. }
  236. public function getAnswers(): Collection
  237. {
  238. return $this->answers;
  239. }
  241. public function getHint(): ?string
  242. {
  243. return $this->hint;
  244. }
  246. public function setHint(?string $hint)
  247. {
  248. $this->hint = $hint;
  249. }
  251. /**
  252. * @return string|null
  253. */
  254. public function getVideoHint(): ?string
  255. {
  256. return $this->videoHint;
  257. }
  259. /**
  260. * @param string|null $videoHint
  261. */
  262. public function setVideoHint(?string $videoHint): void
  263. {
  264. $this->videoHint = $videoHint;
  265. }
  269. public function getSolution(): ?string
  270. {
  271. return $this->solution;
  272. }
  274. public function setSolution(?string $solution)
  275. {
  276. $this->solution = $solution;
  277. }
  279. /**
  280. * @return TemplateMathproblem
  281. */
  282. public function getTemplate()
  283. {
  284. return $this->template;
  285. }
  287. public function setTemplate(TemplateMathproblem $template)
  288. {
  289. $this->template = $template;
  290. }
  292. /**
  293. * @return ?int
  294. */
  295. public function getStatus()
  296. {
  297. return $this->status;
  298. }
  300. /**
  301. * @param ?int $status
  302. */
  303. public function setStatus($status)
  304. {
  305. $this->status = $status;
  306. }
  308. /**
  309. * Status helper function
  310. */
  311. public function isPublished(): bool
  312. {
  313. // Treating null as published since status is nullable, and it would have been treated like this before, though it should not happen.
  314. return $this->status === self::STATUS_PUBLISHED || $this->status === null;
  315. }
  317. /**
  318. * Status helper function
  319. */
  320. public function setPublished(): void
  321. {
  322. $this->status = self::STATUS_PUBLISHED;
  323. }
  325. /**
  326. * Status helper function
  327. */
  328. public function isUnpublished(): bool
  329. {
  330. return $this->status === self::STATUS_UNPUBLISHED;
  331. }
  333. /**
  334. * Status helper function
  335. */
  336. public function setUnpublished(): void
  337. {
  338. $this->status = self::STATUS_UNPUBLISHED;
  339. }
  341. /**
  342. * Status helper function
  343. */
  344. public function isDeleted(): bool
  345. {
  346. return $this->status === self::STATUS_DELETED;
  347. }
  349. /**
  350. * Status helper function
  351. */
  352. public function setDeleted(): void
  353. {
  354. $this->status = self::STATUS_DELETED;
  355. }
  357. /**
  358. * @return int
  359. */
  360. public function getSubquestionNr()
  361. {
  362. return $this->subquestionNr;
  363. }
  365. /**
  366. * @param int $subquestionNr
  367. *
  368. * Specify if the math problem is part of a bigger question with several subquestions
  369. *
  370. */
  371. public function setSubquestionNr($subquestionNr)
  372. {
  373. $this->subquestionNr = $subquestionNr;
  374. }
  376. public function getGeogebra(): ?string
  377. {
  378. return $this->geogebra;
  379. }
  381. /**
  382. * @return string|null
  383. */
  384. public function getFreeText(): ?string
  385. {
  386. return $this->freeText;
  387. }
  389. /**
  390. * @param string|null $freeText
  391. */
  392. public function setFreeText(?string $freeText): void
  393. {
  394. $this->freeText = $freeText;
  395. }
  397. /**
  398. * @return string|null
  399. */
  400. public function getIntroText(): ?string
  401. {
  402. return $this->introText;
  403. }
  405. /**
  406. * @param string|null $introText
  407. */
  408. public function setIntroText(?string $introText): void
  409. {
  410. $this->introText = $introText;
  411. }
  413. public function getCorrectAnswer(): ?Answer
  414. {
  415. $correctAnswer = null;
  416. foreach ($this->answers as $answer) {
  417. if ($answer->getIsCorrect()) {
  418. $correctAnswer = $answer;
  419. break;
  420. }
  421. }
  423. return $correctAnswer;
  424. }
  426. public function getWrongAnswer(): ?Answer
  427. {
  428. $wrongAnswer = null;
  429. foreach ($this->answers as $answer) {
  430. if (!$answer->getIsCorrect()) {
  431. $wrongAnswer = $answer;
  432. break;
  433. }
  434. }
  436. return $wrongAnswer;
  437. }
  439. /**
  440. * @return array|null
  441. */
  442. public function getCorrectAnswers(): ?array
  443. {
  444. // TODO - Jon's part, try to optimize for reusing
  445. $answerString = $this->getCorrectAnswer()->getAnswerText();
  447. $type = $this->getTemplate()->getType();
  448. if ($type === TemplateMathproblem::TYPE_DROPDOWN) {
  449. // Get correct answers dynamically
  450. $stringArray = explode("#", $answerString);
  451. $correctAnswers = [];
  452. $index = 0;
  453. foreach ($stringArray as $str) {
  454. // if string contains '|', it contains dropdown options
  455. if (!(strpos($str, '|') === false)) {
  456. $dropdownChoices = explode("|", $str);
  457. $correctAnswers[$index] = $dropdownChoices[0];
  458. foreach ($dropdownChoices as $choice){
  459. if(preg_match("#^\*#", $choice) || preg_match("#\*$#", $choice)){
  460. $choice = preg_replace("#^\*#", "", $choice);
  461. $choice = preg_replace("#\*$#", "", $choice);
  462. $correctAnswers[$index] = $choice;
  463. }
  464. }
  465. $index++;
  466. }
  467. }
  469. return $correctAnswers;
  470. } elseif ($type === TemplateMathproblem::TYPE_WORD_OPTIONS) {
  471. $stringArray = explode("#", $answerString);
  472. $correctAnswers = [];
  473. for ($i = 1; $i < count($stringArray); $i += 2) {
  474. $str = $stringArray[$i];
  475. if (in_array($str, ['<br>', '<br/>'])) {
  476. continue;
  477. }
  478. if (strpos($str, '|') === false) {
  479. $correctAnswers[] = 'default';
  480. } else {
  481. $correctAnswers[] = explode('|', $str)[1];
  482. }
  483. }
  485. return $correctAnswers;
  486. } else {
  487. // TODO: perhaps make this possible for other template types too.
  488. return null;
  489. }
  490. }
  492. /**
  493. * @return bool
  494. */
  495. public function getHasNext(){
  496. return $this->hasNext;
  497. }
  499. public function setHasNext($hasNext){
  500. $this->hasNext = $hasNext;
  501. }
  503. public function getAppendices(): Collection
  504. {
  505. return $this->appendices;
  506. }
  508. public function setAppendices(ArrayCollection $appendices): void
  509. {
  510. $this->appendices = $appendices;
  511. }
  513. public function getVideo(): ?Video
  514. {
  515. return $this->video;
  516. }
  518. function jsonSerialize(): mixed
  519. {
  521. // Initialize the $video property if it's not already initialized.
  522. $this->video ??= null;
  524. $data = [
  525. "id" => $this->getId(),
  526. "name" => $this->getName(),
  527. "description" => $this->getDescription(),
  528. "introText" => $this->getIntroText(),
  529. "freeText" => $this->getFreeText(),
  530. "hint" => $this->getHint(),
  531. "correctAnswer" => $this->getCorrectAnswer(),
  532. "template" => $this->getTemplate(),
  533. "status" => $this->getStatus(),
  534. "subquestionNr" => $this->getSubquestionNr(),
  535. "georgeBra" => $this->getGeogebra(),
  536. "solution" => $this->getSolution(),
  537. "image" => $this->getImagePath(),
  538. "appendices" => $this->getAppendices()->toArray(),
  539. "hasNext" => $this->getHasNext(),
  540. "video" => $this->getVideo(),
  541. "wrongAnswer" => $this->getWrongAnswer(),
  542. "topicDisplayName" => $this->getTemplate()->getTopic()->getDisplayName(),
  543. "options" => $this->getCorrectAnswer() && $this->getCorrectAnswer()->getAnswerText() ? explode("#", $this->getCorrectAnswer()->getAnswerText()) : [],
  544. "viewMode" => $this->getViewMode(),
  545. ];
  547. for ($i=0, $count = count($this->excludeKeys); $i < $count; $i++){
  548. if(isset( $data[ $this->excludeKeys[$i] ] )){
  549. unset( $data[ $this->excludeKeys[$i] ] );
  550. }
  551. }
  553. $answers = $this->getAnswers()->toArray();
  555. if($this->getTemplate()->getShouldShuffle()){
  556. shuffle($answers);
  557. }
  558. $data['answers'] = $answers;
  560. return $data;
  562. }
  564. /**
  565. * @param array $keys
  566. * @return $this
  567. */
  568. function exclude(array $keys): self{
  569. $this->excludeKeys = $keys;
  570. return $this;
  571. }
  573. /**
  574. * @param bool $useTransform
  575. * @return $this
  576. */
  577. function setUseTransform(bool $useTransform = true) : self{
  578. $this->useTransform = $useTransform;
  579. return $this;
  580. }
  582. public function getAllowInQuizOrWorksheet(): ?bool
  583. {
  584. return $this->allowInQuizOrWorksheet;
  585. }
  587. public function setAllowInQuizOrWorksheet(?bool $allowInQuizOrWorksheet): void
  588. {
  589. $this->allowInQuizOrWorksheet = $allowInQuizOrWorksheet;
  590. }
  592. public function getViewMode(): int
  593. {
  594. return $this->viewMode;
  595. }
  597. public function getDifficulty() {
  598. return $this->template->getDifficulty();
  599. }
  601. public function getCorrectAnswerText() {
  602. return $this->getCorrectAnswer()?->getAnswerText();
  603. }
  605. /*
  606. * Used for EasyAdmin problem form
  607. *
  608. * */
  610. public function getTemplateId() {
  611. return $this->getTemplate()->getId();
  612. }
  614. public function getType() {
  615. return $this?->getTemplate()?->getType();
  616. }
  618. public function setType(int $type) {
  619. $this->getTemplate()->setType($type);
  620. }
  622. public function getQuizzes(): Collection
  623. {
  624. $quizzes = new ArrayCollection();
  626. foreach ($this->quizzes as $quiz) {
  627. $quizzes->add($quiz->getQuiz());
  628. }
  629. return $quizzes;
  630. }
  632. public function getQuizId(): ?int {
  633. $quizzes = $this->getQuizzes();
  634. return $quizzes[0]?->getId();
  635. }
  637. public function getPublicationName(): string {
  638. $quizzes = $this->getQuizzes();
  639. return $quizzes[0]?->getPublication()?->getName();
  640. }
  642. public function isValidated(): bool
  643. {
  644. return $this->validated ?? false;
  645. }
  647. public function setValidated(bool $validated): void
  648. {
  649. $this->validated = $validated;
  650. }
  652. public function getProblemText(): string {
  653. return '';
  654. }
  656. public function setProblemText(string $text) {
  657. }
  659. public function __toString(): string
  660. {
  661. return $this->name;
  662. }
  664. public function setViewMode(int $viewMode): void
  665. {
  666. $this->viewMode = $viewMode;
  667. }
  669. public function getSnippet(): string
  670. {
  671. // Placeholder for EasyAdmin, value will be overwritten, so it does not matter what is returned.
  672. return '';
  673. }
  675. /**
  676. * @return ?ProblemDnd
  677. */
  678. public function getProblemDnd()
  679. {
  680. return $this->problemDnd;
  681. }
  683. public function getVideoReference(): ?VideoReference
  684. {
  685. return $this->videoReference;
  686. }
  688. public function setVideoReference(?VideoReference $videoReference): void
  689. {
  690. $this->videoReference = $videoReference;
  691. }
  693. public function isValidatedAndHasMediaFiles(): bool
  694. {
  695. if (!$this->isValidated()) {
  696. return false;
  697. }
  699. // detect if problem has media files
  700. if ($this->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  701. return false;
  702. }
  704. if ($this->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  705. return false;
  706. }
  708. // detect if answers have media files
  709. foreach ($this->getAnswers() as $answer) {
  711. if ($answer->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  712. return false;
  713. }
  715. if ($answer->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  716. return false;
  717. }
  718. }
  720. // detect if containers have media files if dnd
  721. if ($this->getType() === 4) {
  723. $bins = $this->getProblemDnd()->getBins();
  725. foreach ($bins as $bin) {
  726. if ($bin->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  727. return false;
  728. }
  730. if ($bin->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  731. return false;
  732. }
  733. }
  734. }
  736. return $this->isValidated();
  737. }
  739. public function getActiveBugReports(): array
  740. {
  741. $bugReports = $this->bugReports;
  743. $activeBugReports = [];
  744. foreach ($bugReports as $bugReport) {
  745. if ($bugReport->getDateResolved() === null) {
  746. $activeBugReports[] = $bugReport->getId();
  747. }
  748. }
  749. return $activeBugReports;
  750. }
  752. public function getCreatedAt(): \DateTime
  753. {
  754. return $this->createdAt;
  755. }
  757. public function setCreatedAt(\DateTime $createdAt): void
  758. {
  759. $this->createdAt = $createdAt;
  760. }
  762. public function getTopic(): ?string
  763. {
  764. return $this->getTemplate()?->getTopic()?->getName();
  765. }
  767. public function setTopic(Topic $topic)
  768. {
  769. $this->getTemplate()?->setTopic($topic);
  770. }
  772. public function getCategory(): ?string
  773. {
  774. return $this->getTemplate()?->getTopic()?->getCategory()?->getName();
  775. }
  777. public function getImage(){
  778. return $this->getImagePath();
  779. }
  781. public function getCmsImagePath(): string
  782. {
  783. if (!$this->imageReference) {
  784. return 'Mangler';
  785. }
  787. if (!$this->imageReference->getFilePath()) {
  788. return 'Mangler fil';
  789. }
  791. return $this->getImagePath();
  792. }
  794. public function getCmsAudioPath(): string
  795. {
  796. if (!$this->audioReference) {
  797. return 'Mangler';
  798. }
  800. if (!$this->audioReference->getFilePath()) {
  801. return 'Mangler fil';
  802. }
  804. return $this->getAudioPath();
  805. }
  807. }