src/Entity/Survey.php line 46

1. <?php
3. namespace App\Entity;
5. use Doctrine\ORM\Mapping as ORM;
6. use App\Repository\SurveyRepository;
7. use ApiPlatform\Core\Annotation\ApiFilter;
8. use App\Entity\Traits\TimestampableEntity;
9. use Doctrine\Common\Collections\Collection;
10. use ApiPlatform\Core\Annotation\ApiResource;
11. use Doctrine\Common\Collections\ArrayCollection;
12. use App\Entity\Interfaces\ContainerMappedInterface;
13. use Symfony\Component\Serializer\Annotation\Groups;
14. use Symfony\Component\Validator\Constraints as Assert;
15. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
16. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
17. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\BooleanFilter;
19. /**
20.  * @ApiResource(
21.  *      attributes={"security"="is_granted('ROLE_OPERATOR')"},
22.  *      normalizationContext={"groups"={"Survey:Read", "TZ:Read"}, "skip_null_values"=false},
23.  *      denormalizationContext={"groups"={"Survey:Write"}},
24.  *      collectionOperations={
25.  *          "get",
26.  *          "get_active"={
27.  *              "path"="/surveys/get-active",
28.  *              "method"="GET",
29.  *              "security"="is_granted('IS_AUTHENTICATED_FULLY')",
30.  *              "pagination_enabled"=false
31.  *          },
32.  *          "post"
33.  *      },
34.  *      itemOperations={
35.  *          "get",
36.  *          "put",
37.  *          "patch",
38.  *          "delete"
39.  *     }
40.  * )
41.  * @ApiFilter(SearchFilter::class, properties={"container.id": "exact", "name": "partial", "surveyTriggers.triggerType": "exact", "surveyTriggers.elTask.id": "exact", "surveyTriggers.elExam.id": "exact"})
42.  * @ApiFilter(BooleanFilter::class, properties={"isActive", "isMandatory"})
43.  * @ApiFilter(OrderFilter::class, properties={"id", "name", "createdAt"})
44.  * @ORM\Entity(repositoryClass=SurveyRepository::class)
45.  */
46. class Survey implements ContainerMappedInterface
47. {
48.     /**
49.      * Hook timestampable behavior
50.      * updates createdAt, updatedAt fields
51.      */
52.     use TimestampableEntity;
54.     /**
55.      * @ORM\Id
56.      * @ORM\GeneratedValue
57.      * @ORM\Column(type="integer")
58.      * @Groups({"Survey:Read"})
59.      */
60.     private $id;
62.     /**
63.      * @ORM\Column(type="string", length=255)
64.      * @Assert\NotBlank(message="validation.Survey:name.notBlank")
65.      * @Groups({"Survey:Read", "Survey:Write"})
66.      */
67.     private $name;
69.     /**
70.      * @ORM\Column(type="boolean", nullable=true)
71.      * @Groups({"Survey:Read", "Survey:Write"})
72.      */
73.     private $isActive;
75.     /**
76.      * @ORM\ManyToOne(targetEntity=Container::class)
77.      * @ORM\JoinColumn(nullable=false, onDelete="CASCADE")
78.      * @Groups({"Survey:Write"})
79.      */
80.     private $container;
82.     /**
83.      * @ORM\OneToMany(targetEntity=SurveyTrigger::class, mappedBy="survey", orphanRemoval=true, cascade={"persist"})
84.      * @Assert\Valid()
85.      * @Groups({"Survey:Read", "Survey:Write"})
86.      */
87.     private $surveyTriggers;
89.     /**
90.      * @ORM\OneToMany(targetEntity=SurveyQuestion::class, mappedBy="survey", orphanRemoval=true)
91.      */
92.     private $surveyQuestions;
94.     /**
95.      * @ORM\ManyToMany(targetEntity=UserGroup::class, inversedBy="surveys")
96.      * @Groups({"Survey:Read", "Survey:Write"})
97.      */
98.     private $userGroups;
100.     /**
101.      * @ORM\Column(type="boolean", nullable=true)
102.      * @Groups({"Survey:Read", "Survey:Write"})
103.      */
104.     private $isShowCancel;
106.     /**
107.      * @ORM\Column(type="string", length=32)
108.      * @Groups({"Survey:Read", "Survey:Write"})
109.      */
110.     private $visibility;
112.     public const SURVEYTRIGGERVISIBILITY_ONE_TIME = "ONE_TIME";
113.     public const SURVEYTRIGGERVISIBILITY_ONE_TIME_PER_TRIGGER = "ONE_TIME_PER_TRIGGER";
114.     public const SURVEYTRIGGERVISIBILITY_ALWAYS = "ALWAYS";
116.     /**
117.      * @ORM\OneToMany(targetEntity=SurveyPage::class, mappedBy="survey")
118.      */
119.     private $surveyPages;
121.     /**
122.      * @ORM\Column(type="boolean", nullable=true)
123.      * @Groups({"Survey:Read", "Survey:Write"})
124.      */
125.     private $isMandatory;
127.     public function __construct()
128.     {
129.         $this->surveyTriggers = new ArrayCollection();
130.         $this->surveyQuestions = new ArrayCollection();
131.         $this->userGroups = new ArrayCollection();
132.         $this->surveyPages = new ArrayCollection();
133.     }
135.     public function getId(): ?int
136.     {
137.         return $this->id;
138.     }
140.     public function getName(): ?string
141.     {
142.         return $this->name;
143.     }
145.     public function setName(string $name): self
146.     {
147.         $this->name = $name;
149.         return $this;
150.     }
152.     public function getIsActive(): ?bool
153.     {
154.         return $this->isActive;
155.     }
157.     public function setIsActive(?bool $isActive): self
158.     {
159.         $this->isActive = $isActive;
161.         return $this;
162.     }
164.     public function getContainer(): ?Container
165.     {
166.         return $this->container;
167.     }
169.     public function setContainer(?Container $container): self
170.     {
171.         $this->container = $container;
173.         return $this;
174.     }
176.     /**
177.      * @return Collection|SurveyTrigger[]
178.      */
179.     public function getSurveyTriggers(): Collection
180.     {
181.         return $this->surveyTriggers;
182.     }
184.     public function addSurveyTrigger(SurveyTrigger $surveyTrigger): self
185.     {
186.         if (!$this->surveyTriggers->contains($surveyTrigger)) {
187.             $this->surveyTriggers[] = $surveyTrigger;
188.             $surveyTrigger->setSurvey($this);
189.         }
191.         return $this;
192.     }
194.     public function removeSurveyTrigger(SurveyTrigger $surveyTrigger): self
195.     {
196.         if ($this->surveyTriggers->removeElement($surveyTrigger)) {
197.             // set the owning side to null (unless already changed)
198.             if ($surveyTrigger->getSurvey() === $this) {
199.                 $surveyTrigger->setSurvey(null);
200.             }
201.         }
203.         return $this;
204.     }
206.     public function removeAllSurveyTriggers(): self
207.     {
208.         foreach ($this->surveyTriggers as $surveyTrigger) {
209.             $this->removeSurveyTrigger($surveyTrigger);
210.         }
212.         return $this;
213.     }
215.     /**
216.      * @return Collection|SurveyQuestion[]
217.      */
218.     public function getSurveyQuestions(): Collection
219.     {
220.         return $this->surveyQuestions;
221.     }
223.     public function addSurveyQuestion(SurveyQuestion $surveyQuestion): self
224.     {
225.         if (!$this->surveyQuestions->contains($surveyQuestion)) {
226.             $this->surveyQuestions[] = $surveyQuestion;
227.             $surveyQuestion->setSurvey($this);
228.         }
230.         return $this;
231.     }
233.     public function removeSurveyQuestion(SurveyQuestion $surveyQuestion): self
234.     {
235.         if ($this->surveyQuestions->removeElement($surveyQuestion)) {
236.             // set the owning side to null (unless already changed)
237.             if ($surveyQuestion->getSurvey() === $this) {
238.                 $surveyQuestion->setSurvey(null);
239.             }
240.         }
242.         return $this;
243.     }
245.     /**
246.      * @return Collection|UserGroup[]
247.      */
248.     public function getUserGroups(): Collection
249.     {
250.         return $this->userGroups;
251.     }
253.     public function addUserGroup(UserGroup $userGroup): self
254.     {
255.         if (!$this->userGroups->contains($userGroup)) {
256.             $this->userGroups[] = $userGroup;
257.         }
259.         return $this;
260.     }
262.     public function removeUserGroup(UserGroup $userGroup): self
263.     {
264.         $this->userGroups->removeElement($userGroup);
266.         return $this;
267.     }
269.     public function removeAllUserGroups(): self
270.     {
271.         foreach ($this->userGroups as $userGroup) {
272.             $this->removeUserGroup($userGroup);
273.         }
275.         return $this;
276.     }
278.     public function getIsShowCancel(): ?bool
279.     {
280.         return $this->isShowCancel;
281.     }
283.     public function setIsShowCancel(?bool $isShowCancel): self
284.     {
285.         $this->isShowCancel = $isShowCancel;
287.         return $this;
288.     }
290.     public function getVisibility(): ?string
291.     {
292.         return $this->visibility;
293.     }
295.     public function setVisibility(string $visibility): self
296.     {
297.         $this->visibility = $visibility;
299.         return $this;
300.     }
302.     /**
303.      * @return Collection|SurveyPage[]
304.      */
305.     public function getSurveyPages(): Collection
306.     {
307.         return $this->surveyPages;
308.     }
310.     public function addSurveyPage(SurveyPage $surveyPage): self
311.     {
312.         if (!$this->surveyPages->contains($surveyPage)) {
313.             $this->surveyPages[] = $surveyPage;
314.             $surveyPage->setSurvey($this);
315.         }
317.         return $this;
318.     }
320.     public function removeSurveyPage(SurveyPage $surveyPage): self
321.     {
322.         if ($this->surveyPages->removeElement($surveyPage)) {
323.             // set the owning side to null (unless already changed)
324.             if ($surveyPage->getSurvey() === $this) {
325.                 $surveyPage->setSurvey(null);
326.             }
327.         }
329.         return $this;
330.     }
332.     public function isIsMandatory(): ?bool
333.     {
334.         return $this->isMandatory;
335.     }
337.     public function setIsMandatory(?bool $isMandatory): self
338.     {
339.         $this->isMandatory = $isMandatory;
341.         return $this;
342.     }
343. }