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_obsolete", type="string", nullable=true)
  79. */
  80. private $mpImageObsolete;
  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. * @deprecated Use getImagePath() instead. Kept while the media migration is in progress.
  323. */
  324. public function getMpImageObsolete()
  325. {
  326. // @TODO delete
  327. return 'Obsolete, use getImagePath() instead';
  328. }
  330. /**
  331. * @return ?int
  332. */
  333. public function getStatus()
  334. {
  335. return $this->status;
  336. }
  338. /**
  339. * @param ?int $status
  340. */
  341. public function setStatus($status)
  342. {
  343. $this->status = $status;
  344. }
  346. /**
  347. * Status helper function
  348. */
  349. public function isPublished(): bool
  350. {
  351. // Treating null as published since status is nullable, and it would have been treated like this before, though it should not happen.
  352. return $this->status === self::STATUS_PUBLISHED || $this->status === null;
  353. }
  355. /**
  356. * Status helper function
  357. */
  358. public function setPublished(): void
  359. {
  360. $this->status = self::STATUS_PUBLISHED;
  361. }
  363. /**
  364. * Status helper function
  365. */
  366. public function isUnpublished(): bool
  367. {
  368. return $this->status === self::STATUS_UNPUBLISHED;
  369. }
  371. /**
  372. * Status helper function
  373. */
  374. public function setUnpublished(): void
  375. {
  376. $this->status = self::STATUS_UNPUBLISHED;
  377. }
  379. /**
  380. * Status helper function
  381. */
  382. public function isDeleted(): bool
  383. {
  384. return $this->status === self::STATUS_DELETED;
  385. }
  387. /**
  388. * Status helper function
  389. */
  390. public function setDeleted(): void
  391. {
  392. $this->status = self::STATUS_DELETED;
  393. }
  395. /**
  396. * @return int
  397. */
  398. public function getSubquestionNr()
  399. {
  400. return $this->subquestionNr;
  401. }
  403. /**
  404. * @param int $subquestionNr
  405. *
  406. * Specify if the math problem is part of a bigger question with several subquestions
  407. *
  408. */
  409. public function setSubquestionNr($subquestionNr)
  410. {
  411. $this->subquestionNr = $subquestionNr;
  412. }
  414. public function getGeogebra(): ?string
  415. {
  416. return $this->geogebra;
  417. }
  419. /**
  420. * @return string|null
  421. */
  422. public function getFreeText(): ?string
  423. {
  424. return $this->freeText;
  425. }
  427. /**
  428. * @param string|null $freeText
  429. */
  430. public function setFreeText(?string $freeText): void
  431. {
  432. $this->freeText = $freeText;
  433. }
  435. /**
  436. * @return string|null
  437. */
  438. public function getIntroText(): ?string
  439. {
  440. return $this->introText;
  441. }
  443. /**
  444. * @param string|null $introText
  445. */
  446. public function setIntroText(?string $introText): void
  447. {
  448. $this->introText = $introText;
  449. }
  451. public function getCorrectAnswer(): ?Answer
  452. {
  453. $correctAnswer = null;
  454. foreach ($this->answers as $answer) {
  455. if ($answer->getIsCorrect()) {
  456. $correctAnswer = $answer;
  457. break;
  458. }
  459. }
  461. return $correctAnswer;
  462. }
  464. public function getWrongAnswer(): ?Answer
  465. {
  466. $wrongAnswer = null;
  467. foreach ($this->answers as $answer) {
  468. if (!$answer->getIsCorrect()) {
  469. $wrongAnswer = $answer;
  470. break;
  471. }
  472. }
  474. return $wrongAnswer;
  475. }
  477. /**
  478. * @return array|null
  479. */
  480. public function getCorrectAnswers(): ?array
  481. {
  482. // TODO - Jon's part, try to optimize for reusing
  483. $answerString = $this->getCorrectAnswer()->getAnswerText();
  485. $type = $this->getTemplate()->getType();
  486. if ($type === TemplateMathproblem::TYPE_DROPDOWN) {
  487. // Get correct answers dynamically
  488. $stringArray = explode("#", $answerString);
  489. $correctAnswers = [];
  490. $index = 0;
  491. foreach ($stringArray as $str) {
  492. // if string contains '|', it contains dropdown options
  493. if (!(strpos($str, '|') === false)) {
  494. $dropdownChoices = explode("|", $str);
  495. $correctAnswers[$index] = $dropdownChoices[0];
  496. foreach ($dropdownChoices as $choice){
  497. if(preg_match("#^\*#", $choice) || preg_match("#\*$#", $choice)){
  498. $choice = preg_replace("#^\*#", "", $choice);
  499. $choice = preg_replace("#\*$#", "", $choice);
  500. $correctAnswers[$index] = $choice;
  501. }
  502. }
  503. $index++;
  504. }
  505. }
  507. return $correctAnswers;
  508. } elseif ($type === TemplateMathproblem::TYPE_WORD_OPTIONS) {
  509. $stringArray = explode("#", $answerString);
  510. $correctAnswers = [];
  511. for ($i = 1; $i < count($stringArray); $i += 2) {
  512. $str = $stringArray[$i];
  513. if (in_array($str, ['<br>', '<br/>'])) {
  514. continue;
  515. }
  516. if (strpos($str, '|') === false) {
  517. $correctAnswers[] = 'default';
  518. } else {
  519. $correctAnswers[] = explode('|', $str)[1];
  520. }
  521. }
  523. return $correctAnswers;
  524. } else {
  525. // TODO: perhaps make this possible for other template types too.
  526. return null;
  527. }
  528. }
  530. /**
  531. * @return bool
  532. */
  533. public function getHasNext(){
  534. return $this->hasNext;
  535. }
  537. public function setHasNext($hasNext){
  538. $this->hasNext = $hasNext;
  539. }
  541. public function getAppendices(): Collection
  542. {
  543. return $this->appendices;
  544. }
  546. public function setAppendices(ArrayCollection $appendices): void
  547. {
  548. $this->appendices = $appendices;
  549. }
  551. public function getVideo(): ?Video
  552. {
  553. return $this->video;
  554. }
  556. function jsonSerialize(): mixed
  557. {
  559. // Initialize the $video property if it's not already initialized.
  560. $this->video ??= null;
  562. $data = [
  563. "id" => $this->getId(),
  564. "name" => $this->getName(),
  565. "description" => $this->getDescription(),
  566. "introText" => $this->getIntroText(),
  567. "freeText" => $this->getFreeText(),
  568. "hint" => $this->getHint(),
  569. "correctAnswer" => $this->getCorrectAnswer(),
  570. "template" => $this->getTemplate(),
  571. "status" => $this->getStatus(),
  572. "subquestionNr" => $this->getSubquestionNr(),
  573. "georgeBra" => $this->getGeogebra(),
  574. "solution" => $this->getSolution(),
  575. "image" => $this->getImagePath(),
  576. "appendices" => $this->getAppendices()->toArray(),
  577. "hasNext" => $this->getHasNext(),
  578. "video" => $this->getVideo(),
  579. "wrongAnswer" => $this->getWrongAnswer(),
  580. "topicDisplayName" => $this->getTemplate()->getTopic()->getDisplayName(),
  581. "options" => $this->getCorrectAnswer() && $this->getCorrectAnswer()->getAnswerText() ? explode("#", $this->getCorrectAnswer()->getAnswerText()) : [],
  582. "viewMode" => $this->getViewMode(),
  583. ];
  585. for ($i=0, $count = count($this->excludeKeys); $i < $count; $i++){
  586. if(isset( $data[ $this->excludeKeys[$i] ] )){
  587. unset( $data[ $this->excludeKeys[$i] ] );
  588. }
  589. }
  591. $answers = $this->getAnswers()->toArray();
  593. if($this->getTemplate()->getShouldShuffle()){
  594. shuffle($answers);
  595. }
  596. $data['answers'] = $answers;
  598. return $data;
  600. }
  602. /**
  603. * @param array $keys
  604. * @return $this
  605. */
  606. function exclude(array $keys): self{
  607. $this->excludeKeys = $keys;
  608. return $this;
  609. }
  611. /**
  612. * @param bool $useTransform
  613. * @return $this
  614. */
  615. function setUseTransform(bool $useTransform = true) : self{
  616. $this->useTransform = $useTransform;
  617. return $this;
  618. }
  620. public function getAllowInQuizOrWorksheet(): ?bool
  621. {
  622. return $this->allowInQuizOrWorksheet;
  623. }
  625. public function setAllowInQuizOrWorksheet(?bool $allowInQuizOrWorksheet): void
  626. {
  627. $this->allowInQuizOrWorksheet = $allowInQuizOrWorksheet;
  628. }
  630. public function getViewMode(): int
  631. {
  632. return $this->viewMode;
  633. }
  635. public function getDifficulty() {
  636. return $this->template->getDifficulty();
  637. }
  639. public function getCorrectAnswerText() {
  640. return $this->getCorrectAnswer()?->getAnswerText();
  641. }
  643. /*
  644. * Used for EasyAdmin problem form
  645. *
  646. * */
  648. public function getTemplateId() {
  649. return $this->getTemplate()->getId();
  650. }
  652. public function getType() {
  653. return $this?->getTemplate()?->getType();
  654. }
  656. public function setType(int $type) {
  657. $this->getTemplate()->setType($type);
  658. }
  660. public function getQuizzes(): Collection
  661. {
  662. $quizzes = new ArrayCollection();
  664. foreach ($this->quizzes as $quiz) {
  665. $quizzes->add($quiz->getQuiz());
  666. }
  667. return $quizzes;
  668. }
  670. public function getQuizId(): ?int {
  671. $quizzes = $this->getQuizzes();
  672. return $quizzes[0]?->getId();
  673. }
  675. public function getPublicationName(): string {
  676. $quizzes = $this->getQuizzes();
  677. return $quizzes[0]?->getPublication()?->getName();
  678. }
  680. public function isValidated(): bool
  681. {
  682. return $this->validated ?? false;
  683. }
  685. public function setValidated(bool $validated): void
  686. {
  687. $this->validated = $validated;
  688. }
  690. public function getProblemText(): string {
  691. return '';
  692. }
  694. public function setProblemText(string $text) {
  695. }
  697. public function __toString(): string
  698. {
  699. return $this->name;
  700. }
  702. public function setViewMode(int $viewMode): void
  703. {
  704. $this->viewMode = $viewMode;
  705. }
  707. public function getSnippet(): string
  708. {
  709. // Placeholder for EasyAdmin, value will be overwritten, so it does not matter what is returned.
  710. return '';
  711. }
  713. /**
  714. * @return ?ProblemDnd
  715. */
  716. public function getProblemDnd()
  717. {
  718. return $this->problemDnd;
  719. }
  721. public function getVideoReference(): ?VideoReference
  722. {
  723. return $this->videoReference;
  724. }
  726. public function setVideoReference(?VideoReference $videoReference): void
  727. {
  728. $this->videoReference = $videoReference;
  729. }
  731. public function isValidatedAndHasMediaFiles(): bool
  732. {
  733. if (!$this->isValidated()) {
  734. return false;
  735. }
  737. // detect if problem has media files
  738. if ($this->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  739. return false;
  740. }
  742. if ($this->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  743. return false;
  744. }
  746. // detect if answers have media files
  747. foreach ($this->getAnswers() as $answer) {
  749. if ($answer->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  750. return false;
  751. }
  753. if ($answer->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  754. return false;
  755. }
  756. }
  758. // detect if containers have media files if dnd
  759. if ($this->getType() === 4) {
  761. $bins = $this->getProblemDnd()->getBins();
  763. foreach ($bins as $bin) {
  764. if ($bin->mediaCouplingExistButWithoutFile(ImageReference::class)) {
  765. return false;
  766. }
  768. if ($bin->mediaCouplingExistButWithoutFile(AudioReference::class)) {
  769. return false;
  770. }
  771. }
  772. }
  774. return $this->isValidated();
  775. }
  777. public function getActiveBugReports(): array
  778. {
  779. $bugReports = $this->bugReports;
  781. $activeBugReports = [];
  782. foreach ($bugReports as $bugReport) {
  783. if ($bugReport->getDateResolved() === null) {
  784. $activeBugReports[] = $bugReport->getId();
  785. }
  786. }
  787. return $activeBugReports;
  788. }
  790. public function getCreatedAt(): \DateTime
  791. {
  792. return $this->createdAt;
  793. }
  795. public function setCreatedAt(\DateTime $createdAt): void
  796. {
  797. $this->createdAt = $createdAt;
  798. }
  800. public function getTopic(): ?string
  801. {
  802. return $this->getTemplate()?->getTopic()?->getName();
  803. }
  805. public function setTopic(Topic $topic)
  806. {
  807. $this->getTemplate()?->setTopic($topic);
  808. }
  810. public function getCategory(): ?string
  811. {
  812. return $this->getTemplate()?->getTopic()?->getCategory()?->getName();
  813. }
  815. public function getImage(){
  816. return $this->getImagePath();
  817. }
  819. public function getCmsImagePath(): string
  820. {
  821. if (!$this->imageReference) {
  822. return 'Mangler';
  823. }
  825. if (!$this->imageReference->getFilePath()) {
  826. return 'Mangler fil';
  827. }
  829. return $this->getImagePath();
  830. }
  832. public function getCmsAudioPath(): string
  833. {
  834. if (!$this->audioReference) {
  835. return 'Mangler';
  836. }
  838. if (!$this->audioReference->getFilePath()) {
  839. return 'Mangler fil';
  840. }
  842. return $this->getAudioPath();
  843. }
  845. }