src/CoreBundle/Entity/TemplateMathproblem.php line 22

Open in your IDE?
  1. <?php
  3. namespace CoreBundle\Entity;
  5. use AdminBundle\Controller\EasyAdmin\ProblemType;
  6. use Doctrine\Common\Collections\ArrayCollection;
  7. use Doctrine\Common\Collections\Collection;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use UserBundle\Entity\User;
  10. use JsonSerializable;
  11. use DateTime;
  13. /**
  14. * @ORM\Entity
  15. * @ORM\Table("template_mathproblem",indexes={
  16. * @ORM\Index(name="difficulty_idx", columns={"difficulty"}),
  17. * @ORM\Index(name="type_idx", columns={"type"})
  18. * })
  19. * @ORM\Entity(repositoryClass="TemplateMathproblemRepository")
  20. *
  21. */
  22. class TemplateMathproblem implements JsonSerializable
  23. {
  24. // types used in database
  25. public const TYPE_RADIO_BUTTON = 0;
  26. public const TYPE_NUMBER = 1;
  27. public const TYPE_DRAG_AND_DROP = 4;
  28. public const TYPE_FORMULA = 5;
  29. public const TYPE_DROPDOWN = 6;
  30. public const TYPE_WORD_OPTIONS = 7;
  31. public const TYPE_TEXT = 8;
  32. public const TYPE_PARAGRAPH = 9;
  33. public const TYPE_MARK = 10;
  34. public const TEMPLATE_MATH_PROBLEM_TABLE = 11;
  35. public const TEMPLATE_MATH_PROBLEM_GRID = 12;
  37. public const TEMPLATE_MATH_PROBLEM_TYPES = [
  38. self::TYPE_RADIO_BUTTON,
  39. self::TYPE_NUMBER,
  40. self::TYPE_DRAG_AND_DROP,
  41. self::TYPE_FORMULA,
  42. self::TYPE_DROPDOWN,
  43. self::TYPE_WORD_OPTIONS,
  44. self::TYPE_TEXT,
  45. self::TYPE_PARAGRAPH,
  46. self::TYPE_MARK
  47. ];
  49. /**
  50. * @var int
  51. *
  52. * @ORM\Column(name="id", type="integer")
  53. * @ORM\Id
  54. * @ORM\GeneratedValue(strategy="AUTO")
  55. */
  56. private $id;
  58. /**
  59. * @var User
  60. *
  61. * @ORM\ManyToOne(targetEntity="UserBundle\Entity\User")
  62. */
  63. private $creator;
  65. /**
  66. * @ORM\Column(name="is_help_allowed", type="boolean")
  67. */
  68. private bool $helpAllowed;
  70. /**
  71. * @var int
  72. *
  73. * @ORM\Column(name="difficulty", type="smallint")
  74. */
  75. private $difficulty;
  77. /**
  78. * Specifies the type of problem:<br>
  79. * 0 = single choice, multiple available answers<br>
  80. * 1 = single choice, text answer<br>
  81. * 4 = Drag and Drop
  82. *
  83. * @var int
  84. *
  85. * @ORM\Column(name="type", type="smallint")
  86. */
  87. private $type;
  89. /**
  90. * @var bool $isUnique
  91. *
  92. * @ORM\Column(name="is_unique", type="boolean", unique=false)
  93. */
  94. private $unique;
  96. /**
  97. * @ORM\Column(name="has_priority", type="boolean", unique=false)
  98. */
  99. private bool $priority;
  101. /**
  102. * @var bool
  103. *
  104. * @ORM\Column(name="is_valid", type="boolean", unique=false, options={"default" : true})
  105. */
  106. private $valid;
  108. /**
  109. * The mathproblems that are created using this template
  110. *
  111. * @var Collection|ArrayCollection|Mathproblem[]
  112. *
  113. * @ORM\OneToMany(targetEntity="Mathproblem", mappedBy="template", cascade={"persist", "remove"})
  114. */
  115. private Collection $mathproblems;
  117. /**
  118. * @var Topic
  119. *
  120. * @ORM\ManyToOne(targetEntity="Topic", inversedBy="templates")
  121. * @ORM\JoinColumn(name="topic_id", referencedColumnName="id")
  122. */
  123. private $topic;
  125. /**
  126. * Target can be all - 0, session - 1, homework - 2, single session - 3, screening - 4
  127. *
  128. * @var string
  129. * @ORM\Column(name="target", type="smallint", nullable=false)
  130. */
  131. private $target;
  133. /**
  134. * @var ArrayCollection|TagMathproblem[]
  135. *
  136. * @ORM\ManyToMany(targetEntity="TagMathproblem", inversedBy="templates")
  137. * @ORM\JoinTable(name="relation_template_tag",
  138. * joinColumns={@ORM\JoinColumn(name="mpt_tag_id", referencedColumnName="id")})
  139. * inverseJoinColumns={@ORM\JoinColumn(name="mpt_problem_id", referencedColumnName="id")},
  140. */
  141. private $tags;
  143. /**
  144. * @var string
  145. * @ORM\Column(name="mptopic", type="string", nullable=true)
  146. */
  147. private $mptopic;
  149. /**
  150. * Mathproblem solving time in minutes
  151. *
  152. * @var int
  153. * @ORM\Column(name="duration", type="smallint")
  154. */
  155. private $duration;
  157. /**
  158. * @var ArrayCollection|TemplateSet[]
  159. * @ORM\ManyToMany(targetEntity="TemplateSet", mappedBy="templates")
  160. *
  161. */
  162. private $templateSets;
  164. /**
  165. * @var bool $useForWorksheet
  166. *
  167. * @ORM\Column(name="use_for_worksheet", type="boolean", options={"default" : true})
  168. */
  169. private $useForWorksheet = true;
  171. /**
  172. * @var bool $useCompactVersion
  173. *
  174. * @ORM\Column(name="use_compact_version", type="boolean", options={"default" : false})
  175. */
  176. private $useCompactVersion = false;
  178. /**
  179. * @var bool $shouldShuffle
  180. *
  181. * @ORM\Column(name="should_shuffle", type="boolean", options={"default" : true})
  182. */
  183. private $shouldShuffle = true;
  185. /**
  186. * @var bool $ignoreCase
  187. *
  188. * @ORM\Column(name="ignore_case", type="boolean", options={"default" : false})
  189. */
  190. private $ignoreCase = false;
  192. /**
  193. * Flag used to count number of valid template mathproblems
  194. * @var bool
  195. */
  196. private $mathproblemsCount;
  198. /**
  199. * @var bool $answerPositionVertical
  200. *
  201. * @ORM\Column(name="answer_position_vertical", type="boolean", options={"default" : false})
  202. */
  203. private $answerPositionVertical;
  205. /**
  206. * For the moment type is 4 for both match, block and sort problems. This field is used to differentiate.
  207. * @var ?string $dragAndDropType
  208. * @ORM\Column(name="dnd_type", type="string", nullable=true)
  209. */
  210. private ?string $dndType;
  212. /**
  213. * @var ?DateTime
  214. *
  215. * @ORM\Column(name="deleted_at", type="datetime", nullable=true)
  216. */
  217. private ?DateTime $deletedAt;
  220. /**
  221. * TemplateMathproblem constructor.
  222. */
  223. public function __construct()
  224. {
  225. $this->mathproblems = new ArrayCollection();
  226. $this->tags = new ArrayCollection();
  227. $this->templateSets = new ArrayCollection();
  228. }
  230. /**
  231. * Get id.
  232. *
  233. * @return int
  234. */
  235. public function getId()
  236. {
  237. return $this->id;
  238. }
  240. /**
  241. * @param Mathproblem[] $mathproblems
  242. *
  243. * @return TemplateMathproblem
  244. */
  245. public function setAnswer($mathproblems)
  246. {
  247. $this->mathproblems = $mathproblems;
  249. return $this;
  250. }
  252. /**
  253. * @return Collection|ArrayCollection|Mathproblem[]
  254. */
  255. public function getMathproblems(): Collection
  256. {
  257. return $this->mathproblems;
  258. }
  261. /**
  262. * @param Mathproblem $mathproblem
  263. *
  264. * @return TemplateMathproblem
  265. */
  266. public function addMathproblem(Mathproblem $mathproblem)
  267. {
  268. $this->mathproblems->add($mathproblem);
  270. return $this;
  271. }
  273. /**
  274. * @param Mathproblem $mathproblem
  275. *
  276. * @return bool
  277. */
  278. public function removeMathproblem(Mathproblem $mathproblem)
  279. {
  280. return $this->mathproblems->removeElement($mathproblem);
  281. }
  283. /**
  284. * @return Topic
  285. */
  286. public function getTopic()
  287. {
  288. return $this->topic;
  289. }
  291. /**
  292. * @param Topic $topic
  293. */
  294. public function setTopic($topic)
  295. {
  296. $this->topic = $topic;
  297. }
  299. /**
  300. * @return int
  301. */
  302. public function getDifficulty()
  303. {
  304. return $this->difficulty;
  305. }
  307. public function setDifficulty(int $difficulty)
  308. {
  309. $this->difficulty = $difficulty;
  310. }
  312. /**
  313. * @return int
  314. */
  315. public function getType()
  316. {
  317. return $this->type;
  318. }
  320. public function setType(int $type)
  321. {
  322. $this->type = $type;
  323. }
  325. /**
  326. * @return Collection|ArrayCollection|TagMathproblem[]
  327. */
  328. public function getTags(): Collection
  329. {
  330. return $this->tags;
  331. }
  333. public function addTag(TagMathproblem $tag)
  334. {
  335. return $this->tags->add($tag);
  336. }
  338. public function getValidTagArray(): array {
  339. $tagList = [];
  340. foreach ($this->tags as $tag) {
  341. if ($tag->isEnabled()) {
  342. $tagList[] = $tag->getName();
  343. }
  344. }
  345. return $tagList;
  346. }
  348. public function getTagList(): string {
  349. $tagArray = $this->getValidTagArray();
  351. if (empty($tagArray)) {
  352. return '-';
  353. }
  355. return implode(', ', $tagArray);
  356. }
  358. /**
  359. * @return ?string
  360. */
  361. public function getMpTopic()
  362. {
  363. return $this->mptopic;
  364. }
  366. public function setMpTopic(?string $mpTopic): void
  367. {
  368. $this->mptopic = $mpTopic;
  369. }
  371. public function isHelpAllowed(): bool
  372. {
  373. return $this->helpAllowed;
  374. }
  376. public function setHelpAllowed(bool $isAllowed)
  377. {
  378. $this->helpAllowed = $isAllowed;
  379. }
  381. /**
  382. * @return mixed
  383. */
  384. public function getTarget()
  385. {
  386. return $this->target;
  387. }
  389. /**
  390. * @param mixed $target
  391. */
  392. public function setTarget($target)
  393. {
  394. $this->target = $target;
  395. }
  397. /**
  398. * @return boolean
  399. */
  400. public function isUnique()
  401. {
  402. return $this->unique;
  403. }
  405. public function setUnique(bool $isUnique)
  406. {
  407. $this->unique = $isUnique;
  408. }
  410. /**
  411. * @return boolean
  412. */
  413. public function isValid()
  414. {
  415. return $this->valid;
  416. }
  418. /**
  419. * @param boolean $valid
  420. */
  421. public function setValid($valid)
  422. {
  423. $this->valid = $valid;
  424. }
  426. /**
  427. * @return int
  428. */
  429. public function getDuration()
  430. {
  431. return $this->duration;
  432. }
  434. /**
  435. * @param int $duration
  436. *
  437. * @return $this
  438. */
  439. public function setDuration($duration)
  440. {
  441. $this->duration = $duration;
  443. return $this;
  444. }
  446. public function getCreator(): ?User
  447. {
  448. return $this->creator;
  449. }
  451. public function setCreator(?User $creator)
  452. {
  453. $this->creator = $creator;
  454. }
  456. public function isPriority(): bool
  457. {
  458. return $this->priority;
  459. }
  461. /**
  462. * @param bool $priority
  463. */
  464. public function setPriority(bool $priority): void
  465. {
  466. $this->priority = $priority;
  467. }
  469. /**
  470. * @return TemplateSet[]|ArrayCollection
  471. */
  472. public function getTemplateSets()
  473. {
  474. return $this->templateSets;
  475. }
  477. public function addTemplateSet(TemplateSet $templateSet): void
  478. {
  479. if (!$this->templateSets->contains($templateSet)) {
  480. $this->templateSets->add($templateSet);
  481. $templateSet->addTemplate($this);
  482. }
  483. }
  485. /**
  486. * @param TemplateSet[]|ArrayCollection $templateSets
  487. */
  488. public function setTemplateSets($templateSets): void
  489. {
  490. $this->templateSets = $templateSets;
  491. }
  493. /**
  494. * @return bool
  495. */
  496. public function isUseForWorksheet(): bool
  497. {
  498. return $this->useForWorksheet;
  499. }
  501. /**
  502. * @param bool $useForWorksheet
  503. */
  504. public function setUseForWorksheet(bool $useForWorksheet): void
  505. {
  506. $this->useForWorksheet = $useForWorksheet;
  507. }
  509. /**
  510. * @return bool
  511. */
  512. public function getUseCompactVersion(): bool
  513. {
  514. return $this->useCompactVersion;
  515. }
  517. /**
  518. * @param bool $useCompactVersion
  519. */
  520. public function setUseCompactVersion(bool $useCompactVersion): void
  521. {
  522. $this->useCompactVersion = $useCompactVersion;
  523. }
  525. /**
  526. * @return bool
  527. */
  528. public function getShouldShuffle(): bool
  529. {
  530. return $this->shouldShuffle;
  531. }
  533. /**
  534. * @param bool $shouldShuffle
  535. */
  536. public function setShouldShuffle(bool $shouldShuffle): void
  537. {
  538. $this->shouldShuffle = $shouldShuffle;
  539. }
  541. /**
  542. * @return bool
  543. */
  544. public function getIgnoreCase(): bool
  545. {
  546. return $this->ignoreCase;
  547. }
  549. /**
  550. * @param bool $ignoreCase
  551. */
  552. public function setIgnoreCase(bool $ignoreCase): void
  553. {
  554. $this->ignoreCase = $ignoreCase;
  555. }
  557. /**
  558. *
  559. */
  560. public function setMathproblemsCount()
  561. {
  562. $count = 0;
  563. /** @var Mathproblem $mathproblem */
  564. foreach ($this->mathproblems as $mathproblem) {
  565. if ($mathproblem->isPublished()) {
  566. $count++;
  567. }
  568. }
  570. $this->mathproblemsCount = $count;
  571. }
  573. public function areAllProblemsPublished(): bool
  574. {
  575. foreach ($this->mathproblems as $mathproblem) {
  576. if (!$mathproblem->isPublished() && !$mathproblem->isDeleted()) {
  577. return false;
  578. }
  579. }
  580. return true;
  581. }
  583. /**
  584. * @return bool
  585. */
  586. public function getMathproblemsCount()
  587. {
  588. return $this->mathproblemsCount;
  589. }
  591. public function isAnswerPositionVertical(): bool
  592. {
  593. return $this->answerPositionVertical;
  594. }
  596. public function setAnswerPositionVertical(bool $answerPositionVertical): void
  597. {
  598. $this->answerPositionVertical = $answerPositionVertical;
  599. }
  601. public function __toString(): string
  602. {
  603. return $this->id;
  604. }
  606. public function getDndType(): ?string
  607. {
  608. return $this->dndType ?? null;
  609. }
  611. public function setDndType(?string $dndType): void
  612. {
  613. $this->dndType = $dndType;
  614. }
  616. public function getProblemTypeAsString(): string {
  617. return ProblemType::getProblemTypeFromTemplate($this)->name();
  618. }
  620. public function getProblemType(): ProblemType
  621. {
  622. return ProblemType::getProblemTypeFromTemplate($this);
  623. }
  625. public function getDeletedAt(): ?DateTime
  626. {
  627. return $this->deletedAt;
  628. }
  630. public function setDeletedAt(?DateTime $deletedAt): void
  631. {
  632. $this->deletedAt = $deletedAt;
  633. }
  636. function jsonSerialize(): mixed
  637. {
  638. return [
  639. "id" => $this->getId(),
  640. "type" => $this->getType(),
  641. "topic" => $this->getTopic(),
  642. "mpTopic" => $this->getMpTopic(),
  643. "difficulty" => $this->getDifficulty(),
  644. "helpAllowed" => $this->isHelpAllowed(),
  645. "tags" => $this->getTags()->toArray(),
  646. "duration" => $this->getDuration(),
  647. "shouldShuffle" => $this->getShouldShuffle(),
  648. "useCompactVersion" => $this->getUseCompactVersion(),
  649. "answerPositionVertical" => $this->isAnswerPositionVertical(),
  650. "templateSets" => $this->getTemplateSets()->toArray(),
  651. "mathproblemCount" => $this->getMathproblemsCount(),
  652. "creator" => $this->getCreator(),
  653. "ignoreCase" => $this->getIgnoreCase(),
  654. "target" => $this->getTarget(),
  656. ];
  657. }
  658. }