src/Entity/Survey.php line 127

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use ApiPlatform\Core\Annotation\ApiResource;
  6. use ApiPlatform\Core\Annotation\ApiSubresource;
  7. use ApiPlatform\Core\Annotation\ApiFilter;
  8. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\ExistsFilter;
  9. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
  10. use ApiPlatform\Core\Serializer\Filter\GroupFilter;
  11. use ApiPlatform\Core\Serializer\Filter\PropertyFilter;
  12. use App\Repository\SurveyRepository;
  13. use Doctrine\Common\Collections\ArrayCollection;
  14. use Doctrine\Common\Collections\Collection;
  15. use Doctrine\ORM\Mapping as ORM;
  16. use Gedmo\Mapping\Annotation as Gedmo;
  17. use Symfony\Component\Serializer\Annotation\Groups;
  18. use Symfony\Component\Validator\Constraints as Assert;
  20. /**
  21.  * @ORM\Entity(repositoryClass=SurveyRepository::class)
  22.  * @ApiResource(
  23.  *     normalizationContext={
  24.  *         "groups"={"survey:read"}
  25.  *     },
  26.  *     denormalizationContext={
  27.  *          "groups"={"survey:write"}
  28.  *     },
  29.  *     collectionOperations={
  30.  *          "get"={
  31.  *              "security"="is_granted('ROLE_USER')"
  32.  *          },
  33.  *          "post"={
  34.  *              "security"="is_granted('ROLE_ADMIN')"
  35.  *          },
  36.  *          "get_surveys_homepage"={
  37.  *              "security"="is_granted('ROLE_USER')",
  38.  *              "path"="/surveys_homepage",
  39.  *              "method"="GET",
  40.  *              "controller"="App\Controller\Api\SurveyController::getHomepageSurvey",
  41.  *              "openapi_context"={
  42.  *                  "summary"="Fetches homepage survey",
  43.  *              },
  44.  *          },
  45.  *          "get_answers_surveys_homepage"={
  46.  *              "security"="is_granted('ROLE_USER')",
  47.  *              "path"="/surveys_homepage/answers",
  48.  *              "method"="GET",
  49.  *              "controller"="App\Controller\Api\SurveyController::getAnswersHomepageSurveyBO",
  50.  *              "openapi_context"={
  51.  *                  "summary"="Fetches answers homepage survey",
  52.  *              },
  53.  *          },
  54.  *          "get_surveys_programs"={
  55.  *              "security"="is_granted('ROLE_USER')",
  56.  *              "path"="/surveys_program",
  57.  *              "method"="GET",
  58.  *              "controller"="App\Controller\Api\SurveyController::getProgramsSurvey",
  59.  *              "openapi_context"={
  60.  *                  "summary"="Fetches all program survey",
  61.  *              },
  62.  *          },
  63.  *          "get_answers_surveys_programs"={
  64.  *              "security"="is_granted('ROLE_USER')",
  65.  *              "path"="/programs/{id}/surveys/answers",
  66.  *              "method"="GET",
  67.  *              "controller"="App\Controller\Api\SurveyController::getAnswersProgramsSurvey",
  68.  *              "openapi_context"={
  69.  *                  "summary"="Fetches all program survey",
  70.  *              },
  71.  *          },
  72.  *          "display_program_survey"={
  73.  *              "security"="is_granted('ROLE_USER')",
  74.  *              "path"="/programs/{id}/surveys/display",
  75.  *              "method"="GET",
  76.  *              "controller"="App\Controller\Api\SurveyController::displayProgramSurvey",
  77.  *              "openapi_context"={
  78.  *                  "summary"="Fetches all program survey",
  79.  *              },
  80.  *          },
  81.  *          "get_count_submited_survey"={
  82.  *              "security"="is_granted('ROLE_USER')",
  83.  *              "path"="/surveys/{id}/count-submited",
  84.  *              "method"="GET",
  85.  *              "controller"="App\Controller\Api\SurveyController::countSumbitedSurvey",
  86.  *              "openapi_context"={
  87.  *                  "summary"="Count number of submited survey",
  88.  *              },
  89.  *          },
  90.  *          "create_vitality_tag_survey"={
  91.  *              "description"="Create new survey type = vitality_survey",
  92.  *              "path"="/vitality_surveys",
  93.  *              "method"="POST",
  94.  *              "controller"="App\Controller\Api\SurveyController::createVitalityTagSurvey",
  95.  *              "security"="is_granted('ROLE_ADMIN')"
  96.  *          },
  97.  *     },
  98.  *     itemOperations={
  99.  *          "get"={
  100.  *              "security"="is_granted('ROLE_USER')"
  101.  *          },
  102.  *          "delete"={
  103.  *              "security"="is_granted('ROLE_ADMIN')"
  104.  *          },
  105.  *          "patch"={
  106.  *              "security"="is_granted('ROLE_ADMIN')"
  107.  *          }
  108.  *     }
  109.  * )
  110.  * @ApiFilter(SearchFilter::class, strategy="exact", properties={
  111.  *      "id", "type","questions.active","questions.answers.active", "active", "tvTag.id"
  112.  * })
  113.  * @ApiFilter(ExistsFilter::class, properties={"tvTag"})
  114.  * @ORM\HasLifecycleCallbacks
  115.  * @ApiFilter(GroupFilter::class, arguments={
  116.  *      "parameterName": "groups", 
  117.  *      "overrideDefaultGroups": true, 
  118.  *      "whitelist": {"survey_list", "survey_vitality_front", "recommendation_survey_edit"}
  119.  * })
  120.  * @ApiFilter(PropertyFilter::class, 
  121.  *      arguments={
  122.  *          "parameterName"="fields", 
  123.  *          "overrideDefaultProperties"=true
  124.  *     }
  125.  * )
  126.  */
  127. class Survey
  128. {
  129.     const TYPE_HOMEPAGE = 'homepage_survey';
  130.     const TYPE_PROGRAM = 'program_survey';
  131.     const TYPE_VITALITY = 'vitality_survey';
  132.     const TYPE_TEAMPLAY_QUIZ = 'teamplay_quiz';
  134.     const TYPES = [
  135.         self::TYPE_HOMEPAGE,
  136.         self::TYPE_PROGRAM,
  137.         self::TYPE_VITALITY,
  138.         self::TYPE_TEAMPLAY_QUIZ,
  139.     ];
  141.     /**
  142.      * @ORM\Id
  143.      * @ORM\GeneratedValue
  144.      * @ORM\Column(type="integer")
  145.      * @Groups({"survey:read:id", "survey:read", "question:read", "survey_list", "survey_vitality_front", "recommendation_survey_edit", "teamplay_challenge:read", "program:read"})
  146.      */
  147.     private $id;
  149.     /**
  150.      * @ORM\Column(type="string", length=255)
  151.      * @Groups({"survey:read:name", "survey:read", "survey:write", "question:read", "survey_list", "survey_vitality_front", "recommendation_survey_edit", "teamplay_challenge:write", "teamplay_challenge:read", "program:read"})
  152.      */
  153.     private $name;
  155.     /**
  156.      * Defines the origin of the survey in witch page will it be displayed
  157.      * (ex: a type 'homepage_survey' is a survey to be displayed in an HP)
  158.      * @ORM\Column(type="string", length=255)
  159.      * @Assert\Choice(choices=self::TYPES)
  160.      * @Assert\NotBlank
  161.      * @Groups({"survey:read:type", "survey:read", "survey:write", "question:read", "survey_list", "teamplay_challenge:write", "teamplay_challenge:read"})
  162.      */
  163.     private $type;
  165.     /**
  166.      * @ORM\Column(type="text", nullable=true)
  167.      * @Groups({"survey:read:description", "survey:read", "survey:write", "survey_list", "survey_vitality_front", "recommendation_survey_edit", "teamplay_challenge:write", "teamplay_challenge:read"})
  168.      */
  169.     private $description;
  171.     /**
  172.      * @ORM\OneToMany(targetEntity=Question::class, mappedBy="survey", orphanRemoval=true, cascade={"persist", "refresh", "remove"})
  173.      * @ApiSubresource(maxDepth=1)
  174.      * @Groups({"survey:read:questions", "survey:read", "program:read", "survey_vitality_front", "teamplay_challenge:write", "teamplay_challenge:read"})
  175.      */
  176.     private $questions;
  178.     /**
  179.      * @ORM\ManyToMany(targetEntity=Program::class, inversedBy="surveys")
  180.      * @Groups({"survey:read:programs", "survey:read", "survey:write"})
  181.      */
  182.     private $programs;
  184.     /**
  185.      * @ORM\Column(type="boolean", options={"default": 0})
  186.      * @Groups({"survey:read:active", "survey:read", "survey:write", "survey_list", "recommendation_survey_edit", "teamplay_challenge:write", "teamplay_challenge:read", "program:read"})
  187.      */
  188.     private $active = false;
  190.     /**
  191.      * @ORM\ManyToOne(targetEntity=TvTag::class)
  192.      * @Groups({"survey:read:tvTag", "survey:read", "survey:write", "survey_list", "survey_vitality_front", "recommendation_survey_edit"})
  193.      */
  194.     private $tvTag = null;
  196.     /**
  197.      * @ORM\OneToMany(targetEntity=SurveyConfig::class, mappedBy="survey")
  198.      * @Groups({"survey:read:configs", "survey:read"})
  199.      */
  200.     private $configs;
  202.     /**
  203.      * @ORM\Column(type="datetime", nullable=true)
  204.      * @Gedmo\Timestampable(on="update")
  205.      */
  206.     private $updatedAt;
  208.     /**
  209.      * @ORM\Column(type="datetime")
  210.      * @Gedmo\Timestampable(on="create")
  211.      */
  212.     private $createdAt;
  214.     /**
  215.      * @ORM\OneToMany(targetEntity=UserResponse::class, mappedBy="survey")
  216.      */
  217.     private $userResponses;
  219.     /**
  220.      * @Groups({"survey:read:nbSubmited", "survey:read", "program:read", "teamplay_challenge:read"})
  221.      */
  222.     public $nbSubmited = 0;
  224.     /**
  225.      * @Groups({"survey:read:tvTags", "survey:read"})
  226.      */
  227.     public $tvTags = null;
  229.     /**
  230.      * @Groups({"survey:read:tvTags", "survey:read", "program:read", "teamplay_challenge:read"})
  231.      */
  232.     public $stopAsk = false;
  234.     /**
  235.      * @ORM\OneToMany(targetEntity=TeamplayChallenge::class, mappedBy="survey", cascade={"persist", "refresh", "remove"}, orphanRemoval=true)
  236.      */
  237.     private $teamplayChallenges;
  239.     /**
  240.      * @Groups({"survey:read:motivationPhrase", "survey:read", "program:read", "teamplay_challenge:read"})
  241.      */
  242.     private $motivationPhrase; 
  244.     /**
  245.      * @Groups({"survey:read:motivationPhrase1", "survey:read", "program:read", "teamplay_challenge:read"})
  246.      */
  247.     private $motivationPhrase1; 
  249.     /**
  250.      * @Groups({"survey:read:motivationPhrase2", "survey:read", "program:read", "teamplay_challenge:read"})
  251.      */
  252.     private $motivationPhrase2; 
  254.     /**
  255.      * @Groups({"survey:read:motivationPhrase3", "survey:read", "program:read", "teamplay_challenge:read"})
  256.      */    
  257.     private $motivationPhrase3; 
  259.     /**
  260.      * @Groups({"survey:read:motivationPhrase4", "survey:read", "program:read", "teamplay_challenge:read"})
  261.      */
  262.     private $motivationPhrase4; 
  264.     public function __construct()
  265.     {
  266.         $this->questions = new ArrayCollection();
  267.         $this->programs = new ArrayCollection();
  268.         $this->configs = new ArrayCollection();
  269.         $this->userResponses = new ArrayCollection();
  270.         $this->teamplayChallenges = new ArrayCollection();
  271.     }
  273.     public function __clone()
  274.     {
  275.         $this->id = null;
  276.         $this->programs = new ArrayCollection();
  277.         $this->configs = new ArrayCollection();
  278.         $this->userResponses = new ArrayCollection();
  279.         $this->teamplayChallenges = new ArrayCollection();
  280.         $this->active = false;
  281.         $this->createdAt = new \DateTime();
  282.         $this->updatedAt = new \DateTime();
  284.         // Copy des Questions
  285.         $questions = new ArrayCollection();
  286.         foreach ($this->questions->toArray() as $question) {
  287.             $newQuestion = clone $question;
  288.             $newQuestion->setSurvey($this);
  289.             $questions->add($newQuestion);
  290.         }
  291.         $this->questions = $questions;
  292.     }
  294.     public function getId(): ?int
  295.     {
  296.         return $this->id;
  297.     }
  299.     public function setId(?int $id): self
  300.     {
  301.         $this->id = $id;
  303.         return $this;
  304.     }
  306.     public function getName(): ?string
  307.     {
  308.         return $this->name;
  309.     }
  311.     public function setName(string $name): Survey
  312.     {
  313.         $this->name = $name;
  315.         return $this;
  316.     }
  318.     public function getDescription(): ?string
  319.     {
  320.         return $this->description;
  321.     }
  323.     public function setDescription(?string $description): Survey
  324.     {
  325.         $this->description = $description;
  327.         return $this;
  328.     }
  330.     public function getUpdatedAt(): ?\DateTimeInterface
  331.     {
  332.         return $this->updatedAt;
  333.     }
  335.     public function setUpdatedAt(?\DateTimeInterface $updatedAt): Survey
  336.     {
  337.         $this->updatedAt = $updatedAt;
  339.         return $this;
  340.     }
  342.     public function getCreatedAt(): ?\DateTimeInterface
  343.     {
  344.         return $this->createdAt;
  345.     }
  347.     public function setCreatedAt(\DateTimeInterface $createdAt): Survey
  348.     {
  349.         $this->createdAt = $createdAt;
  351.         return $this;
  352.     }
  354.     /**
  355.      * @return Collection|Question[]
  356.      */
  357.     public function getQuestions(): Collection
  358.     {
  359.         return $this->questions;
  360.     }
  362.     public function addQuestion(Question $question): Survey
  363.     {
  364.         if (!$this->questions->contains($question)) {
  365.             $this->questions[] = $question;
  366.             $question->setSurvey($this);
  367.         }
  369.         return $this;
  370.     }
  372.     public function removeQuestion(Question $question): Survey
  373.     {
  374.         if ($this->questions->removeElement($question)) {
  375.             // set the owning side to null (unless already changed)
  376.             if ($question->getSurvey() === $this) {
  377.                 $question->setSurvey(null);
  378.             }
  379.         }
  381.         return $this;
  382.     }
  384.     /**
  385.      * @return Collection|Program[]
  386.      */
  387.     public function getPrograms(): Collection
  388.     {
  389.         return $this->programs;
  390.     }
  392.     public function addProgram(Program $program): Survey
  393.     {
  394.         if (!$this->programs->contains($program)) {
  395.             $this->programs[] = $program;
  396.         }
  397.         return $this;
  398.     }
  400.     public function removeProgram(Program $program): Survey
  401.     {
  402.         $this->programs->removeElement($program);
  403.         return $this;
  404.     }
  406.     /**
  407.      * @return mixed
  408.      */
  409.     public function getType()
  410.     {
  411.         return $this->type;
  412.     }
  414.     /**
  415.      * @param mixed $type
  416.      * @return Survey
  417.      */
  418.     public function setType($type): Survey
  419.     {
  420.         $this->type = $type;
  421.         return $this;
  422.     }
  424.     public function getActive(): ?bool
  425.     {
  426.         return $this->active;
  427.     }
  429.     public function setActive(bool $active): self
  430.     {
  431.         $this->active = $active;
  433.         return $this;
  434.     }
  436.     public function getTvTag(): ?TvTag
  437.     {
  438.         return $this->tvTag;
  439.     }
  441.     public function setTvTag(?TvTag $tvTag): self
  442.     {
  443.         $this->tvTag = $tvTag;
  445.         return $this;
  446.     }
  448.     /**
  449.      * @return Collection|SurveyConfig[]
  450.      */
  451.     public function getConfigs(): Collection
  452.     {
  453.         return $this->configs;
  454.     }
  456.     public function addConfig(SurveyConfig $config): self
  457.     {
  458.         if (!$this->configs->contains($config)) {
  459.             $this->configs[] = $config;
  460.             $config->setSurvey($this);
  461.         }
  463.         return $this;
  464.     }
  466.     public function removeConfig(SurveyConfig $config): self
  467.     {
  468.         if ($this->configs->removeElement($config)) {
  469.             // set the owning side to null (unless already changed)
  470.             if ($config->getSurvey() === $this) {
  471.                 $config->setSurvey(null);
  472.             }
  473.         }
  475.         return $this;
  476.     }
  478.     /**
  479.      * @Groups({"recommendation_survey_edit"})
  480.      */
  481.     public function getMotivationPhrase(): ?string
  482.     {
  483.         $this->motivationPhrase = null;
  484.         if(!empty($this->configs->toArray())) {
  485.             foreach ($this->configs->toArray() as $config) {
  486.                 if($config instanceof SurveyConfig && $config->getType() === SurveyConfig::RECOMMENDED_OBJECTIVES 
  487.                     && in_array($config->getSubType(), SurveyConfig::INTERVALLES)){
  488.                        $this->motivationPhrase = $config->getValue(); 
  489.                 }
  490.             }
  491.         }
  492.         return $this->motivationPhrase;
  493.     }
  495.     /**
  496.      * @Groups({"recommendation_survey_edit"})
  497.      */
  498.     public function getMotivationPhrase1(): ?string
  499.     {
  500.         $this->motivationPhrase1 = null;
  501.         if(!empty($this->configs->toArray())) {
  502.             foreach ($this->configs->toArray() as $config) {
  503.                 if($config instanceof SurveyConfig && $config->getType() === SurveyConfig::RECOMMENDED_OBJECTIVES 
  504.                     && $config->getSubType() === SurveyConfig::INTERVALLE_1){
  505.                        $this->motivationPhrase1 = $config->getValue(); 
  506.                        break;
  507.                 }
  508.             }
  509.         }
  510.         return $this->motivationPhrase1;
  511.     }
  513.     /**
  514.      * @Groups({"recommendation_survey_edit"})
  515.      */
  516.     public function getMotivationPhrase2(): ?string
  517.     {
  518.         $this->motivationPhrase2 = null;
  519.         if(!empty($this->configs->toArray())) {
  520.             foreach ($this->configs->toArray() as $config) {
  521.                 if($config instanceof SurveyConfig && $config->getType() === SurveyConfig::RECOMMENDED_OBJECTIVES 
  522.                     && $config->getSubType() === SurveyConfig::INTERVALLE_2){
  523.                        $this->motivationPhrase2 = $config->getValue(); 
  524.                        break;
  525.                 }
  526.             }
  527.         }
  528.         return $this->motivationPhrase2;
  529.     }
  531.     /**
  532.      * @Groups({"recommendation_survey_edit"})
  533.      */
  534.     public function getMotivationPhrase3(): ?string
  535.     {
  536.         $this->motivationPhrase3 = null;
  537.         if(!empty($this->configs->toArray())) {
  538.             foreach ($this->configs->toArray() as $config) {
  539.                 if($config instanceof SurveyConfig && $config->getType() === SurveyConfig::RECOMMENDED_OBJECTIVES 
  540.                     && $config->getSubType() === SurveyConfig::INTERVALLE_3){
  541.                        $this->motivationPhrase3 = $config->getValue(); 
  542.                        break;
  543.                 }
  544.             }
  545.         }
  546.         return $this->motivationPhrase3;
  547.     }
  549.     /**
  550.      * @Groups({"recommendation_survey_edit"})
  551.      */
  552.     public function getMotivationPhrase4(): ?string
  553.     {
  554.         $this->motivationPhrase4 = null;
  555.         if(!empty($this->configs->toArray())) {
  556.             foreach ($this->configs->toArray() as $config) {
  557.                 if($config instanceof SurveyConfig && $config->getType() === SurveyConfig::RECOMMENDED_OBJECTIVES 
  558.                     && $config->getSubType() === SurveyConfig::INTERVALLE_4){
  559.                        $this->motivationPhrase4 = $config->getValue(); 
  560.                        break;
  561.                 }
  562.             }
  563.         }
  564.         return $this->motivationPhrase4;
  565.     }
  567.     /**
  568.      * @return Collection|UserResponse[]
  569.      */
  570.     public function getUserResponses(): Collection
  571.     {
  572.         return $this->userResponses;
  573.     }
  575.     public function addUserResponse(UserResponse $userResponse): self
  576.     {
  577.         if (!$this->userResponses->contains($userResponse)) {
  578.             $this->userResponses[] = $userResponse;
  579.             $userResponse->setSurvey($this);
  580.         }
  582.         return $this;
  583.     }
  585.     public function removeUserResponse(UserResponse $userResponse): self
  586.     {
  587.         if ($this->userResponses->removeElement($userResponse)) {
  588.             // set the owning side to null (unless already changed)
  589.             if ($userResponse->getSurvey() === $this) {
  590.                 $userResponse->setSurvey(null);
  591.             }
  592.         }
  594.         return $this;
  595.     }
  597.     /**
  598.      * @return Collection|TeamplayChallenge[]
  599.      */
  600.     public function getTeamplayChallenges(): Collection
  601.     {
  602.         return $this->teamplayChallenges;
  603.     }
  605.     public function addTeamplayChallenge(TeamplayChallenge $teamplayChallenge): self
  606.     {
  607.         if (!$this->teamplayChallenges->contains($teamplayChallenge)) {
  608.             $this->teamplayChallenges[] = $teamplayChallenge;
  609.             $teamplayChallenge->setSurvey($this);
  610.         }
  612.         return $this;
  613.     }
  615.     public function removeTeamplayChallenge(TeamplayChallenge $teamplayChallenge): self
  616.     {
  617.         if ($this->teamplayChallenges->removeElement($teamplayChallenge)) {
  618.             // set the owning side to null (unless already changed)
  619.             if ($teamplayChallenge->getSurvey() === $this) {
  620.                 $teamplayChallenge->setSurvey(null);
  621.             }
  622.         }
  624.         return $this;
  625.     }
  626. }