src/CoreBundle/Entity/Topic.php line 20

Open in your IDE?
  1. <?php
  3. namespace CoreBundle\Entity;
  5. use Doctrine\Common\Collections\ArrayCollection;
  6. use Doctrine\Common\Collections\Collection;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use JsonSerializable;
  9. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity as UniqueEntity;
  10. use DateTime;
  12. use Symfony\Component\Yaml\Yaml;
  14. /**
  15. * @ORM\Table("topic")
  16. * @UniqueEntity("name")
  17. * @ORM\Entity(repositoryClass="CoreBundle\Entity\TopicRepository")
  18. *
  19. */
  20. class Topic implements JsonSerializable
  21. {
  22. /**
  23. * @var int
  24. *
  25. * @ORM\Column(name="id", type="integer")
  26. * @ORM\Id
  27. * @ORM\GeneratedValue(strategy="AUTO")
  28. */
  29. private $id;
  31. /**
  32. * @ORM\Column(type="string", length=255, unique=true)
  33. */
  34. private string $name;
  36. /**
  37. * @ORM\Column(type="string", length=255, nullable=true)
  38. */
  39. private ?string $displayName = null;
  41. /**
  42. * @ORM\Column(name="selfstudy_name", type="string", length=255, nullable=true)
  43. */
  44. private ?string $selfstudyName;
  47. /**
  48. * @var Category
  49. *
  50. * @ORM\ManyToOne(targetEntity="Category", inversedBy="topics")
  51. * @ORM\JoinColumn(name="category_id", referencedColumnName="id")
  52. */
  53. private $category;
  55. /**
  56. * @var ArrayCollection|TemplateMathproblem[]
  57. *
  58. * @ORM\OneToMany(targetEntity="TemplateMathproblem", mappedBy="topic", cascade={"persist"})
  59. */
  60. private $templates;
  62. /**
  63. * @var ArrayCollection|Session[]
  64. * @ORM\ManyToMany(targetEntity="CoreBundle\Entity\Session", mappedBy="topics")
  65. *
  66. */
  67. private $sessions;
  69. /**
  70. * @var bool $enabled
  71. *
  72. * @ORM\Column(name="enabled", type="boolean", unique=false, options={"default" : true})
  73. */
  74. private $enabled;
  76. /**
  77. * The type of math student 1=A, 2=A+B, 3=A+B+C, null = A+B+C
  78. * @var int
  79. * @ORM\Column(type="smallint", nullable=true)
  80. */
  81. private $curriculum;
  83. /**
  84. * 1=important, 0=not important
  85. * @var int
  86. * @ORM\Column(name="exam_priority", type="smallint", nullable=true)
  87. */
  88. private $examPriority;
  90. /**
  91. * @var int
  92. * @ORM\Column(name="sort_order", type="smallint", nullable=true)
  93. */
  94. private $sortOrder;
  96. /**
  97. * @var bool
  98. * @ORM\Column(name="visible_in_training", type="boolean", options={"default" : true}, nullable=false)
  99. */
  100. private bool $visibleInTraining;
  103. /**
  104. * @var bool
  105. * @ORM\Column(name="visible_in_quiz", type="boolean", options={"default" : true}, nullable=false)
  106. */
  107. private bool $visibleInQuiz;
  109. /**
  110. * @var ArrayCollection
  111. *
  112. * @ORM\ManyToMany(targetEntity="CoreBundle\Entity\ClassroomType")
  113. * @ORM\JoinTable(name="topics_classroomtypes",
  114. * joinColumns={@ORM\JoinColumn(name="topic_id", referencedColumnName="id")},
  115. * inverseJoinColumns={@ORM\JoinColumn(name="classroomtype_id", referencedColumnName="id")}
  116. * )
  117. */
  118. private $classroomTypes;
  120. private static $translation = [];
  122. /**
  123. * @var ?DateTime
  124. *
  125. * @ORM\Column(name="deleted_at", type="datetime", nullable=true)
  126. */
  127. private ?DateTime $deletedAt;
  129. public function __construct()
  130. {
  131. $this->templates = new ArrayCollection();
  132. $this->sessions = new ArrayCollection();
  133. $this->classroomTypes = new ArrayCollection();
  134. }
  136. public function getId(): ?int
  137. {
  138. return $this->id;
  139. }
  141. public function setName(string $name): self
  142. {
  143. $this->name = $name;
  145. return $this;
  146. }
  148. public function getName(): string
  149. {
  150. return $this->name;
  151. }
  153. public function setSelfStudyName(?string $name): self
  154. {
  155. $this->selfstudyName = $name;
  156. return $this;
  157. }
  159. public function getSelfStudyName(): ?string
  160. {
  161. return $this->selfstudyName;
  162. }
  164. /**
  165. * Set category.
  166. *
  167. * @param Category $category
  168. *
  169. * @return Topic
  170. */
  171. public function setCategory($category)
  172. {
  173. $this->category = $category;
  175. return $this;
  176. }
  178. /**
  179. * Get category.
  180. *
  181. * @return Category
  182. */
  183. public function getCategory()
  184. {
  185. return $this->category;
  186. }
  188. /**
  189. * @return TemplateMathproblem[]
  190. */
  191. public function getTemplates()
  192. {
  193. return $this->templates;
  194. }
  196. /**
  197. * @param TemplateMathproblem $template
  198. *
  199. * @return Topic
  200. */
  201. public function addTemplate(TemplateMathproblem $template)
  202. {
  203. $template->setTopic($this);
  204. $this->templates->add($template);
  206. return $this;
  207. }
  209. /**
  210. * @param TemplateMathproblem $template
  211. *
  212. * @return bool
  213. */
  214. public function removeTemplate(TemplateMathproblem $template)
  215. {
  216. $template->setTopic(null);
  218. return $this->templates->removeElement($template);
  219. }
  221. /**
  222. * @return Session[]
  223. */
  224. public function getSessions()
  225. {
  226. return $this->sessions;
  227. }
  229. /**
  230. * @param Session $session
  231. *
  232. * @return Topic
  233. */
  234. public function addSession(Session $session)
  235. {
  236. $this->sessions->add($session);
  238. return $this;
  239. }
  241. /**
  242. * @param Session $session
  243. *
  244. * @return bool
  245. */
  246. public function removeSession(Session $session)
  247. {
  248. return $this->sessions->removeElement($session);
  249. }
  251. /**
  252. * @return boolean
  253. */
  254. public function isEnabled()
  255. {
  256. return $this->enabled;
  257. }
  259. /**
  260. * @param boolean $enabled
  261. */
  262. public function setEnabled($enabled)
  263. {
  264. $this->enabled = $enabled;
  265. }
  267. /**
  268. * @return int
  269. */
  270. public function getCurriculum()
  271. {
  272. return $this->curriculum;
  273. }
  275. /**
  276. * @param int $curriculum
  277. */
  278. public function setCurriculum($curriculum)
  279. {
  280. $this->curriculum = $curriculum;
  281. }
  283. /**
  284. * @return int
  285. */
  286. public function getExamPriority()
  287. {
  288. return $this->examPriority;
  289. }
  291. /**
  292. * @param int $examPriority
  293. */
  294. public function setExamPriority($examPriority)
  295. {
  296. $this->examPriority = $examPriority;
  297. }
  299. /**
  300. * @return int
  301. */
  302. public function getSortOrder()
  303. {
  304. return $this->sortOrder;
  305. }
  307. /**
  308. * @param int $sortOrder
  309. */
  310. public function setSortOrder($sortOrder)
  311. {
  312. $this->sortOrder = $sortOrder;
  313. }
  315. public function getClassroomTypes(): Collection
  316. {
  317. return $this->classroomTypes;
  318. }
  320. public function getClassroomTypesList(bool $shouldTruncate=false): string
  321. {
  322. if ($this->classroomTypes->isEmpty()) {
  323. return '-';
  324. }
  326. $classroomTypes = new ArrayCollection();
  327. foreach ($this->classroomTypes as $classroomType) {
  328. $classroomTypes->add($classroomType->getName());
  329. if ($shouldTruncate) {
  330. if ($classroomTypes->count() > 3) {
  331. break;
  332. }
  333. }
  334. }
  335. $classroomTypes = implode(', ', $classroomTypes->toArray());
  337. if ($shouldTruncate) {
  338. $classroomTypes .= ', ...';
  339. }
  341. return $classroomTypes;
  342. }
  344. public function jsonSerialize(): mixed
  345. {
  347. $name = explode('_', $this->name)[0];
  349. $display = null;
  350. if(count(self::$translation) == 0) {
  351. $translation_path_da = dirname($_SERVER['DOCUMENT_ROOT']) . '/translations/messages.da.yml';
  352. $translation_path_en = dirname($_SERVER['DOCUMENT_ROOT']) . '/translations/messages.en.yml';
  353. $translation_en = Yaml::parse(file_get_contents($translation_path_en))['abacus']['problem_types'];
  354. $translation_da = Yaml::parse(file_get_contents($translation_path_da))['abacus']['problem_types'];
  356. self::$translation = [];
  357. foreach ($translation_da as $key => $value) {
  358. self::$translation[$translation_en[$key]] = $value;
  359. }
  360. }
  362. if(isset(self::$translation[$name])){
  363. $display = self::$translation[$name];
  364. }
  366. return [
  367. "id" => $this->id,
  368. "name" => $name,
  369. "displayName" => $this->getDisplayName(),
  370. "category" => $this->getCategory(),
  371. "display" => $display
  372. ];
  373. }
  375. public function isVisibleInTraining(): bool
  376. {
  377. return $this->visibleInTraining;
  378. }
  380. public function setVisibleInTraining(bool $visibleInTraining): void
  381. {
  382. $this->visibleInTraining = $visibleInTraining;
  383. }
  385. public function isVisibleInQuiz(): bool
  386. {
  387. return $this->visibleInQuiz;
  388. }
  390. public function setVisibleInQuiz(bool $visibleInQuiz): void
  391. {
  392. $this->visibleInQuiz = $visibleInQuiz;
  393. }
  395. public function getDisplayName(): string
  396. {
  397. if ($this->displayName) {
  398. return $this->displayName;
  399. }
  400. return $this->name;
  401. }
  403. public function setDisplayName(?string $displayName): void
  404. {
  405. $this->displayName = $displayName;
  406. }
  409. public function __toString(): string
  410. {
  411. return $this->getDisplayName();
  412. }
  414. public function hasDisplayName(): bool
  415. {
  416. if (mb_strlen($this->displayName) > 0) {
  417. return true;
  418. }
  419. return false;
  420. }
  422. public function getDisplayNameOrSanitizedName(): string
  423. {
  424. return $this->hasDisplayName() ? $this->getDisplayName() : explode("_", $this->getName())[0];
  425. }
  427. public function getSelfStudyNameOrSanitizedName(): string
  428. {
  429. return $this->selfstudyName ?: explode("_", $this->getName())[0];
  430. }
  432. public function getDeletedAt(): ?DateTime
  433. {
  434. return $this->deletedAt;
  435. }
  437. public function setDeletedAt(?DateTime $deletedAt): void
  438. {
  439. $this->deletedAt = $deletedAt;
  440. }
  442. public function areAllProblemsPublished(): bool
  443. {
  444. foreach ($this->templates as $template) {
  445. foreach ($template->getMathproblems() as $mathproblem) {
  446. if (!$mathproblem->isPublished()) {
  447. return false;
  448. }
  449. }
  450. }
  451. return true;
  452. }
  453. }