src/Entity/CommonCategory.php line 66

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Annotation\EsUploadable;
  6. use Doctrine\ORM\Mapping as ORM;
  7. use ApiPlatform\Core\Annotation\ApiFilter;
  8. use App\Entity\Traits\TimestampableEntity;
  9. use Doctrine\Common\Collections\Collection;
  10. use ApiPlatform\Core\Annotation\ApiProperty;
  11. use ApiPlatform\Core\Annotation\ApiResource;
  12. use App\Repository\CommonCategoryRepository;
  13. use App\Entity\Interfaces\OrderMappedInterface;
  14. use App\Entity\Interfaces\ClientMappedInterface;
  15. use App\Entity\Interfaces\UploadMappedInterface;
  16. use Doctrine\Common\Collections\ArrayCollection;
  17. use Symfony\Component\Serializer\Annotation\Groups;
  18. use Symfony\Component\Validator\Constraints as Assert;
  19. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
  20. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\ExistsFilter;
  21. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
  22. use Locastic\ApiPlatformTranslationBundle\Model\AbstractTranslatable;
  23. use Locastic\ApiPlatformTranslationBundle\Model\TranslationInterface;
  25. /**
  26.  * @ORM\Entity(repositoryClass=CommonCategoryRepository::class)
  27.  */
  28. /**
  29.  * @ApiResource(
  30.  *      attributes={"security"="is_granted('ROLE_OPERATOR')", "filters"={"translation.groups"}},
  31.  *      normalizationContext={"groups"={"CommonCategory:Read"}, "skip_null_values"=false},
  32.  *      denormalizationContext={"groups"={"CommonCategory:Write"}},
  33.  *      collectionOperations={
  34.  *          "get"={"security"="is_granted('IS_AUTHENTICATED_FULLY')"},
  35.  *          "get_for_public_page"={
  36.  *              "route_name"="api_pub_common_categories_tags_get_for_public_page_collection",
  37.  *              "method"="GET",
  38.  *              "security"="is_granted('PUBLIC_ACCESS')",
  39.  *              "normalization_context"={"groups"={"CommonCategory:PRead"}, "skip_null_values"=false}
  40.  *          },
  41.  *          "post"
  42.  *      },
  43.  *      itemOperations={
  44.  *          "get"={"security"="is_granted('IS_CLIENT_OPR', object)"},
  45.  *          "put"={"security"="is_granted('IS_CLIENT_OPR', object)"},
  46.  *          "patch"={"security"="is_granted('IS_CLIENT_OPR', object)"},
  47.  *          "patch_change_ord"={
  48.  *              "path"="/common_categories/{id}/change-ord",
  49.  *              "method"="PATCH",
  50.  *              "denormalization_context"={"groups"={"CommonCategory:ChangeOrd"}},
  51.  *              "security"="is_granted('IS_CLIENT_OPR', object)"
  52.  *          },
  53.  *          "delete"={"security"="is_granted('IS_CLIENT_OPR', object)"}
  54.  *     }
  55.  * )
  56.  * @ApiFilter(SearchFilter::class, properties={"id": "exact", "client.id": "exact", "type": "exact", "translations.name": "partial", "parent.id": "exact"})
  57.  * @ApiFilter(OrderFilter::class, properties={"ord": "ASC", "translations.name", "id", "parent.id"})
  58.  * @ApiFilter(ExistsFilter::class, properties={"parent"})
  59.  * @ORM\Entity(repositoryClass=CommonCategoryRepository::class)
  60.  * @ORM\Table(
  61.  *      indexes={
  62.  *          @ORM\Index(name="common_category_type_idx", columns={"type"})
  63.  *      }
  64.  * )
  65.  */
  66. class CommonCategory extends AbstractTranslatable implements ClientMappedInterface, OrderMappedInterface, UploadMappedInterface
  67. {
  68.     /**
  69.      * Hook timestampable behavior
  70.      * updates createdAt, updatedAt fields
  71.      */
  72.     use TimestampableEntity;
  73.     public const CGR = [
  74.         "CommonCategory:Read", "CommonCategory:PRead",
  75.         "Container:ReadSecure", "Container:Storage", "Container:PRead", "Container:Overview",
  76.         "Conference:Read", "Conference:PRead",
  77.         "Session:Read", "Session:GetItemDetail", "Session:PRead", "Session:Agenda", "Session:Read-Watched", "Session:VideoGallery",
  78.         "ElCourse:Read", "ElCourse:PRead",
  79.         "ElLession:Detail",
  80.         "ElTask:Detail",
  81.         "Newsfeed:Read",
  82.         "VideoGallery:Read", "VideoGallery:PRead", "VideoGallery:Read-Public",
  83.         "User:Read", "User:Write", "User:Me", "User:Attendee-List", "User:Attendee-List-O", "User:Change-Profile", "User:Get-Limited", "User:PRead", "User:Exp",
  84.         "DocFile:Read",
  85.         "InfoPage:Read",
  86.         "Company:Read", "Company:PRead",
  87.     ];
  88.     public const CG = [
  89.         ...self::CGR,
  90.         "CommonCategory:Write",
  91.         "User:Write"
  92.     ];
  93.     public const ECG = [
  94.         ...self::CG,
  95.         "Conference:EL", "Session:EL", "VideoGallery:EL", "ElCourse:EL", "Newsfeed:EL", "User:EL"
  96.     ];
  98.     /**
  99.      * @ORM\OneToMany(targetEntity="CommonCategoryTranslation", mappedBy="translatable", fetch="EXTRA_LAZY", indexBy="locale", cascade={"PERSIST"}, orphanRemoval=true)
  100.      *
  101.      * @Groups({"Conference:EL", "Session:EL", "VideoGallery:EL", "ElCourse:EL", "Newsfeed:EL", "User:EL", "CommonCategory:Write", "CommonCategoryTranslationGroup", "CommonCategory:PRead"})
  102.      * @Assert\Valid()
  103.      */
  104.     protected $translations;
  106.     /**
  107.      * @Groups(self::CG)
  108.      */
  109.     private $name;
  111.     /**
  112.      * @ORM\Id
  113.      * @ORM\GeneratedValue
  114.      * @ORM\Column(type="integer")
  115.      * @Groups(self::CGR)
  116.      */
  117.     private $id;
  119.     /**
  120.      * @ORM\ManyToOne(targetEntity=Client::class)
  121.      * @ORM\JoinColumn(nullable=false, onDelete="CASCADE")
  122.      * @Groups({"CommonCategory:Write"})
  123.      */
  124.     private $client;
  126.     /**
  127.      * @ORM\Column(type="string", length=16, nullable=true)
  128.      * @Groups(self::ECG)
  129.      */
  130.     private $color;
  132.     /**
  133.      * @ORM\Column(type="string", length=16, nullable=true)
  134.      * @Groups(self::ECG)
  135.      */
  136.     private $textColor;
  138.     /**
  139.      * @ORM\Column(type="integer", nullable=true)
  140.      * @Groups(self::CG)
  141.      */
  142.     private $ord;
  144.     /**
  145.      * @Groups({"CommonCategory:ChangeOrd"})
  146.      */
  147.     private int $newOrd;
  149.     private $ordChangeDirection;
  151.     /**
  152.      * @ORM\Column(type="string", length=32)
  153.      * @Groups(self::CG)
  154.      */
  155.     private $type;
  157.     /**
  158.      * @ORM\Column(type="string", length=255, nullable=true)
  159.      * @Groups(self::ECG)
  160.      *
  161.      * @Assert\Length(max=255, maxMessage="validation.commonCategory:imageName.max")
  162.      * @EsUploadable()
  163.      */
  164.     private $imageName;
  166.     /**
  167.      * @ORM\ManyToOne(targetEntity=CommonCategory::class, inversedBy="childrens")
  168.      * @ORM\JoinColumn(nullable=true, onDelete="CASCADE")
  169.      * @Groups(self::CG)
  170.      * @ApiProperty(readableLink=false, writableLink=false)
  171.      */
  172.     private $parent;
  174.     /**
  175.      * @ORM\OneToMany(targetEntity=CommonCategory::class, mappedBy="parent")
  176.      * @Groups(self::CGR)
  177.      */
  178.     private $childrens;
  180.     /**
  181.      * @ORM\OneToMany(targetEntity=SpecialTitle::class, mappedBy="newsfeedCategory")
  182.      */
  183.     private $specialTitles;
  185.     /**
  186.      * @ORM\ManyToMany(targetEntity=User::class, mappedBy="newsfeedSubscriptions")
  187.      */
  188.     private $newsfeedSubscribedUsers;
  190.     public function __construct()
  191.     {
  192.         parent::__construct();
  193.         $this->childrens = new ArrayCollection();
  194.         $this->specialTitles = new ArrayCollection();
  195.         $this->newsfeedSubscribedUsers = new ArrayCollection();
  196.     }
  198.     public const CATEGORYTYPE_CONTAINER = "CONTAINER";
  199.     public const CATEGORYTYPE_CONFERENCE = "CONFERENCE";
  200.     public const CATEGORYTYPE_SESSION = "SESSION";
  201.     public const CATEGORYTYPE_VIDEOGALLERY = "VIDEOGALLERY";
  202.     public const CATEGORYTYPE_COURSE = "COURSE";
  203.     public const CATEGORYTYPE_NEWSFEED = "NEWSFEED";
  204.     public const CATEGORYTYPE_DOCFILE = "DOCFILE";
  205.     public const CATEGORYTYPE_INFOPAGE = "INFOPAGE";
  206.     public const CATEGORYTYPE_USER = "USER";
  207.     public const CATEGORYTYPE_COMPANY = "COMPANY";
  209.     protected function createTranslation(): TranslationInterface
  210.     {
  211.         return new CommonCategoryTranslation();
  212.     }
  214.     public function addTranslation(TranslationInterface $translation): void
  215.     {
  216.         $this->setUpdatedAt(new \DateTime());
  217.         parent::addTranslation($translation);
  218.     }
  220.     public function getName(): ?string
  221.     {
  222.         return $this->getTranslation()->getName();
  223.     }
  225.     public function setName(string $name): self
  226.     {
  227.         $this->getTranslation()->setName($name);
  229.         return $this;
  230.     }
  232.     public function getId(): ?int
  233.     {
  234.         return $this->id;
  235.     }
  237.     public function getClient(): ?Client
  238.     {
  239.         return $this->client;
  240.     }
  242.     public function setClient(?Client $client): self
  243.     {
  244.         $this->client = $client;
  246.         return $this;
  247.     }
  249.     public function getColor(): ?string
  250.     {
  251.         return $this->color;
  252.     }
  254.     public function setColor(?string $color): self
  255.     {
  256.         $this->color = $color;
  258.         return $this;
  259.     }
  261.     public function getTextColor(): ?string
  262.     {
  263.         return $this->textColor;
  264.     }
  266.     public function setTextColor(?string $textColor): self
  267.     {
  268.         $this->textColor = $textColor;
  270.         return $this;
  271.     }
  273.     public function getOrd(): ?int
  274.     {
  275.         return $this->ord;
  276.     }
  278.     public function setOrd(?int $ord): self
  279.     {
  280.         $this->ord = $ord;
  282.         return $this;
  283.     }
  285.     public function getOrdParents(): array
  286.     {
  287.         return [
  288.             'client' => $this->getClient(),
  289.             'type' => $this->getType()
  290.         ];
  291.     }
  293.     public function getOrdChangeDirection()
  294.     {
  295.         return $this->ordChangeDirection;
  296.     }
  298.     public function getNewOrd(): int
  299.     {
  300.         return $this->newOrd ?? 0;
  301.     }
  303.     public function setNewOrd(int $newOrd): self
  304.     {
  305.         $oldOrd = $this->ord;
  306.         $this->newOrd = $newOrd;
  307.         $this->ord = $newOrd;
  308.         $this->ordChangeDirection = ($this->newOrd < $oldOrd) ? 'desc' : 'asc';
  310.         return $this;
  311.     }
  313.     public function getType(): ?string
  314.     {
  315.         return $this->type;
  316.     }
  318.     public function setType(string $type): self
  319.     {
  320.         $this->type = $type;
  322.         return $this;
  323.     }
  325.     public function getImageName(): ?string
  326.     {
  327.         return $this->imageName;
  328.     }
  330.     public function setImageName(?string $imageName): self
  331.     {
  332.         $this->imageName = $imageName;
  334.         return $this;
  335.     }
  337.     public function getAllTranslation()
  338.     {
  339.         $translations = [];
  340.         foreach ($this->getTranslations() as $translation) {
  341.             $translations[] = [
  342.                 $translation->getLocale() => [
  343.                     'name' => $translation->getName()
  344.                 ]
  345.             ];
  346.         }
  347.         return $translations;
  348.     }
  350.     public function getMeta()
  351.     {
  352.         $meta = [
  353.             'translations' => $this->getAllTranslation(),
  354.             'color' => $this->getColor(),
  355.             'textColor' => $this->getTextColor()
  356.         ];
  357.         return $meta;
  358.     }
  360.     public function getQueueInfo(): array
  361.     {
  362.         return [
  363.             'type' => 'CommonCategory',
  364.             'id' => $this->getId(),
  365.             'categoryType' => $this->getType()
  366.         ];
  367.     }
  369.     public function getParent(): ?self
  370.     {
  371.         return $this->parent;
  372.     }
  374.     public function setParent(?self $parent): self
  375.     {
  376.         $this->parent = $parent;
  378.         return $this;
  379.     }
  381.     /**
  382.      * @return Collection<int, self>
  383.      */
  384.     public function getChildrens(): Collection
  385.     {
  386.         return $this->childrens;
  387.     }
  389.     public function addChildren(self $children): self
  390.     {
  391.         if (!$this->childrens->contains($children)) {
  392.             $this->childrens[] = $children;
  393.             $children->setParent($this);
  394.         }
  396.         return $this;
  397.     }
  399.     public function removeChildren(self $children): self
  400.     {
  401.         if ($this->childrens->removeElement($children)) {
  402.             // set the owning side to null (unless already changed)
  403.             if ($children->getParent() === $this) {
  404.                 $children->setParent(null);
  405.             }
  406.         }
  408.         return $this;
  409.     }
  411.     /**
  412.      * @return Collection<int, SpecialTitle>
  413.      */
  414.     public function getSpecialTitles(): Collection
  415.     {
  416.         return $this->specialTitles;
  417.     }
  419.     public function addSpecialTitle(SpecialTitle $specialTitle): self
  420.     {
  421.         if (!$this->specialTitles->contains($specialTitle)) {
  422.             $this->specialTitles[] = $specialTitle;
  423.             $specialTitle->setNewsfeedCategory($this);
  424.         }
  426.         return $this;
  427.     }
  429.     public function removeSpecialTitle(SpecialTitle $specialTitle): self
  430.     {
  431.         if ($this->specialTitles->removeElement($specialTitle)) {
  432.             // set the owning side to null (unless already changed)
  433.             if ($specialTitle->getNewsfeedCategory() === $this) {
  434.                 $specialTitle->setNewsfeedCategory(null);
  435.             }
  436.         }
  438.         return $this;
  439.     }
  441.     /**
  442.      * @return Collection<int, User>
  443.      */
  444.     public function getNewsfeedSubscribedUsers(): Collection
  445.     {
  446.         return $this->newsfeedSubscribedUsers;
  447.     }
  449.     public function addNewsfeedSubscribedUser(User $newsfeedSubscribedUser): self
  450.     {
  451.         if (!$this->newsfeedSubscribedUsers->contains($newsfeedSubscribedUser)) {
  452.             $this->newsfeedSubscribedUsers[] = $newsfeedSubscribedUser;
  453.             $newsfeedSubscribedUser->addNewsfeedSubscription($this);
  454.         }
  456.         return $this;
  457.     }
  459.     public function removeNewsfeedSubscribedUser(User $newsfeedSubscribedUser): self
  460.     {
  461.         if ($this->newsfeedSubscribedUsers->removeElement($newsfeedSubscribedUser)) {
  462.             $newsfeedSubscribedUser->removeNewsfeedSubscription($this);
  463.         }
  465.         return $this;
  466.     }
  467. }