src/V4/Entity/SavedRequest.php line 103

Open in your IDE?
  1. <?php
  3. namespace App\V4\Entity;
  5. use ApiPlatform\Core\Annotation\ApiFilter;
  6. use ApiPlatform\Core\Annotation\ApiProperty;
  7. use ApiPlatform\Core\Annotation\ApiResource;
  8. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
  9. use App\Model\Traits\ImportableObjectTrait;
  10. use Doctrine\Common\Collections\ArrayCollection;
  11. use Doctrine\Common\Collections\Collection;
  12. use Doctrine\ORM\Mapping as ORM;
  13. use Gedmo\Blameable\Traits\BlameableEntity as BlameableTrait;
  14. use Gedmo\Mapping\Annotation as Gedmo;
  15. use Gedmo\SoftDeleteable\Traits\SoftDeleteableEntity;
  16. use Gedmo\Timestampable\Traits\TimestampableEntity as TimestampableTrait;
  17. use Symfony\Component\Serializer\Annotation\Groups;
  19. /**
  20.  * @ApiResource(
  21.  *     shortName="V4/SavedRequest",
  22.  *     paginationEnabled=false,
  23.  *     attributes={
  24.  *         "api_allow_update": true
  25.  *     },
  26.  *     collectionOperations={
  27.  *         "get": {
  28.  *             "path": "/V4/saved_requests",
  29.  *             "normalization_context": {
  30.  *                 "groups": {"saved_request:list"}
  31.  *             }
  32.  *         },
  33.  *         "post_saved_request": {
  34.  *             "method": "POST",
  35.  *             "deserialize": false,
  36.  *             "write": false,
  37.  *             "controller": "App\V4\Controller\SavedRequest\SavedRequestDataPersisterAction",
  38.  *             "path": "/V4/saved_requests",
  39.  *             "input_formats": {
  40.  *                 "multipart": {"multipart/form-data"}
  41.  *             },
  42.  *             "normalization_context": {
  43.  *                  "groups": {"saved_request:write"}
  44.  *             },
  45.  *             "denormalization_context": {
  46.  *                  "groups": {}
  47.  *             }
  48.  *         },
  49.  *         "get_form": {
  50.  *             "method": "GET",
  51.  *             "path": "/V4/saved_requests/form",
  52.  *             "controller": App\V4\Controller\SavedRequest\GetSavedRequestFormAction::class
  53.  *         },
  54.  *     },
  55.  *     itemOperations={
  56.  *         "get": {
  57.  *             "path": "/V4/saved_requests/{id}",
  58.  *             "normalization_context": {
  59.  *                 "groups": {"saved_request:read"}
  60.  *             }
  61.  *         },
  62.  *         "get_form": {
  63.  *             "method": "GET",
  64.  *             "path": "/V4/saved_requests/{id}/form",
  65.  *             "controller": App\V4\Controller\SavedRequest\GetSavedRequestFormAction::class
  66.  *         },
  67.  *         "put_saved_request": {
  68.  *             "method": "POST",
  69.  *             "deserialize": false,
  70.  *             "write": false,
  71.  *             "controller": "App\V4\Controller\SavedRequest\SavedRequestDataPersisterAction",
  72.  *             "path": "/V4/saved_requests/{id}",
  73.  *             "input_formats": {
  74.  *                 "multipart": {"multipart/form-data"}
  75.  *             },
  76.  *             "normalization_context": {
  77.  *                  "groups": {"saved_request:update"}
  78.  *             },
  79.  *             "denormalization_context": {
  80.  *                  "groups": {}
  81.  *             }
  82.  *         },
  83.  *         "delete": {
  84.  *             "path": "/V4/saved_requests/{id}",
  85.  *         }
  86.  *     }
  87.  * )
  88.  *
  89.  * @ApiFilter(SearchFilter::class, properties={
  90.  *    "id": "exact",
  91.  *    "type": "exact",
  92.  *    "entity": "exact",
  93.  *    "tabId": "exact",
  94.  *    "customerId": "exact"
  95.  * })
  96.  *
  97.  * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
  98.  * @ORM\Entity(repositoryClass="App\V4\Repository\SavedRequestRepository")
  99.  * @ORM\Table(name="saved_request", indexes={
  100.  *     @ORM\Index(name="SAVED_REQUEST_CUSTOMER_ID", columns={"customer_id"})
  101.  * })
  102.  */
  103. class SavedRequest
  104. {
  105.     use ImportableObjectTrait;
  106.     use TimestampableTrait;
  107.     use BlameableTrait;
  108.     use SoftDeleteableEntity;
  110.     public const TYPE_SEARCH = 'search';
  111.     public const TYPE_BADGE = 'badge';
  112.     public const TYPE_SECTION_FILTER = 'section_filter';
  114.     public const TYPES = [
  115.         self::TYPE_BADGE => self::TYPE_BADGE,
  116.         self::TYPE_SEARCH => self::TYPE_SEARCH,
  117.         self::TYPE_SECTION_FILTER => self::TYPE_SECTION_FILTER,
  118.     ];
  120.     /**
  121.      * @ApiProperty(identifier=true)
  122.      *
  123.      * @var string
  124.      *
  125.      * @ORM\Id()
  126.      * @ORM\GeneratedValue(strategy="CUSTOM")
  127.      * @ORM\CustomIdGenerator(class="App\Doctrine\UuidGenerator")
  128.      * @ORM\Column(name="id", type="string")
  129.      *
  130.      * @Groups({
  131.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  132.      * })
  133.      */
  134.     private $id;
  136.     /**
  137.      * @var string
  138.      *
  139.      * @ORM\Column(type="string", length=255)
  140.      *
  141.      * @Groups({
  142.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  143.      * })
  144.      */
  145.     private $customerId;
  147.     /**
  148.      * @var string
  149.      *
  150.      * @ORM\Column(type="string", length=255)
  151.      *
  152.      * @Groups({
  153.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  154.      * })
  155.      */
  156.     private $entity;
  158.     /**
  159.      * @var string
  160.      *
  161.      * @ORM\Column(type="string", length=50, options={"default":"badge"})
  162.      *
  163.      * @Groups({
  164.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  165.      * })
  166.      */
  167.     private $type = self::TYPE_BADGE;
  169.     /**
  170.      * @var string
  171.      *
  172.      * @ORM\Column(type="string", length=255)
  173.      *
  174.      * @Groups({
  175.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  176.      * })
  177.      */
  178.     private $name;
  180.     /**
  181.      * @var string
  182.      *
  183.      * @ORM\Column(type="text")
  184.      *
  185.      * @Groups({
  186.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  187.      * })
  188.      */
  189.     private $content;
  191.     /**
  192.      * @var string|null
  193.      *
  194.      * @ORM\Column(type="string", length=50, nullable=true)
  195.      *
  196.      * @Groups({
  197.      *     "saved_request:list", "saved_request:read", "saved_request:write", "saved_request:update"
  198.      * })
  199.      */
  200.     private $tabId;
  202.     /**
  203.      * @var SavedRequestSection[]|Collection
  204.      * @ORM\OneToMany(targetEntity="App\V4\Entity\SavedRequestSection", mappedBy="savedRequest", cascade={"remove"})
  205.      */
  206.     private $savedRequestSections;
  208.     public function __construct()
  209.     {
  210.         $this->savedRequestSections = new ArrayCollection();
  211.     }
  213.     /**
  214.      * @return string
  215.      */
  216.     public function getId(): ?string
  217.     {
  218.         return $this->id;
  219.     }
  221.     /**
  222.      * @param string $id
  223.      *
  224.      * @return SavedRequest
  225.      */
  226.     public function setId(string $id): self
  227.     {
  228.         $this->id = $id;
  230.         return $this;
  231.     }
  233.     /**
  234.      * @return string
  235.      */
  236.     public function getCustomerId(): ?string
  237.     {
  238.         return $this->customerId;
  239.     }
  241.     /**
  242.      * @param string $customerId
  243.      *
  244.      * @return SavedRequest
  245.      */
  246.     public function setCustomerId(string $customerId): self
  247.     {
  248.         $this->customerId = $customerId;
  250.         return $this;
  251.     }
  253.     /**
  254.      * @return string
  255.      */
  256.     public function getEntity(): ?string
  257.     {
  258.         return $this->entity;
  259.     }
  261.     /**
  262.      * @param string $entity
  263.      *
  264.      * @return SavedRequest
  265.      */
  266.     public function setEntity(string $entity): self
  267.     {
  268.         $this->entity = $entity;
  270.         return $this;
  271.     }
  273.     /**
  274.      * @return string
  275.      */
  276.     public function getType(): ?string
  277.     {
  278.         return $this->type;
  279.     }
  281.     /**
  282.      * @param string $type
  283.      *
  284.      * @return SavedRequest
  285.      */
  286.     public function setType(string $type): self
  287.     {
  288.         $this->type = $type;
  290.         return $this;
  291.     }
  293.     /**
  294.      * @return string
  295.      */
  296.     public function getName(): ?string
  297.     {
  298.         return $this->name;
  299.     }
  301.     /**
  302.      * @param string $name
  303.      *
  304.      * @return SavedRequest
  305.      */
  306.     public function setName(string $name): self
  307.     {
  308.         $this->name = $name;
  310.         return $this;
  311.     }
  313.     /**
  314.      * @return string
  315.      */
  316.     public function getContent(): ?string
  317.     {
  318.         return $this->content;
  319.     }
  321.     /**
  322.      * @param string $content
  323.      *
  324.      * @return SavedRequest
  325.      */
  326.     public function setContent(string $content): self
  327.     {
  328.         $this->content = $content;
  330.         return $this;
  331.     }
  333.     /**
  334.      * @return string|null
  335.      */
  336.     public function getTabId(): ?string
  337.     {
  338.         return $this->tabId;
  339.     }
  341.     /**
  342.      * @param string|null $tabId
  343.      *
  344.      * @return $this
  345.      */
  346.     public function setTabId(?string $tabId): self
  347.     {
  348.         $this->tabId = $tabId;
  350.         return $this;
  351.     }
  353.     /**
  354.      * @return Collection|SavedRequestSection[]
  355.      */
  356.     public function getSavedRequestSections(): Collection
  357.     {
  358.         return $this->savedRequestSections;
  359.     }
  361.     /**
  362.      * @param SavedRequestSection[]|Collection $savedRequestSections
  363.      *
  364.      * @return $this
  365.      */
  366.     public function setSavedRequestSections(Collection $savedRequestSections): self
  367.     {
  368.         $this->savedRequestSections = $savedRequestSections;
  370.         return $this;
  371.     }
  373.     /**
  374.      * @param SavedRequestSection $savedRequestSection
  375.      *
  376.      * @return $this
  377.      */
  378.     public function addSavedRequestSection(SavedRequestSection $savedRequestSection): self
  379.     {
  380.         if (!$this->savedRequestSections->contains($savedRequestSection)) {
  381.             $this->savedRequestSections[] = $savedRequestSection;
  382.             $savedRequestSection->setSavedRequest($this);
  383.         }
  385.         return $this;
  386.     }
  388.     /**
  389.      * @param SavedRequestSection $savedRequestSection
  390.      *
  391.      * @return $this
  392.      */
  393.     public function removeSavedRequestSection(SavedRequestSection $savedRequestSection): self
  394.     {
  395.         if ($this->savedRequestSections->contains($savedRequestSection)) {
  396.             $this->savedRequestSections->removeElement($savedRequestSection);
  397.         }
  399.         return $this;
  400.     }
  401. }