src/Entity/MatterNote.php line 24

1. <?php
3. namespace MedBrief\MSR\Entity;
5. use DH\Auditor\Provider\Doctrine\Auditing\Annotation as Audit;
6. use Doctrine\ORM\Mapping as ORM;
7. use Gedmo\Mapping\Annotation as Gedmo;
8. use MedBrief\MSR\Repository\MatterNoteRepository;
9. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
11. /**
12. * MatterNote
13. *
14. * @ORM\Table(name="MatterNote")
15. *
16. * @ORM\Entity(repositoryClass=MatterNoteRepository::class)
17. *
18. * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
19. *
20. * @Audit\Auditable
21. *
22. * @Audit\Security(view={"ROLE_ALLOWED_TO_AUDIT"})
23. */
24. class MatterNote
25. {
26. use FilterableClassConstantsTrait;
28. public const TYPE_QUERY = 1;
29. public const TYPE_QUERY__LABEL = 'Query';
31. public const TYPE_PASSWORD = 2;
32. public const TYPE_PASSWORD__LABEL = 'Password';
34. public const TYPE_UPDATE = 3;
35. public const TYPE_UPDATE__LABEL = 'Update';
37. public const TYPE_GENERAL = 4;
38. public const TYPE_GENERAL__LABEL = 'General';
40. public const TYPE_INDEX_AMENDMENT = 5;
41. public const TYPE_INDEX_AMENDMENT__LABEL = 'Index Amendment';
43. public const TYPE_MEMO_AMENDMENT = 6;
44. public const TYPE_MEMO_AMENDMENT__LABEL = 'Memo Amendment';
46. public const TYPE_REDACTION = 7;
47. public const TYPE_REDACTION__LABEL = 'Redaction';
49. public const TYPE_FILES_RECEIVED = 8;
50. public const TYPE_FILES_RECEIVED__LABEL = 'File(s) Received ';
52. public const TYPE_ISSUE_ACTIVE = 9;
53. public const TYPE_ISSUE_ACTIVE__LABEL = 'Issue - Active';
55. public const TYPE_ISSUE_RESOLVED = 10;
56. public const TYPE_ISSUE_RESOLVED__LABEL = 'Issue - Resolved';
58. public const TYPE_INSTRUCTION_TO_DO = 11;
59. public const TYPE_INSTRUCTION_TO_DO__LABEL = 'Instruction - To Do';
61. public const TYPE_INSTRUCTION_COMPLETED = 12;
62. public const TYPE_INSTRUCTION_COMPLETED__LABEL = 'Instruction - Completed';
64. /**
65. * @var int
66. *
67. * @ORM\Column(name="id", type="integer")
68. *
69. * @ORM\Id
70. *
71. * @ORM\GeneratedValue(strategy="IDENTITY")
72. */
73. protected $id;
75. /**
76. * @var \DateTime|null
77. *
78. * @ORM\Column(name="displayDate", type="datetime", nullable=true)
79. */
80. protected $displayDate;
82. /**
83. * @var int|null
84. *
85. * @ORM\Column(name="type", type="integer", nullable=true)
86. */
87. protected $type;
89. /**
90. * @var string|null
91. *
92. * @ORM\Column(name="note", type="text", nullable=true)
93. */
94. protected $note;
96. /**
97. * deletedAt
98. *
99. * @ORM\Column(name="creatorFullName", type="string", nullable=true)
100. */
101. protected $creatorFullName;
103. /**
104. * @var \DateTime|null
105. *
106. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
107. */
108. protected $deletedAt;
110. /**
111. * @var \DateTime
112. *
113. * @ORM\Column(name="created", type="datetime")
114. *
115. * @Gedmo\Timestampable(on="create")
116. */
117. protected $created;
119. /**
120. * @var \DateTime
121. *
122. * @ORM\Column(name="updated", type="datetime")
123. *
124. * @Gedmo\Timestampable(on="update")
125. */
126. protected $updated;
128. /**
129. * @var Project
130. *
131. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\Project", inversedBy="matterNotes")
132. *
133. * @ORM\JoinColumns({
134. *
135. * @ORM\JoinColumn(name="project_id", referencedColumnName="id")
136. * })
137. */
138. protected $project;
140. /**
141. * @var User
142. *
143. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User", inversedBy="matterNotes")
144. *
145. * @ORM\JoinColumns({
146. *
147. * @ORM\JoinColumn(name="creator_id", referencedColumnName="id", nullable=true)
148. * })
149. */
150. protected $creator;
152. /**
153. * @ORM\Column(type="boolean", options={"default"=false})
154. *
155. * @var bool
156. */
157. protected $isImportant = false;
159. /**
160. * Get id
161. *
162. * @return int
163. */
164. public function getId()
165. {
166. return $this->id;
167. }
169. /**
170. * Set displayDate
171. *
172. * @param \DateTime $displayDate
173. *
174. * @return MatterNote
175. */
176. public function setDisplayDate($displayDate)
177. {
178. $this->displayDate = $displayDate;
180. return $this;
181. }
183. /**
184. * Get displayDate
185. *
186. * @return \DateTime
187. */
188. public function getDisplayDate()
189. {
190. return $this->displayDate ?: $this->created;
191. }
193. /**
194. * Set type
195. *
196. * @param int $type
197. *
198. * @return MatterNote
199. */
200. public function setType($type)
201. {
202. $this->type = $type;
204. return $this;
205. }
207. /**
208. * Get type
209. *
210. * @return int
211. */
212. public function getType()
213. {
214. return $this->type;
215. }
217. /**
218. * @param ?array $noteCounts - Used to append the count next to the note type in the label.
219. *
220. * @return array
221. */
222. public static function getTypeOptions(?array $noteCounts = null): array
223. {
224. $noteTypes = array_flip(self::getConstantsWithLabelsAsChoices('TYPE'));
226. if ($noteCounts === null) {
227. return $noteTypes;
228. }
230. foreach ($noteTypes as $key => $noteType) {
231. $noteTypes[$key] = sprintf('%1$s (%2$s)', $noteType, $noteCounts[$key] ?? 0);
232. }
234. return $noteTypes;
235. }
237. /**
238. * Returns a human readable version of the types
239. *
240. * @return string
241. */
242. public function getTypeName()
243. {
244. $options = self::getTypeOptions();
246. return
247. $options[$this->getType()] ?? $this->getType();
248. }
250. /**
251. * Set note
252. *
253. * @param string $note
254. *
255. * @return MatterNote
256. */
257. public function setNote($note)
258. {
259. $this->note = $note;
261. return $this;
262. }
264. /**
265. * Get note
266. *
267. * @return string
268. */
269. public function getNote()
270. {
271. return $this->note;
272. }
274. /**
275. * Set deletedAt
276. *
277. * @param \DateTime $deletedAt
278. *
279. * @return MatterNote
280. */
281. public function setDeletedAt($deletedAt)
282. {
283. $this->deletedAt = $deletedAt;
285. return $this;
286. }
288. /**
289. * Get deletedAt
290. *
291. * @return \DateTime
292. */
293. public function getDeletedAt()
294. {
295. return $this->deletedAt;
296. }
298. /**
299. * Set created
300. *
301. * @param \DateTime $created
302. *
303. * @return MatterNote
304. */
305. public function setCreated($created)
306. {
307. $this->created = $created;
309. return $this;
310. }
312. /**
313. * Get created
314. *
315. * @return \DateTime
316. */
317. public function getCreated()
318. {
319. return $this->created;
320. }
322. /**
323. * Set updated
324. *
325. * @param \DateTime $updated
326. *
327. * @return MatterNote
328. */
329. public function setUpdated($updated)
330. {
331. $this->updated = $updated;
333. return $this;
334. }
336. /**
337. * Get updated
338. *
339. * @return \DateTime
340. */
341. public function getUpdated()
342. {
343. return $this->updated;
344. }
346. /**
347. * Set project
348. *
349. * @param Project $project
350. *
351. * @return MatterNote
352. */
353. public function setProject(?Project $project = null)
354. {
355. $this->project = $project;
357. return $this;
358. }
360. /**
361. * Get project
362. *
363. * @return Project
364. */
365. public function getProject()
366. {
367. return $this->project;
368. }
370. /**
371. * Set creator
372. *
373. * @param User $creator
374. *
375. * @return MatterNote
376. */
377. public function setCreator(?User $creator = null)
378. {
379. $this->creator = $creator;
381. return $this;
382. }
384. /**
385. * Get creator
386. *
387. * @return User
388. */
389. public function getCreator()
390. {
391. return $this->creator;
392. }
394. /**
395. * Set creatorFullName
396. *
397. * @param string $creatorFullName
398. *
399. * @return MatterNote
400. */
401. public function setCreatorFullName($creatorFullName)
402. {
403. $this->creatorFullName = $creatorFullName;
405. return $this;
406. }
408. /**
409. * Get creatorFullName
410. *
411. * @return string
412. */
413. public function getCreatorFullName()
414. {
415. return $this->creatorFullName;
416. }
418. /**
419. * @return bool
420. */
421. public function getIsImportant(): bool
422. {
423. return $this->isImportant;
424. }
426. /**
427. * @param bool $isImportant
428. *
429. * @return self
430. */
431. public function setIsImportant(bool $isImportant): self
432. {
433. $this->isImportant = $isImportant;
435. return $this;
436. }
438. /**
439. * Convenience method to determine if the type is set to password
440. *
441. * @return bool
442. */
443. public function isPassword(): bool
444. {
445. return $this->getType() === self::TYPE_PASSWORD;
446. }
447. }