src/Entity/Core/TemplateMathproblem.php line 22

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity\Core;
  7. use App\Controller\Admin\EasyAdmin\ProblemType;
  8. use App\Entity\Core\Classroom\ClassroomType;
  9. use App\Entity\Core\Topic\Topic;
  10. use App\Entity\User\User;
  11. use DateTime;
  12. use Doctrine\Common\Collections\ArrayCollection;
  13. use Doctrine\Common\Collections\Collection;
  14. use Doctrine\ORM\Mapping as ORM;
  15. use Doctrine\ORM\PersistentCollection;
  16. use JsonSerializable;
  18. #[ORM\Table('template_mathproblem')]
  19. #[ORM\Index(name: 'difficulty_idx', columns: ['difficulty'])]
  20. #[ORM\Index(name: 'type_idx', columns: ['type'])]
  21. #[ORM\Entity(repositoryClass: TemplateMathproblemRepository::class)]
  22. class TemplateMathproblem implements JsonSerializable
  23. {
  24. // types used in database
  25. public const int TYPE_RADIO_BUTTON = 0;
  26. public const int TYPE_NUMBER = 1;
  27. public const int TYPE_DRAG_AND_DROP = 4;
  28. public const int TYPE_FORMULA = 5;
  29. public const int TYPE_DROPDOWN = 6;
  30. public const int TYPE_WORD_OPTIONS = 7;
  31. public const int TYPE_TEXT = 8;
  32. public const int TYPE_PARAGRAPH = 9;
  33. public const int TYPE_MARK = 10;
  34. public const int TEMPLATE_MATH_PROBLEM_TABLE = 11;
  35. public const int TEMPLATE_MATH_PROBLEM_GRID = 12;
  37. public const array 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. #[ORM\Column(name: 'id', type: 'integer')]
  50. #[ORM\Id]
  51. #[ORM\GeneratedValue(strategy: 'AUTO')]
  52. private ?int $id = null; // RSM: This seems to work for both Doctrine and EasyAdmin, might have to remove the typehint if more issues pop up though.
  54. #[ORM\ManyToOne(targetEntity: User::class)]
  55. private ?User $creator = null;
  57. #[ORM\Column(name: 'is_help_allowed', type: 'boolean')]
  58. private bool $helpAllowed;
  60. #[ORM\Column(name: 'difficulty', type: 'smallint')]
  61. private int $difficulty;
  63. /**
  64. * Specifies the type of problem:<br>
  65. * 0 = single choice, multiple available answers<br>
  66. * 1 = single choice, text answer<br>
  67. * 4 = Drag and Drop
  68. */
  69. #[ORM\Column(name: 'type', type: 'smallint')]
  70. private int $type;
  72. #[ORM\Column(name: 'is_unique', type: 'boolean', unique: false)]
  73. private bool $unique;
  75. #[ORM\Column(name: 'has_priority', type: 'boolean', unique: false)]
  76. private bool $priority;
  78. #[ORM\Column(name: 'is_valid', type: 'boolean', unique: false, options: ['default' => true])]
  79. private bool $valid;
  81. /**
  82. * The mathproblems that are created using this template
  83. *
  84. * @var Collection|ArrayCollection|Mathproblem[]
  85. */
  86. #[ORM\OneToMany(targetEntity: Mathproblem::class, mappedBy: 'template', cascade: ['persist', 'remove'])]
  87. private Collection|array $mathproblems;
  89. #[ORM\JoinColumn(name: 'topic_id', referencedColumnName: 'id')]
  90. #[ORM\ManyToOne(targetEntity: Topic::class, inversedBy: 'templates')]
  91. private ?Topic $topic = null;
  93. /**
  94. * Target can be all - 0, session - 1, homework - 2, single session - 3, screening - 4
  95. */
  96. #[ORM\Column(name: 'target', type: 'smallint', nullable: false)]
  97. private int $target;
  99. /**
  100. * @var ArrayCollection|TagMathproblem[]
  101. */
  102. #[ORM\JoinTable(name: 'relation_template_tag')]
  103. #[ORM\JoinColumn(name: 'mpt_tag_id', referencedColumnName: 'id')]
  104. #[ORM\ManyToMany(targetEntity: TagMathproblem::class, inversedBy: 'templates')]
  105. private array|Collection $tags;
  107. #[ORM\Column(name: 'mptopic', type: 'string', nullable: true)]
  108. private ?string $mptopic = null;
  110. /**
  111. * Mathproblem solving time in minutes
  112. */
  113. #[ORM\Column(name: 'duration', type: 'smallint')]
  114. private int $duration;
  116. /**
  117. * @var ArrayCollection|TemplateSet[]
  118. *
  119. */
  120. #[ORM\ManyToMany(targetEntity: TemplateSet::class, mappedBy: 'templates')]
  121. private array|Collection|PersistentCollection $templateSets;
  123. /**
  124. * @var Collection|ArrayCollection|ClassroomType[]
  125. */
  126. #[ORM\ManyToMany(targetEntity: ClassroomType::class)]
  127. #[ORM\JoinTable(name: 'template_excluded_classroomtypes')]
  128. #[ORM\JoinColumn(name: 'template_id', referencedColumnName: 'id')]
  129. #[ORM\InverseJoinColumn(name: 'classroomtype_id', referencedColumnName: 'id')]
  130. private Collection $excludedClassroomTypes;
  132. #[ORM\Column(name: 'use_for_worksheet', type: 'boolean', options: ['default' => true])]
  133. private bool $useForWorksheet = true;
  135. #[ORM\Column(name: 'use_compact_version', type: 'boolean', options: ['default' => false])]
  136. private bool $useCompactVersion = false;
  138. #[ORM\Column(name: 'should_shuffle', type: 'boolean', options: ['default' => true])]
  139. private bool $shouldShuffle = true;
  141. #[ORM\Column(name: 'ignore_case', type: 'boolean', options: ['default' => false])]
  142. private bool $ignoreCase = false;
  144. /**
  145. * Flag used to count number of valid template mathproblems
  146. */
  147. private int $mathproblemsCount = 0;
  149. #[ORM\Column(name: 'answer_position_vertical', type: 'boolean', options: ['default' => false])]
  150. private bool $answerPositionVertical;
  152. /**
  153. * For the moment type is 4 for both match, block and sort problems. This field is used to differentiate.
  154. */
  155. #[ORM\Column(name: 'dnd_type', type: 'string', nullable: true)]
  156. private ?string $dndType;
  158. #[ORM\Column(name: 'deleted_at', type: 'datetime', nullable: true)]
  159. private ?DateTime $deletedAt;
  161. /**
  162. * TemplateMathproblem constructor.
  163. */
  164. public function __construct()
  165. {
  166. $this->mathproblems = new ArrayCollection();
  167. $this->tags = new ArrayCollection();
  168. $this->templateSets = new ArrayCollection();
  169. $this->excludedClassroomTypes = new ArrayCollection();
  170. }
  172. public function getId(): ?int
  173. {
  174. return $this->id;
  175. }
  177. /**
  178. * @return Collection|ArrayCollection|Mathproblem[]
  179. */
  180. public function getMathproblems(): Collection
  181. {
  182. return $this->mathproblems;
  183. }
  185. public function addMathproblem(Mathproblem $mathproblem): TemplateMathproblem
  186. {
  187. $this->mathproblems->add($mathproblem);
  189. return $this;
  190. }
  192. public function removeMathproblem(Mathproblem $mathproblem): bool
  193. {
  194. return $this->mathproblems->removeElement($mathproblem);
  195. }
  197. public function getTopic(): ?Topic
  198. {
  199. return $this->topic;
  200. }
  202. public function setTopic(?Topic $topic): void
  203. {
  204. $this->topic = $topic;
  205. }
  207. public function getDifficulty(): int
  208. {
  209. return $this->difficulty;
  210. }
  212. public function setDifficulty(int $difficulty) : void
  213. {
  214. $this->difficulty = $difficulty;
  215. }
  217. public function getType(): int
  218. {
  219. return $this->type;
  220. }
  222. public function setType(int $type): void
  223. {
  224. $this->type = $type;
  225. }
  227. public function getTags(): Collection
  228. {
  229. return $this->tags;
  230. }
  232. public function addTag(TagMathproblem $tag): void
  233. {
  234. $this->tags->add($tag);
  235. }
  237. /**
  238. * @return Collection|ArrayCollection|ClassroomType[]
  239. */
  240. public function getExcludedClassroomTypes(): Collection
  241. {
  242. return $this->excludedClassroomTypes;
  243. }
  245. public function addExcludedClassroomType(ClassroomType $classroomType): self
  246. {
  247. if (!$this->excludedClassroomTypes->contains($classroomType)) {
  248. $this->excludedClassroomTypes->add($classroomType);
  249. }
  251. return $this;
  252. }
  254. public function removeExcludedClassroomType(ClassroomType $classroomType): bool
  255. {
  256. return $this->excludedClassroomTypes->removeElement($classroomType);
  257. }
  259. public function getValidTagArray(): array {
  260. $tagList = [];
  261. foreach ($this->tags as $tag) {
  262. if ($tag->isEnabled()) {
  263. $tagList[] = $tag->getName();
  264. }
  265. }
  266. return $tagList;
  267. }
  269. public function getTagList(): string {
  270. $tagArray = $this->getValidTagArray();
  272. if (empty($tagArray)) {
  273. return '-';
  274. }
  276. return implode(', ', $tagArray);
  277. }
  279. public function getMpTopic(): ?string
  280. {
  281. return $this->mptopic;
  282. }
  284. public function setMpTopic(?string $mpTopic): void
  285. {
  286. $this->mptopic = $mpTopic;
  287. }
  289. public function isHelpAllowed(): bool
  290. {
  291. return $this->helpAllowed;
  292. }
  294. public function setHelpAllowed(bool $isAllowed): void
  295. {
  296. $this->helpAllowed = $isAllowed;
  297. }
  299. public function getTarget(): int
  300. {
  301. return $this->target;
  302. }
  304. public function setTarget(int $target): void
  305. {
  306. $this->target = $target;
  307. }
  309. public function isUnique(): bool
  310. {
  311. return $this->unique;
  312. }
  314. public function setUnique(bool $isUnique): void
  315. {
  316. $this->unique = $isUnique;
  317. }
  319. public function isValid(): bool
  320. {
  321. return $this->valid;
  322. }
  324. public function setValid(bool $valid): void
  325. {
  326. $this->valid = $valid;
  327. }
  329. public function getDuration(): int
  330. {
  331. return $this->duration;
  332. }
  334. public function setDuration(int $duration): TemplateMathproblem
  335. {
  336. $this->duration = $duration;
  338. return $this;
  339. }
  341. public function getCreator(): ?User
  342. {
  343. return $this->creator;
  344. }
  346. public function setCreator(?User $creator): void
  347. {
  348. $this->creator = $creator;
  349. }
  351. public function isPriority(): bool
  352. {
  353. return $this->priority;
  354. }
  356. public function setPriority(bool $priority): void
  357. {
  358. $this->priority = $priority;
  359. }
  361. public function getTemplateSets(): array|ArrayCollection|PersistentCollection
  362. {
  363. return $this->templateSets;
  364. }
  366. public function addTemplateSet(TemplateSet $templateSet): void
  367. {
  368. if (!$this->templateSets->contains($templateSet)) {
  369. $this->templateSets->add($templateSet);
  370. $templateSet->addTemplate($this);
  371. }
  372. }
  374. /**
  375. * @param TemplateSet[]|ArrayCollection $templateSets
  376. */
  377. public function setTemplateSets(array $templateSets): void
  378. {
  379. $this->templateSets = $templateSets;
  380. }
  382. public function isUseForWorksheet(): bool
  383. {
  384. return $this->useForWorksheet;
  385. }
  387. public function setUseForWorksheet(bool $useForWorksheet): void
  388. {
  389. $this->useForWorksheet = $useForWorksheet;
  390. }
  392. public function getUseCompactVersion(): bool
  393. {
  394. return $this->useCompactVersion;
  395. }
  397. public function setUseCompactVersion(bool $useCompactVersion): void
  398. {
  399. $this->useCompactVersion = $useCompactVersion;
  400. }
  402. public function getShouldShuffle(): bool
  403. {
  404. return $this->shouldShuffle;
  405. }
  407. public function setShouldShuffle(bool $shouldShuffle): void
  408. {
  409. $this->shouldShuffle = $shouldShuffle;
  410. }
  412. public function getIgnoreCase(): bool
  413. {
  414. return $this->ignoreCase;
  415. }
  417. public function setIgnoreCase(bool $ignoreCase): void
  418. {
  419. $this->ignoreCase = $ignoreCase;
  420. }
  422. /**
  423. *
  424. */
  425. public function setMathproblemsCount()
  426. {
  427. $count = 0;
  428. /** @var Mathproblem $mathproblem */
  429. foreach ($this->mathproblems as $mathproblem) {
  430. if ($mathproblem->isPublished()) {
  431. $count++;
  432. }
  433. }
  435. $this->mathproblemsCount = $count;
  436. }
  438. public function areAllProblemsPublished(): bool
  439. {
  440. foreach ($this->mathproblems as $mathproblem) {
  441. if (!$mathproblem->isPublished() && !$mathproblem->isDeleted()) {
  442. return false;
  443. }
  444. }
  445. return true;
  446. }
  448. public function getMathproblemsCount(): int
  449. {
  450. return $this->mathproblemsCount;
  451. }
  453. public function isAnswerPositionVertical(): bool
  454. {
  455. return $this->answerPositionVertical;
  456. }
  458. public function setAnswerPositionVertical(bool $answerPositionVertical): void
  459. {
  460. $this->answerPositionVertical = $answerPositionVertical;
  461. }
  463. public function __toString(): string
  464. {
  465. return (string)$this->id;
  466. }
  468. public function getDndType(): ?string
  469. {
  470. return $this->dndType ?? null;
  471. }
  473. public function setDndType(?string $dndType): void
  474. {
  475. $this->dndType = $dndType;
  476. }
  478. public function getProblemTypeAsString(): string {
  479. return ProblemType::getProblemTypeFromTemplate($this)->name();
  480. }
  482. public function getProblemType(): ProblemType
  483. {
  484. return ProblemType::getProblemTypeFromTemplate($this);
  485. }
  487. public function getDeletedAt(): ?DateTime
  488. {
  489. return $this->deletedAt;
  490. }
  492. public function setDeletedAt(?DateTime $deletedAt): void
  493. {
  494. $this->deletedAt = $deletedAt;
  495. }
  498. function jsonSerialize(): mixed
  499. {
  500. return [
  501. "id" => $this->getId(),
  502. "type" => $this->getType(),
  503. "topic" => $this->getTopic(),
  504. "mpTopic" => $this->getMpTopic(),
  505. "difficulty" => $this->getDifficulty(),
  506. "helpAllowed" => $this->isHelpAllowed(),
  507. "tags" => $this->getTags()->toArray(),
  508. "duration" => $this->getDuration(),
  509. "shouldShuffle" => $this->getShouldShuffle(),
  510. "useCompactVersion" => $this->getUseCompactVersion(),
  511. "answerPositionVertical" => $this->isAnswerPositionVertical(),
  512. "templateSets" => $this->getTemplateSets()->toArray(),
  513. "mathproblemCount" => $this->getMathproblemsCount(),
  514. "creator" => $this->getCreator(),
  515. "ignoreCase" => $this->getIgnoreCase(),
  516. "target" => $this->getTarget(),
  518. ];
  519. }
  520. }