src/Entity/Core/Mathproblem.php line 17

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 DateTime;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use JsonSerializable;
  13. use App\Services\Student\Transform;
  15. #[ORM\Table('mathproblem')]
  16. #[ORM\Entity(repositoryClass: MathproblemRepository::class)]
  17. class Mathproblem implements JsonSerializable, HasMediaInterface
  18. {
  19. use HasMediaTraits;
  21. const MATH_PROBLEM_QUIZ = 1;
  22. const MATH_PROBLEM_WORKSHEET = 2;
  23. const MATH_PROBLEM_QUIZ_AND_WORKSHEET = 3;
  25. const STATUS_PUBLISHED = 0;
  26. const STATUS_UNPUBLISHED = 1;
  27. const STATUS_DELETED = 2;
  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 bool
  39. */
  40. #[ORM\Column(name: 'validated', type: 'boolean', nullable: true)]
  41. private $validated;
  44. /**
  45. * @var string
  46. */
  47. #[ORM\Column(name: 'name', type: 'string', nullable: false)]
  48. private $name;
  50. /**
  51. * @var string
  52. */
  53. #[ORM\Column(name: 'description', type: 'string', length: 8000, nullable: true)]
  54. private $description;
  56. /**
  57. * The possible choices for this Mathproblem, will only be populated when type is 'multi'.
  58. *
  59. * @var ArrayCollection
  60. */
  61. #[ORM\OneToMany(targetEntity: Answer::class, mappedBy: 'mathproblem', cascade: ['persist', 'remove'])]
  62. private $answers;
  64. /**
  65. * @var ArrayCollection
  66. */
  67. #[ORM\OneToMany(targetEntity: BugReport::class, mappedBy: 'problem', cascade: ['persist', 'remove'])]
  68. private $bugReports;
  70. #[ORM\JoinColumn(nullable: true)]
  71. #[ORM\ManyToOne(targetEntity: Video::class)]
  72. private ?Video $video;
  74. /**
  75. * @var string
  76. */
  77. #[ORM\Column(name: 'hint', type: 'string', length: 2000, nullable: true)]
  78. private $hint;
  80. /**
  81. * @var string
  82. */
  83. #[ORM\Column(name: 'video_hint', type: 'string', length: 300, nullable: true)]
  84. private $videoHint;
  86. /**
  87. * @var string
  88. */
  89. #[ORM\Column(name: 'solution', type: 'string', length: 3000, nullable: true)]
  90. private $solution;
  92. /**
  93. * @var string
  94. */
  95. #[ORM\Column(name: 'free_text', type: 'text', nullable: true)]
  96. private $freeText;
  98. /**
  99. * @var string
  100. */
  101. #[ORM\Column(name: 'intro_text', type: 'text', nullable: true)]
  102. private $introText;
  104. /**
  105. * Mathproblem template
  106. */
  107. #[ORM\JoinColumn(name: 'template_id', referencedColumnName: 'id')]
  108. #[ORM\ManyToOne(targetEntity: TemplateMathproblem::class, inversedBy: 'mathproblems')]
  109. private $template;
  111. /**
  112. * Relative path to the GeoGebra problem script file.
  113. *
  114. * @var string
  115. */
  116. #[ORM\Column(type: 'string', nullable: true)]
  117. private $geogebra;
  119. /**
  120. * 0 - available/published
  121. * 1 - unpublished
  122. * 2 - deleted
  123. *
  124. * @var ?int
  125. */
  126. #[ORM\Column(name: 'status', type: 'integer', nullable: true)]
  127. private $status;
  129. /**
  130. * @var int
  131. */
  132. #[ORM\Column(name: 'subquestion_nr', type: 'smallint', nullable: true)]
  133. private $subquestionNr;
  135. /**
  136. * Flag used to check if there's any next or previous problem
  137. * @var bool
  138. */
  139. private $hasNext;
  141. /**
  142. * Flag used to control if the problem should be searchable in a quiz
  143. * @var bool
  144. */
  145. #[ORM\Column(name: 'allow_in_quiz_or_worksheet', type: 'boolean', nullable: true)]
  146. private $allowInQuizOrWorksheet;
  148. #[ORM\OneToMany(targetEntity: RelationQuizMathproblem::class, mappedBy: 'mathproblem')]
  149. private Collection $quizzes;
  151. /**
  152. * @var ArrayCollection
  153. */
  154. #[ORM\JoinTable(name: 'problems_appendices')]
  155. #[ORM\JoinColumn(name: 'problem_id', referencedColumnName: 'id')]
  156. #[ORM\InverseJoinColumn(name: 'appendix_id', referencedColumnName: 'id')]
  157. #[ORM\ManyToMany(targetEntity: Appendix::class, inversedBy: 'problems', cascade: ['persist', 'remove'])]
  158. private $appendices;
  160. #[ORM\JoinColumn(name: 'video_reference', referencedColumnName: 'id', nullable: true)]
  161. #[ORM\OneToOne(targetEntity: VideoReference::class, inversedBy: 'mathproblem')]
  162. private ?VideoReference $videoReference;
  164. /**
  165. * @var DateTime
  166. */
  167. #[ORM\Column(name: 'createdAt', type: 'datetime', nullable: false)]
  168. private DateTime $createdAt;
  170. /**
  171. * 0 = default view
  172. * 1,2,3,... = alternate views, that can vary by problem type
  173. *
  174. * @var int
  175. */
  176. #[ORM\Column(name: 'view_mode', type: 'smallint', options: ['default' => 0])]
  177. private int $viewMode = 0;
  179. public array $excludeKeys = [];
  181. protected bool $useTransform = false;
  182. protected Transform $transform;
  185. #[ORM\OneToOne(targetEntity: ProblemDnd::class, mappedBy: 'problem')]
  186. private $problemDnd;
  189. static function setTransform(Transform $transform){
  190. self::$transform = $transform;
  191. }
  193. public function __construct()
  194. {
  195. $this->answers = new ArrayCollection();
  196. $this->appendices = new ArrayCollection();
  197. $this->quizzes = new ArrayCollection();
  198. $this->imageReference = null;
  199. $this->videoReference = null;
  200. $this->audioReference = null;
  201. }
  203. /**
  204. * @return int
  205. */
  206. public function getId()
  207. {
  208. return $this->id;
  209. }
  211. /**
  212. * @return string
  213. */
  214. public function getName()
  215. {
  216. return $this->name;
  217. }
  219. public function setName(string $name)
  220. {
  221. $this->name = $name;
  222. }
  224. /**
  225. * @return string
  226. */
  227. public function getDescription()
  228. {
  229. return $this->description ?? '';
  230. }
  232. public function setDescription(string $description)
  233. {
  234. $this->description = $description;
  235. }
  237. public function getAnswers(): Collection
  238. {
  239. return $this->answers;
  240. }
  242. public function getHint(): ?string
  243. {
  244. return $this->hint;
  245. }
  247. public function setHint(?string $hint)
  248. {
  249. $this->hint = $hint;
  250. }
  252. public function getVideoHint(): ?string
  253. {
  254. return $this->videoHint;
  255. }
  257. public function setVideoHint(?string $videoHint): void
  258. {
  259. $this->videoHint = $videoHint;
  260. }
  264. public function getSolution(): ?string
  265. {
  266. return $this->solution;
  267. }
  269. public function setSolution(?string $solution)
  270. {
  271. $this->solution = $solution;
  272. }
  274. /**
  275. * @return TemplateMathproblem
  276. */
  277. public function getTemplate()
  278. {
  279. return $this->template;
  280. }
  282. public function setTemplate(TemplateMathproblem $template)
  283. {
  284. $this->template = $template;
  285. }
  287. /**
  288. * @return ?int
  289. */
  290. public function getStatus()
  291. {
  292. return $this->status;
  293. }
  295. /**
  296. * @param ?int $status
  297. */
  298. public function setStatus($status)
  299. {
  300. $this->status = $status;
  301. }
  303. /**
  304. * Status helper function
  305. */
  306. public function isPublished(): bool
  307. {
  308. // Treating null as published since status is nullable, and it would have been treated like this before, though it should not happen.
  309. return $this->status === self::STATUS_PUBLISHED || $this->status === null;
  310. }
  312. /**
  313. * Status helper function
  314. */
  315. public function setPublished(): void
  316. {
  317. $this->status = self::STATUS_PUBLISHED;
  318. }
  320. /**
  321. * Status helper function
  322. */
  323. public function isUnpublished(): bool
  324. {
  325. return $this->status === self::STATUS_UNPUBLISHED;
  326. }
  328. /**
  329. * Status helper function
  330. */
  331. public function setUnpublished(): void
  332. {
  333. $this->status = self::STATUS_UNPUBLISHED;
  334. }
  336. /**
  337. * Status helper function
  338. */
  339. public function isDeleted(): bool
  340. {
  341. return $this->status === self::STATUS_DELETED;
  342. }
  344. /**
  345. * Status helper function
  346. */
  347. public function setDeleted(): void
  348. {
  349. $this->status = self::STATUS_DELETED;
  350. }
  352. /**
  353. * @return int
  354. */
  355. public function getSubquestionNr()
  356. {
  357. return $this->subquestionNr;
  358. }
  360. /**
  361. * @param int $subquestionNr
  362. *
  363. * Specify if the math problem is part of a bigger question with several subquestions
  364. *
  365. */
  366. public function setSubquestionNr($subquestionNr)
  367. {
  368. $this->subquestionNr = $subquestionNr;
  369. }
  371. public function getGeogebra(): ?string
  372. {
  373. return $this->geogebra;
  374. }
  376. public function getFreeText(): ?string
  377. {
  378. return $this->freeText;
  379. }
  381. public function setFreeText(?string $freeText): void
  382. {
  383. $this->freeText = $freeText;
  384. }
  386. public function getIntroText(): ?string
  387. {
  388. return $this->introText;
  389. }
  391. public function setIntroText(?string $introText): void
  392. {
  393. $this->introText = $introText;
  394. }
  396. public function getCorrectAnswer(): ?Answer
  397. {
  398. $correctAnswer = null;
  399. foreach ($this->answers as $answer) {
  400. if ($answer->getIsCorrect()) {
  401. $correctAnswer = $answer;
  402. break;
  403. }
  404. }
  406. return $correctAnswer;
  407. }
  409. public function getWrongAnswer(): ?Answer
  410. {
  411. $wrongAnswer = null;
  412. foreach ($this->answers as $answer) {
  413. if (!$answer->getIsCorrect()) {
  414. $wrongAnswer = $answer;
  415. break;
  416. }
  417. }
  419. return $wrongAnswer;
  420. }
  422. public function getCorrectAnswers(): ?array
  423. {
  424. // TODO - Jon's part, try to optimize for reusing
  425. $answerString = $this->getCorrectAnswer()->getAnswerText();
  427. $type = $this->getTemplate()->getType();
  428. if ($type === TemplateMathproblem::TYPE_DROPDOWN) {
  429. // Get correct answers dynamically
  430. $stringArray = explode("#", $answerString);
  431. $correctAnswers = [];
  432. $index = 0;
  433. foreach ($stringArray as $str) {
  434. // if string contains '|', it contains dropdown options
  435. if (!(strpos($str, '|') === false)) {
  436. $dropdownChoices = explode("|", $str);
  437. $correctAnswers[$index] = $dropdownChoices[0];
  438. foreach ($dropdownChoices as $choice){
  439. if(preg_match("#^\*#", $choice) || preg_match("#\*$#", $choice)){
  440. $choice = preg_replace("#^\*#", "", $choice);
  441. $choice = preg_replace("#\*$#", "", $choice);
  442. $correctAnswers[$index] = $choice;
  443. }
  444. }
  445. $index++;
  446. }
  447. }
  449. return $correctAnswers;
  450. } elseif ($type === TemplateMathproblem::TYPE_WORD_OPTIONS) {
  451. $stringArray = explode("#", $answerString);
  452. $correctAnswers = [];
  453. for ($i = 1; $i < count($stringArray); $i += 2) {
  454. $str = $stringArray[$i];
  455. if (in_array($str, ['<br>', '<br/>'])) {
  456. continue;
  457. }
  458. if (strpos($str, '|') === false) {
  459. $correctAnswers[] = 'default';
  460. } else {
  461. $correctAnswers[] = explode('|', $str)[1];
  462. }
  463. }
  465. return $correctAnswers;
  466. } else {
  467. // TODO: perhaps make this possible for other template types too.
  468. return null;
  469. }
  470. }
  472. /**
  473. * @return bool
  474. */
  475. public function getHasNext(){
  476. return $this->hasNext;
  477. }
  479. public function setHasNext($hasNext){
  480. $this->hasNext = $hasNext;
  481. }
  483. public function getAppendices(): Collection
  484. {
  485. return $this->appendices;
  486. }
  488. public function setAppendices(ArrayCollection $appendices): void
  489. {
  490. $this->appendices = $appendices;
  491. }
  493. public function getVideo(): ?Video
  494. {
  495. return $this->video;
  496. }
  498. function jsonSerialize(): mixed
  499. {
  501. // Initialize the $video property if it's not already initialized.
  502. $this->video ??= null;
  504. $data = [
  505. "id" => $this->getId(),
  506. "name" => $this->getName(),
  507. "description" => $this->getDescription(),
  508. "introText" => $this->getIntroText(),
  509. "freeText" => $this->getFreeText(),
  510. "hint" => $this->getHint(),
  511. "correctAnswer" => $this->getCorrectAnswer(),
  512. "template" => $this->getTemplate(),
  513. "status" => $this->getStatus(),
  514. "subquestionNr" => $this->getSubquestionNr(),
  515. "georgeBra" => $this->getGeogebra(),
  516. "solution" => $this->getSolution(),
  517. "image" => $this->getImagePath(),
  518. "appendices" => $this->getAppendices()->toArray(),
  519. "hasNext" => $this->getHasNext(),
  520. "video" => $this->getVideo(),
  521. "wrongAnswer" => $this->getWrongAnswer(),
  522. "topicDisplayName" => $this->getTemplate()->getTopic()->getDisplayName(),
  523. "options" => $this->getCorrectAnswer() && $this->getCorrectAnswer()->getAnswerText() ? explode("#", $this->getCorrectAnswer()->getAnswerText()) : [],
  524. "viewMode" => $this->getViewMode(),
  525. ];
  527. for ($i=0, $count = count($this->excludeKeys); $i < $count; $i++){
  528. if(isset( $data[ $this->excludeKeys[$i] ] )){
  529. unset( $data[ $this->excludeKeys[$i] ] );
  530. }
  531. }
  533. $answers = $this->getAnswers()->toArray();
  535. if($this->getTemplate()->getShouldShuffle()){
  536. shuffle($answers);
  537. }
  538. $data['answers'] = $answers;
  540. return $data;
  542. }
  544. /**
  545. * @return $this
  546. */
  547. function exclude(array $keys): self{
  548. $this->excludeKeys = $keys;
  549. return $this;
  550. }
  552. /**
  553. * @return $this
  554. */
  555. function setUseTransform(bool $useTransform = true) : self{
  556. $this->useTransform = $useTransform;
  557. return $this;
  558. }
  560. public function getAllowInQuizOrWorksheet(): ?bool
  561. {
  562. return $this->allowInQuizOrWorksheet;
  563. }
  565. public function setAllowInQuizOrWorksheet(?bool $allowInQuizOrWorksheet): void
  566. {
  567. $this->allowInQuizOrWorksheet = $allowInQuizOrWorksheet;
  568. }
  570. public function getViewMode(): int
  571. {
  572. return $this->viewMode;
  573. }
  575. public function getDifficulty() {
  576. return $this->template->getDifficulty();
  577. }
  579. public function getCorrectAnswerText() {
  580. return $this->getCorrectAnswer()?->getAnswerText();
  581. }
  583. /*
  584. * Used for EasyAdmin problem form
  585. *
  586. * */
  588. public function getTemplateId() {
  589. return $this->getTemplate()->getId();
  590. }
  592. public function getType() {
  593. return $this?->getTemplate()?->getType();
  594. }
  596. public function setType(int $type) {
  597. $this->getTemplate()->setType($type);
  598. }
  600. public function getQuizzes(): Collection
  601. {
  602. $quizzes = new ArrayCollection();
  604. foreach ($this->quizzes as $quiz) {
  605. $quizzes->add($quiz->getQuiz());
  606. }
  607. return $quizzes;
  608. }
  610. public function getQuizId(): ?int {
  611. $quizzes = $this->getQuizzes();
  612. return $quizzes[0]?->getId();
  613. }
  615. public function getPublicationName(): string {
  616. $quizzes = $this->getQuizzes();
  617. return $quizzes[0]?->getPublication()?->getName();
  618. }
  620. public function isValidated(): bool
  621. {
  622. return $this->validated ?? false;
  623. }
  625. public function setValidated(bool $validated): void
  626. {
  627. $this->validated = $validated;
  628. }
  630. public function getProblemText(): string {
  631. return '';
  632. }
  634. public function setProblemText(string $text) {
  635. }
  637. public function __toString(): string
  638. {
  639. return $this->name;
  640. }
  642. public function setViewMode(int $viewMode): void
  643. {
  644. $this->viewMode = $viewMode;
  645. }
  647. public function getSnippet(): string
  648. {
  649. // Placeholder for EasyAdmin, value will be overwritten, so it does not matter what is returned.
  650. return '';
  651. }
  653. /**
  654. * @return ?ProblemDnd
  655. */
  656. public function getProblemDnd()
  657. {
  658. return $this->problemDnd;
  659. }
  661. public function getVideoReference(): ?VideoReference
  662. {
  663. return $this->videoReference;
  664. }
  666. public function setVideoReference(?VideoReference $videoReference): void
  667. {
  668. $this->videoReference = $videoReference;
  669. }
  671. public function isValidatedAndHasMediaFiles(): bool
  672. {
  673. if (!$this->isValidated()) {
  674. return false;
  675. }
  677. // detect if problem has media files
  678. if ($this->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  679. return false;
  680. }
  682. if ($this->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  683. return false;
  684. }
  686. // detect if answers have media files
  687. foreach ($this->getAnswers() as $answer) {
  689. if ($answer->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  690. return false;
  691. }
  693. if ($answer->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  694. return false;
  695. }
  696. }
  698. // detect if containers have media files if dnd
  699. if ($this->getType() === 4) {
  701. $bins = $this->getProblemDnd()->getBins();
  703. foreach ($bins as $bin) {
  704. if ($bin->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  705. return false;
  706. }
  708. if ($bin->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  709. return false;
  710. }
  711. }
  712. }
  714. return $this->isValidated();
  715. }
  717. public function getActiveBugReports(): array
  718. {
  719. $bugReports = $this->bugReports;
  721. $activeBugReports = [];
  722. foreach ($bugReports as $bugReport) {
  723. if ($bugReport->getDateResolved() === null) {
  724. $activeBugReports[] = $bugReport->getId();
  725. }
  726. }
  727. return $activeBugReports;
  728. }
  730. public function getCreatedAt(): DateTime
  731. {
  732. return $this->createdAt;
  733. }
  735. public function setCreatedAt(DateTime $createdAt): void
  736. {
  737. $this->createdAt = $createdAt;
  738. }
  740. public function getTopic(): ?string
  741. {
  742. return $this->getTemplate()?->getTopic()?->getName();
  743. }
  745. public function setTopic(Topic $topic)
  746. {
  747. $this->getTemplate()?->setTopic($topic);
  748. }
  750. public function getCategory(): ?string
  751. {
  752. return $this->getTemplate()?->getTopic()?->getCategory()?->getName();
  753. }
  755. public function getImage(){
  756. return $this->getImagePath();
  757. }
  759. public function getCmsImagePath(): string
  760. {
  761. if (!$this->imageReference) {
  762. return 'Mangler';
  763. }
  765. if (!$this->imageReference->getFilePath()) {
  766. return 'Mangler fil';
  767. }
  769. return $this->getImagePath();
  770. }
  772. public function getCmsAudioPath(): string
  773. {
  774. if (!$this->audioReference) {
  775. return 'Mangler';
  776. }
  778. if (!$this->audioReference->getFilePath()) {
  779. return 'Mangler fil';
  780. }
  782. return $this->getAudioPath();
  783. }
  785. }