src/Entity/Slide.php line 98

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use ApiPlatform\Core\Annotation\ApiFilter;
  6. use ApiPlatform\Core\Annotation\ApiResource;
  7. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
  8. use ApiPlatform\Core\Serializer\Filter\PropertyFilter;
  9. use App\Annotation\CompanyCustomizable;
  10. use App\Repository\SlideRepository;
  11. use Doctrine\Common\Collections\ArrayCollection;
  12. use Doctrine\Common\Collections\Collection;
  13. use Doctrine\ORM\Mapping as ORM;
  14. use Gedmo\Mapping\Annotation as Gedmo;
  15. use Symfony\Component\HttpFoundation\File\UploadedFile;
  16. use Symfony\Component\Serializer\Annotation\Groups;
  17. use Symfony\Component\Validator\Constraints as Assert;
  19. /**
  20.  * @ORM\Entity(repositoryClass=SlideRepository::class)
  21.  * @ORM\HasLifecycleCallbacks
  22.  * @ApiResource(
  23.  *     normalizationContext={
  24.  *         "groups"={"slide:read"}
  25.  *     },
  26.  *     denormalizationContext={
  27.  *          "groups"={"slide:write"}
  28.  *     },
  29.  *     collectionOperations={
  30.  *          "get"={
  31.  *              "security"="is_granted('ROLE_ADMIN') or is_granted('ROLE_COMPANY')"
  32.  *          },
  33.  *          "post"={
  34.  *              "security"="is_granted('ROLE_ADMIN') or is_granted('ROLE_COMPANY')"
  35.  *          },
  36.  *          "get_channel_slides"={
  37.  *              "path"="/channels/{channel}/slides",
  38.  *              "method"="GET",
  39.  *              "controller"="App\Controller\Api\SlideController::getByChannel",
  40.  *              "security"="is_granted('ROLE_USER')"
  41.  *          },
  42.  *          "get_by_slug"={
  43.  *              "path"="/slides_page/{slug}",
  44.  *              "requirements"={"slug"=".*"},
  45.  *              "method"="GET",
  46.  *              "controller"="App\Controller\Api\SlideController::getBySlug",
  47.  *              "openapi_context"={
  48.  *                  "summary"="Fetches slides by slug (aka: page)",
  49.  *                  "parameters"={
  50.  *                      {
  51.  *                          "name"="slug",
  52.  *                          "in"="path",
  53.  *                          "description"="Slug to find",
  54.  *                          "required"=true,
  55.  *                          "schema"={
  56.  *                              "type"="string",
  57.  *                              "enum"=self::TYPES
  58.  *                          },
  59.  *                      },
  60.  *                  },
  61.  *              },
  62.  *          },
  63.  *          "get_slides_by_company"={
  64.  *              "path"="/companies/{company}/slides",
  65.  *              "method"="GET",
  66.  *              "controller"="App\Controller\Api\SlideController::getSlidesByCompany",
  67.  *              "security"="is_granted('ROLE_USER') or is_granted('ROLE_COMPANY') or is_granted('ROLE_ADMIN')"
  68.  *          },
  69.  *          "post_update"={
  70.  *              "security"="is_granted('ROLE_ADMIN') or is_granted('ROLE_COMPANY')",
  71.  *              "path"="/slides/{id}",
  72.  *              "description"="Update a Slide with method POST (using content-type: 'multipart')",
  73.  *              "method"="POST",
  74.  *              "controller"="App\Controller\Api\SlideController::update"
  75.  *          }
  76.  *     },
  77.  *     itemOperations={
  78.  *          "get"={
  79.  *              "security"="is_granted('ROLE_USER')"
  80.  *          },
  81.  *          "delete"={
  82.  *              "security"="is_granted('ROLE_ADMIN') or is_granted('ROLE_COMPANY')"
  83.  *          },
  84.  *          "patch"={
  85.  *              "security"="is_granted('ROLE_ADMIN') or is_granted('ROLE_COMPANY')"
  86.  *          }
  87.  *     }
  88.  * )
  89.  * @CompanyCustomizable
  90.  * @ApiFilter(SearchFilter::class, properties={"type"})
  91.  * @ApiFilter(PropertyFilter::class, 
  92.  *      arguments={
  93.  *          "parameterName"="fields", 
  94.  *          "overrideDefaultProperties"=true
  95.  *     }
  96.  * )
  97.  */
  98. class Slide
  99. {
  100.     const LOGIN_TYPE = 'login_page';
  101.     const HOMEPAGE_TYPE = 'homepage_slide';
  102.     const CHANNEL_TYPE = 'channel_slide';
  103.     const TYPES = [
  104.         self::LOGIN_TYPE,
  105.         self::HOMEPAGE_TYPE,
  106.         self::CHANNEL_TYPE
  107.     ];
  109.     /**
  110.      * @ORM\Id
  111.      * @ORM\GeneratedValue
  112.      * @ORM\Column(type="integer")
  113.      * @Groups({"slide:read", "slide:read:id"})
  114.      */
  115.     private $id;
  117.     /**
  118.      * @ORM\Column(type="string", length=255)
  119.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:name"})
  120.      */
  121.     private $name;
  123.     /**
  124.      * @ORM\Column(type="boolean", options={"default": "1"})
  125.      * @Groups({"slide:read", "slide:write", "slide:read:active"})
  126.      */
  127.     private $active = true;
  129.     /**
  130.      * @ORM\Column(type="datetime")
  131.      * @Gedmo\Timestampable(on="create")
  132.      * @Groups({"slide:read", "slide:read:createdAt"})
  133.      */
  134.     private $createdAt;
  136.     /**
  137.      * @ORM\Column(type="datetime", nullable=true)
  138.      * @Gedmo\Timestampable(on="update")
  139.      * @Groups({"slide:read", "slide:read:updatedAt"})
  140.      */
  141.     private $updatedAt;
  143.     /**
  144.      * Order on the slides, auto increment or any if the order is not important
  145.      * @Assert\NotBlank
  146.      * @ORM\Column(name="`rank`", type="integer")
  147.      * @Groups({"slide:read", "slide:write", "slide:read:rank"})
  148.      */
  149.     private $rank = 1;
  151.     /**
  152.      * This is used for the customisation in the login page
  153.      * @ORM\ManyToOne(targetEntity=MediaObject::class)
  154.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:image"})
  155.      */
  156.     private $image;
  158.     /**
  159.      * Defines the origin of the slide in witch page will it be displayed
  160.      * (ex: a type 'homepage_slide' is a slide to be displayed in an HP)
  161.      * @ORM\Column(type="string", length=255, nullable=true)
  162.      * @Groups({"slide:read", "slide:write", "slide:read:type"})
  163.      * @Assert\Choice(choices=self::TYPES)
  164.      */
  165.     private $type;
  167.     /**
  168.      * This can be either the channel it is linked to if type is homepage
  169.      * (ex: one of the HP slides but it puts in the spot a particular channel),
  170.      * or the channel it belong to (example: this is the 5th slider in the "XXX" channel)
  171.      * @ORM\ManyToOne(targetEntity=Channel::class, inversedBy="slides")
  172.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:channel"})
  173.      */
  174.     private $channel;
  176.     /**
  177.      * This is a video to be put on the spot in this slide
  178.      * @ORM\ManyToOne(targetEntity=Video::class)
  179.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:video"})
  180.      */
  181.     private $video;
  183.     /**
  184.      * Label of the button to be displayed
  185.      * @ORM\Column(type="string", length=255, nullable=true)
  186.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:linkLabel"})
  187.      */
  188.     private $linkLabel;
  190.     /**
  191.      * @ORM\ManyToOne(targetEntity=Category::class, inversedBy="slides")
  192.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:category"})
  193.      */
  194.     private $category;
  196.     /**
  197.      * @ORM\ManyToOne(targetEntity=Program::class, inversedBy="slides")
  198.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:program"})
  199.      */
  200.     private $program;
  202.     /**
  203.      * @ORM\ManyToOne(targetEntity=TvCompany::class, inversedBy="slides")
  204.      */
  205.     private $tvCompany;
  207.     /**
  208.      * @ORM\ManyToOne(targetEntity=Company::class, inversedBy="slides")
  209.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:company"})
  210.      */
  211.     private $company;
  213.     /**
  214.      * @ORM\ManyToOne(targetEntity=Slide::class, inversedBy="children")
  215.      */
  216.     private $parent;
  218.     /**
  219.      * @ORM\OneToMany(targetEntity=Slide::class, mappedBy="parent")
  220.      */
  221.     private $children;
  223.     /**
  224.      * @ORM\Column(type="string", length=255, nullable=true)
  225.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:linkUrl"})
  226.      */
  227.     private $linkUrl;
  229.     /**
  230.      * @ORM\Column(type="string", length=500, nullable=true)
  231.      * @Groups({"slide:read", "slide:write", "slide_slug:read", "slide:read:content"})
  232.      */
  233.     private $content;
  235.     public function __construct()
  236.     {
  237.         $this->children = new ArrayCollection();
  238.         $this->rank = 1;
  239.     }
  242.     public function getId(): ?int
  243.     {
  244.         return $this->id;
  245.     }
  247.     public function setId(?int $id): self
  248.     {
  249.         $this->id = $id;
  251.         return $this;
  252.     }
  254.     public function getName(): ?string
  255.     {
  256.         return $this->name;
  257.     }
  259.     public function setName(string $name): self
  260.     {
  261.         $this->name = $name;
  263.         return $this;
  264.     }
  266.     public function getActive(): ?bool
  267.     {
  268.         return $this->active;
  269.     }
  271.     public function setActive(bool $active): self
  272.     {
  273.         $this->active = $active;
  275.         return $this;
  276.     }
  278.     public function getCreatedAt(): ?\DateTimeInterface
  279.     {
  280.         return $this->createdAt;
  281.     }
  283.     public function setCreatedAt(\DateTimeInterface $createdAt): self
  284.     {
  285.         $this->createdAt = $createdAt;
  287.         return $this;
  288.     }
  290.     public function getUpdatedAt(): ?\DateTimeInterface
  291.     {
  292.         return $this->updatedAt;
  293.     }
  295.     public function setUpdatedAt(\DateTimeInterface $updatedAt): self
  296.     {
  297.         $this->updatedAt = $updatedAt;
  299.         return $this;
  300.     }
  302.     public function getRank(): ?int
  303.     {
  304.         return $this->rank;
  305.     }
  307.     public function setRank(int $rank): self
  308.     {
  309.         $this->rank = $rank;
  311.         return $this;
  312.     }
  314.     public function getImage(): ?MediaObject
  315.     {
  316.         return $this->image;
  317.     }
  319.     public function setImage(?MediaObject $image): self
  320.     {
  321.         $this->image = $image;
  323.         return $this;
  324.     }
  326.     /**
  327.      * @Groups({"slide:write"})
  328.      */
  329.     public function setImageFile($file = null): self
  330.     {
  331.         if($file instanceof UploadedFile) {
  332.             $image = empty($this->image) ? new MediaObject : $this->image;
  333.             $image->setFile($file);
  334.             $this->setImage($image);
  335.         }
  337.         return $this;
  338.     }
  340.     public function getVideo(): ?Video
  341.     {
  342.         return $this->video;
  343.     }
  345.     public function setVideo(?Video $video): self
  346.     {
  347.         $this->video = $video;
  349.         return $this;
  350.     }
  352.     public function getType(): ?string
  353.     {
  354.         return $this->type;
  355.     }
  357.     public function setType(?string $type): self
  358.     {
  359.         $this->type = $type;
  361.         return $this;
  362.     }
  364.     public function getChannel(): ?Channel
  365.     {
  366.         return $this->channel;
  367.     }
  369.     public function setChannel(?Channel $channel): self
  370.     {
  371.         $this->channel = $channel;
  373.         return $this;
  374.     }
  376.     public function getLinkLabel(): ?string
  377.     {
  378.         return $this->linkLabel;
  379.     }
  381.     public function setLinkLabel(?string $linkLabel): self
  382.     {
  383.         $this->linkLabel = $linkLabel;
  385.         return $this;
  386.     }
  388.     public function getCategory(): ?Category
  389.     {
  390.         return $this->category;
  391.     }
  393.     public function setCategory(?Category $category): self
  394.     {
  395.         $this->category = $category;
  397.         return $this;
  398.     }
  400.     public function getProgram(): ?Program
  401.     {
  402.         return $this->program;
  403.     }
  405.     public function setProgram(?Program $program): self
  406.     {
  407.         $this->program = $program;
  409.         return $this;
  410.     }
  412.     public function getTvCompany(): ?TvCompany
  413.     {
  414.         return $this->tvCompany;
  415.     }
  417.     public function setTvCompany(?TvCompany $tvCompany): self
  418.     {
  419.         $this->tvCompany = $tvCompany;
  421.         return $this;
  422.     }
  424.     public function getCompany(): ?Company
  425.     {
  426.         return $this->company;
  427.     }
  429.     public function setCompany(?Company $company): self
  430.     {
  431.         $this->company = $company;
  433.         return $this;
  434.     }
  436.     public function getParent(): ?self
  437.     {
  438.         return $this->parent;
  439.     }
  441.     public function setParent(?self $parent): self
  442.     {
  443.         $this->parent = $parent;
  445.         return $this;
  446.     }
  448.     /**
  449.      * @return Collection|self[]
  450.      */
  451.     public function getChildren(): Collection
  452.     {
  453.         return $this->children;
  454.     }
  456.     public function addChild(self $child): self
  457.     {
  458.         if (!$this->children->contains($child)) {
  459.             $this->children[] = $child;
  460.             $child->setParent($this);
  461.         }
  463.         return $this;
  464.     }
  466.     public function removeChild(self $child): self
  467.     {
  468.         if ($this->children->removeElement($child)) {
  469.             // set the owning side to null (unless already changed)
  470.             if ($child->getParent() === $this) {
  471.                 $child->setParent(null);
  472.             }
  473.         }
  475.         return $this;
  476.     }
  478.     public function getLinkUrl(): ?string
  479.     {
  480.         return $this->linkUrl;
  481.     }
  483.     public function setLinkUrl(?string $linkUrl): self
  484.     {
  485.         $this->linkUrl = $linkUrl;
  487.         return $this;
  488.     }
  490.     public function getContent(): ?string
  491.     {
  492.         return $this->content;
  493.     }
  495.     public function setContent(?string $content): self
  496.     {
  497.         $this->content = $content;
  499.         return $this;
  500.     }
  501. }