src/CoreBundle/Entity/Mathproblem.php line 17

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace CoreBundle\Entity;
  7. use Doctrine\Common\Collections\ArrayCollection;
  8. use Doctrine\Common\Collections\Collection;
  9. use Doctrine\ORM\Mapping as ORM;
  10. use JsonSerializable;
  11. use StudentBundle\Service\Transform;
  13. /**
  14. * @ORM\Table("mathproblem")
  15. * @ORM\Entity(repositoryClass="MathproblemRepository")
  16. */
  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. */
  36. private $id;
  38. /**
  39. * @var bool
  40. * @ORM\Column(name="validated", type="boolean", nullable=true)
  41. */
  42. private $validated;
  45. /**
  46. * @var string
  47. *
  48. * @ORM\Column(name="name", type="string", nullable=false)
  49. */
  50. private $name;
  52. /**
  53. * @var string
  54. *
  55. * @ORM\Column(name="description", type="string", length=8000, nullable=true)
  56. */
  57. private $description;
  59. /**
  60. * The possible choices for this Mathproblem, will only be populated when type is 'multi'.
  61. *
  62. * @var ArrayCollection
  63. *
  64. * @ORM\OneToMany(targetEntity="Answer", mappedBy="mathproblem", cascade={"persist", "remove"})
  65. */
  66. private $answers;
  68. /**
  69. * @var ArrayCollection
  70. *
  71. * @ORM\OneToMany(targetEntity="BugReport", mappedBy="problem", cascade={"persist", "remove"})
  72. */
  73. private $bugReports;
  75. /**
  76. * @var string
  77. *
  78. * @ORM\Column(name="mp_image", type="string", nullable=true)
  79. */
  80. private $mpImage;
  81. // @TODO delete
  83. /**
  84. * @ORM\ManyToOne(targetEntity="Video")
  85. * @ORM\JoinColumn(nullable=true)
  86. */
  87. private ?Video $video;
  89. /**
  90. * @var string
  91. * @ORM\Column(name="hint", type="string", length=2000, nullable=true)
  92. */
  93. private $hint;
  95. /**
  96. * @var string
  97. * @ORM\Column(name="video_hint", type="string", length=300, nullable=true)
  98. */
  99. private $videoHint;
  101. /**
  102. * @var string
  103. * @ORM\Column(name="solution", type="string", length=3000, nullable=true)
  104. */
  105. private $solution;
  107. /**
  108. * @var string
  109. *
  110. * @ORM\Column(name="free_text", type="text", nullable=true)
  111. */
  112. private $freeText;
  114. /**
  115. * @var string
  116. *
  117. * @ORM\Column(name="intro_text", type="text", nullable=true)
  118. */
  119. private $introText;
  121. /**
  122. * Mathproblem template
  123. *
  124. * @ORM\ManyToOne(targetEntity="TemplateMathproblem", inversedBy="mathproblems")
  125. * @ORM\JoinColumn(name="template_id", referencedColumnName="id")
  126. */
  127. private $template;
  129. /**
  130. * Relative path to the GeoGebra problem script file.
  131. *
  132. * @var string
  133. *
  134. * @ORM\Column(type="string", nullable=true)
  135. */
  136. private $geogebra;
  138. /**
  139. * 0 - available/published
  140. * 1 - unpublished
  141. * 2 - deleted
  142. *
  143. * @var ?int
  144. * @ORM\Column(name="status", type="integer", nullable=true)
  145. */
  146. private $status;
  148. /**
  149. * @var int
  150. * @ORM\Column(name="subquestion_nr", type="smallint", nullable=true)
  151. */
  152. private $subquestionNr;
  154. /**
  155. * Flag used to check if there's any next or previous problem
  156. * @var bool
  157. */
  158. private $hasNext;
  160. /**
  161. * Flag used to control if the problem should be searchable in a quiz
  162. * @var bool
  163. * @ORM\Column(name="allow_in_quiz_or_worksheet", type="boolean", nullable=true)
  164. */
  165. private $allowInQuizOrWorksheet;
  167. /**
  168. * @ORM\OneToMany(targetEntity="RelationQuizMathproblem", mappedBy="mathproblem")
  169. */
  170. private Collection $quizzes;
  172. /**
  173. * @var ArrayCollection
  174. *
  175. * @ORM\ManyToMany(targetEntity="Appendix", inversedBy="problems", cascade={"persist", "remove"})
  176. * @ORM\JoinTable(name="problems_appendices",
  177. * joinColumns={@ORM\JoinColumn(name="problem_id", referencedColumnName="id")},
  178. * inverseJoinColumns={@ORM\JoinColumn(name="appendix_id", referencedColumnName="id")})
  179. */
  180. private $appendices;
  182. /**
  183. * @ORM\OneToOne(targetEntity="VideoReference", inversedBy="mathproblem")
  184. * @ORM\JoinColumn(name="video_reference", referencedColumnName="id", nullable=true)
  185. */
  186. private ?VideoReference $videoReference;
  188. /**
  189. * @var \DateTime
  190. *
  191. * @ORM\Column(name="createdAt", type="datetime", nullable=false)
  192. */
  193. private \DateTime $createdAt;
  195. /**
  196. * 0 = default view
  197. * 1,2,3,... = alternate views, that can vary by problem type
  198. *
  199. * @var int
  200. * @ORM\Column(name="view_mode", type="smallint", options={"default" : 0})
  201. */
  202. private int $viewMode = 0;
  204. public array $excludeKeys = [];
  206. protected bool $useTransform = false;
  207. protected Transform $transform;
  210. /**
  211. * @ORM\OneToOne(targetEntity="ProblemDnd", mappedBy="problem")
  212. */
  213. private $problemDnd;
  216. static function setTransform(Transform $transform){
  217. self::$transform = $transform;
  218. }
  220. public function __construct()
  221. {
  222. $this->answers = new ArrayCollection();
  223. $this->appendices = new ArrayCollection();
  224. $this->quizzes = new ArrayCollection();
  225. $this->imageReference = null;
  226. $this->videoReference = null;
  227. $this->audioReference = null;
  228. }
  230. /**
  231. * @return int
  232. */
  233. public function getId()
  234. {
  235. return $this->id;
  236. }
  238. /**
  239. * @return string
  240. */
  241. public function getName()
  242. {
  243. return $this->name;
  244. }
  246. public function setName(string $name)
  247. {
  248. $this->name = $name;
  249. }
  251. /**
  252. * @return string
  253. */
  254. public function getDescription()
  255. {
  256. return $this->description ?? '';
  257. }
  259. public function setDescription(string $description)
  260. {
  261. $this->description = $description;
  262. }
  264. public function getAnswers(): Collection
  265. {
  266. return $this->answers;
  267. }
  269. public function getHint(): ?string
  270. {
  271. return $this->hint;
  272. }
  274. public function setHint(?string $hint)
  275. {
  276. $this->hint = $hint;
  277. }
  279. /**
  280. * @return string|null
  281. */
  282. public function getVideoHint(): ?string
  283. {
  284. return $this->videoHint;
  285. }
  287. /**
  288. * @param string|null $videoHint
  289. */
  290. public function setVideoHint(?string $videoHint): void
  291. {
  292. $this->videoHint = $videoHint;
  293. }
  297. public function getSolution(): ?string
  298. {
  299. return $this->solution;
  300. }
  302. public function setSolution(?string $solution)
  303. {
  304. $this->solution = $solution;
  305. }
  307. /**
  308. * @return TemplateMathproblem
  309. */
  310. public function getTemplate()
  311. {
  312. return $this->template;
  313. }
  315. public function setTemplate(TemplateMathproblem $template)
  316. {
  317. $this->template = $template;
  318. }
  320. /**
  321. * @return string
  322. */
  323. public function getMpImage()
  324. {
  325. // @TODO delete
  326. return 'Obsolete, use getImagePath() instead';
  327. }
  329. /**
  330. * @return ?int
  331. */
  332. public function getStatus()
  333. {
  334. return $this->status;
  335. }
  337. /**
  338. * @param ?int $status
  339. */
  340. public function setStatus($status)
  341. {
  342. $this->status = $status;
  343. }
  345. /**
  346. * Status helper function
  347. */
  348. public function isPublished(): bool
  349. {
  350. // Treating null as published since status is nullable, and it would have been treated like this before, though it should not happen.
  351. return $this->status === self::STATUS_PUBLISHED || $this->status === null;
  352. }
  354. /**
  355. * Status helper function
  356. */
  357. public function setPublished(): void
  358. {
  359. $this->status = self::STATUS_PUBLISHED;
  360. }
  362. /**
  363. * Status helper function
  364. */
  365. public function isUnpublished(): bool
  366. {
  367. return $this->status === self::STATUS_UNPUBLISHED;
  368. }
  370. /**
  371. * Status helper function
  372. */
  373. public function setUnpublished(): void
  374. {
  375. $this->status = self::STATUS_UNPUBLISHED;
  376. }
  378. /**
  379. * Status helper function
  380. */
  381. public function isDeleted(): bool
  382. {
  383. return $this->status === self::STATUS_DELETED;
  384. }
  386. /**
  387. * Status helper function
  388. */
  389. public function setDeleted(): void
  390. {
  391. $this->status = self::STATUS_DELETED;
  392. }
  394. /**
  395. * @return int
  396. */
  397. public function getSubquestionNr()
  398. {
  399. return $this->subquestionNr;
  400. }
  402. /**
  403. * @param int $subquestionNr
  404. *
  405. * Specify if the math problem is part of a bigger question with several subquestions
  406. *
  407. */
  408. public function setSubquestionNr($subquestionNr)
  409. {
  410. $this->subquestionNr = $subquestionNr;
  411. }
  413. public function getGeogebra(): ?string
  414. {
  415. return $this->geogebra;
  416. }
  418. /**
  419. * @return string|null
  420. */
  421. public function getFreeText(): ?string
  422. {
  423. return $this->freeText;
  424. }
  426. /**
  427. * @param string|null $freeText
  428. */
  429. public function setFreeText(?string $freeText): void
  430. {
  431. $this->freeText = $freeText;
  432. }
  434. /**
  435. * @return string|null
  436. */
  437. public function getIntroText(): ?string
  438. {
  439. return $this->introText;
  440. }
  442. /**
  443. * @param string|null $introText
  444. */
  445. public function setIntroText(?string $introText): void
  446. {
  447. $this->introText = $introText;
  448. }
  450. public function getCorrectAnswer(): ?Answer
  451. {
  452. $correctAnswer = null;
  453. foreach ($this->answers as $answer) {
  454. if ($answer->getIsCorrect()) {
  455. $correctAnswer = $answer;
  456. break;
  457. }
  458. }
  460. return $correctAnswer;
  461. }
  463. public function getWrongAnswer(): ?Answer
  464. {
  465. $wrongAnswer = null;
  466. foreach ($this->answers as $answer) {
  467. if (!$answer->getIsCorrect()) {
  468. $wrongAnswer = $answer;
  469. break;
  470. }
  471. }
  473. return $wrongAnswer;
  474. }
  476. /**
  477. * @return array|null
  478. */
  479. public function getCorrectAnswers(): ?array
  480. {
  481. // TODO - Jon's part, try to optimize for reusing
  482. $answerString = $this->getCorrectAnswer()->getAnswerText();
  484. $type = $this->getTemplate()->getType();
  485. if ($type === TemplateMathproblem::TYPE_DROPDOWN) {
  486. // Get correct answers dynamically
  487. $stringArray = explode("#", $answerString);
  488. $correctAnswers = [];
  489. $index = 0;
  490. foreach ($stringArray as $str) {
  491. // if string contains '|', it contains dropdown options
  492. if (!(strpos($str, '|') === false)) {
  493. $dropdownChoices = explode("|", $str);
  494. $correctAnswers[$index] = $dropdownChoices[0];
  495. foreach ($dropdownChoices as $choice){
  496. if(preg_match("#^\*#", $choice) || preg_match("#\*$#", $choice)){
  497. $choice = preg_replace("#^\*#", "", $choice);
  498. $choice = preg_replace("#\*$#", "", $choice);
  499. $correctAnswers[$index] = $choice;
  500. }
  501. }
  502. $index++;
  503. }
  504. }
  506. return $correctAnswers;
  507. } elseif ($type === TemplateMathproblem::TYPE_WORD_OPTIONS) {
  508. $stringArray = explode("#", $answerString);
  509. $correctAnswers = [];
  510. for ($i = 1; $i < count($stringArray); $i += 2) {
  511. $str = $stringArray[$i];
  512. if (in_array($str, ['<br>', '<br/>'])) {
  513. continue;
  514. }
  515. if (strpos($str, '|') === false) {
  516. $correctAnswers[] = 'default';
  517. } else {
  518. $correctAnswers[] = explode('|', $str)[1];
  519. }
  520. }
  522. return $correctAnswers;
  523. } else {
  524. // TODO: perhaps make this possible for other template types too.
  525. return null;
  526. }
  527. }
  529. /**
  530. * @return bool
  531. */
  532. public function getHasNext(){
  533. return $this->hasNext;
  534. }
  536. public function setHasNext($hasNext){
  537. $this->hasNext = $hasNext;
  538. }
  540. public function getAppendices(): Collection
  541. {
  542. return $this->appendices;
  543. }
  545. public function setAppendices(ArrayCollection $appendices): void
  546. {
  547. $this->appendices = $appendices;
  548. }
  550. public function getVideo(): ?Video
  551. {
  552. return $this->video;
  553. }
  555. function jsonSerialize(): mixed
  556. {
  558. // Initialize the $video property if it's not already initialized.
  559. $this->video ??= null;
  561. $data = [
  562. "id" => $this->getId(),
  563. "name" => $this->getName(),
  564. "description" => $this->getDescription(),
  565. "introText" => $this->getIntroText(),
  566. "freeText" => $this->getFreeText(),
  567. "hint" => $this->getHint(),
  568. "correctAnswer" => $this->getCorrectAnswer(),
  569. "template" => $this->getTemplate(),
  570. "status" => $this->getStatus(),
  571. "subquestionNr" => $this->getSubquestionNr(),
  572. "georgeBra" => $this->getGeogebra(),
  573. "solution" => $this->getSolution(),
  574. "image" => $this->getImagePath(),
  575. "appendices" => $this->getAppendices()->toArray(),
  576. "hasNext" => $this->getHasNext(),
  577. "video" => $this->getVideo(),
  578. "wrongAnswer" => $this->getWrongAnswer(),
  579. "topicDisplayName" => $this->getTemplate()->getTopic()->getDisplayName(),
  580. "options" => $this->getCorrectAnswer() && $this->getCorrectAnswer()->getAnswerText() ? explode("#", $this->getCorrectAnswer()->getAnswerText()) : [],
  581. "viewMode" => $this->getViewMode(),
  582. ];
  584. for ($i=0, $count = count($this->excludeKeys); $i < $count; $i++){
  585. if(isset( $data[ $this->excludeKeys[$i] ] )){
  586. unset( $data[ $this->excludeKeys[$i] ] );
  587. }
  588. }
  590. $answers = $this->getAnswers()->toArray();
  592. if($this->getTemplate()->getShouldShuffle()){
  593. shuffle($answers);
  594. }
  595. $data['answers'] = $answers;
  597. return $data;
  599. }
  601. /**
  602. * @param array $keys
  603. * @return $this
  604. */
  605. function exclude(array $keys): self{
  606. $this->excludeKeys = $keys;
  607. return $this;
  608. }
  610. /**
  611. * @param bool $useTransform
  612. * @return $this
  613. */
  614. function setUseTransform(bool $useTransform = true) : self{
  615. $this->useTransform = $useTransform;
  616. return $this;
  617. }
  619. public function getAllowInQuizOrWorksheet(): ?bool
  620. {
  621. return $this->allowInQuizOrWorksheet;
  622. }
  624. public function setAllowInQuizOrWorksheet(?bool $allowInQuizOrWorksheet): void
  625. {
  626. $this->allowInQuizOrWorksheet = $allowInQuizOrWorksheet;
  627. }
  629. public function getViewMode(): int
  630. {
  631. return $this->viewMode;
  632. }
  634. public function getDifficulty() {
  635. return $this->template->getDifficulty();
  636. }
  638. public function getCorrectAnswerText() {
  639. return $this->getCorrectAnswer()?->getAnswerText();
  640. }
  642. /*
  643. * Used for EasyAdmin problem form
  644. *
  645. * */
  647. public function getTemplateId() {
  648. return $this->getTemplate()->getId();
  649. }
  651. public function getType() {
  652. return $this?->getTemplate()?->getType();
  653. }
  655. public function setType(int $type) {
  656. $this->getTemplate()->setType($type);
  657. }
  659. public function getQuizzes(): Collection
  660. {
  661. $quizzes = new ArrayCollection();
  663. foreach ($this->quizzes as $quiz) {
  664. $quizzes->add($quiz->getQuiz());
  665. }
  666. return $quizzes;
  667. }
  669. public function getQuizId(): ?int {
  670. $quizzes = $this->getQuizzes();
  671. return $quizzes[0]?->getId();
  672. }
  674. public function getPublicationName(): string {
  675. $quizzes = $this->getQuizzes();
  676. return $quizzes[0]?->getPublication()?->getName();
  677. }
  679. public function isValidated(): bool
  680. {
  681. return $this->validated ?? false;
  682. }
  684. public function setValidated(bool $validated): void
  685. {
  686. $this->validated = $validated;
  687. }
  689. public function getProblemText(): string {
  690. return '';
  691. }
  693. public function setProblemText(string $text) {
  694. }
  696. public function __toString(): string
  697. {
  698. return $this->name;
  699. }
  701. public function setViewMode(int $viewMode): void
  702. {
  703. $this->viewMode = $viewMode;
  704. }
  706. // generate a snippet of text containing the relevant information for the given problem
  707. public function getSnippet(): string
  708. {
  709. $output = '';
  710. if ($this->introText) {
  711. $output .= '<br><b>Intro text:</b> ' . strip_tags($this->introText);
  712. }
  713. if ($this->description) {
  714. $output .= '<br><b>Problem text:</b> ' . strip_tags($this->description);
  715. }
  717. if ($this->getType() === TemplateMathproblem::TYPE_DRAG_AND_DROP) {
  718. $containers = $this->getProblemDnd()->getBins();
  719. $containerList = $containers->map(function($container) {
  720. $tmp = '';
  721. // the correct answer might be text, audio and or image.
  722. if ($container->getTxt())
  723. {
  724. $tmp .= $container->getTxt();
  725. }
  726. $tmp .= $container->displayMediaIfPresent();
  727. return $tmp;
  728. });
  729. $output .= '<br><b>Containers:</b> ' . implode('|', $containerList->toArray() );
  730. }
  732. if ($this->getType() === TemplateMathproblem::TYPE_DRAG_AND_DROP || $this->getType() === TemplateMathproblem::TYPE_RADIO_BUTTON) {
  733. // show all answers for dnd problems and radio button
  734. $answers = $this->getAnswers();
  735. $answerList = $answers->map(function($answer) {
  736. $tmp = '';
  737. // the correct answer might be text, audio and or image.
  738. if ($answer->getAnswerText())
  739. {
  740. $tmp .= $answer->getAnswerText();
  741. }
  742. $tmp .= $answer->displayMediaIfPresent();
  743. return $tmp;
  744. });
  745. $output .= '<br><b>Answers:</b> ' . implode('|', $answerList->toArray() );
  746. }
  747. else {
  748. $output .= $this->getCorrectAnswer()?->getAnswerText() ?? '';
  749. }
  751. return preg_replace('/^<br>/', '', $output);
  752. }
  754. /**
  755. * @return ?ProblemDnd
  756. */
  757. public function getProblemDnd()
  758. {
  759. return $this->problemDnd;
  760. }
  762. public function getVideoReference(): ?VideoReference
  763. {
  764. return $this->videoReference;
  765. }
  767. public function setVideoReference(?VideoReference $videoReference): void
  768. {
  769. $this->videoReference = $videoReference;
  770. }
  772. public function isValidatedAndHasMediaFiles(): bool
  773. {
  774. if (!$this->isValidated()) {
  775. return false;
  776. }
  778. // detect if problem has media files
  779. if ($this->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  780. return false;
  781. }
  783. if ($this->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  784. return false;
  785. }
  787. // detect if answers have media files
  788. foreach ($this->getAnswers() as $answer) {
  790. if ($answer->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  791. return false;
  792. }
  794. if ($answer->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  795. return false;
  796. }
  797. }
  799. // detect if containers have media files if dnd
  800. if ($this->getType() === 4) {
  802. $bins = $this->getProblemDnd()->getBins();
  804. foreach ($bins as $bin) {
  805. if ($bin->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  806. return false;
  807. }
  809. if ($bin->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  810. return false;
  811. }
  812. }
  813. }
  815. return $this->isValidated();
  816. }
  818. public function getActiveBugReports(): array
  819. {
  820. $bugReports = $this->bugReports;
  822. $activeBugReports = [];
  823. foreach ($bugReports as $bugReport) {
  824. if ($bugReport->getDateResolved() === null) {
  825. $activeBugReports[] = $bugReport->getId();
  826. }
  827. }
  828. return $activeBugReports;
  829. }
  831. public function getCreatedAt(): \DateTime
  832. {
  833. return $this->createdAt;
  834. }
  836. public function setCreatedAt(\DateTime $createdAt): void
  837. {
  838. $this->createdAt = $createdAt;
  839. }
  841. public function getTopic(): ?string
  842. {
  843. return $this->getTemplate()?->getTopic()?->getName();
  844. }
  846. public function setTopic(Topic $topic)
  847. {
  848. $this->getTemplate()?->setTopic($topic);
  849. }
  851. public function getCategory(): ?string
  852. {
  853. return $this->getTemplate()?->getTopic()?->getCategory()?->getName();
  854. }
  856. public function getImage(){
  857. return $this->getImagePath();
  858. }
  860. public function getCmsImagePath(): string
  861. {
  862. if (!$this->imageReference) {
  863. return 'Mangler';
  864. }
  866. if (!$this->imageReference->getFilePath()) {
  867. return 'Mangler fil';
  868. }
  870. return $this->getImagePath();
  871. }
  873. public function getCmsAudioPath(): string
  874. {
  875. if (!$this->audioReference) {
  876. return 'Mangler';
  877. }
  879. if (!$this->audioReference->getFilePath()) {
  880. return 'Mangler fil';
  881. }
  883. return $this->getAudioPath();
  884. }
  886. }