vendor/sulu/sulu/src/Sulu/Bundle/TrashBundle/Domain/Model/TrashItem.php line 29

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Sulu.
  7.  *
  8.  * (c) Sulu GmbH
  9.  *
  10.  * This source file is subject to the MIT license that is bundled
  11.  * with this source code in the file LICENSE.
  12.  */
  14. namespace Sulu\Bundle\TrashBundle\Domain\Model;
  16. use Doctrine\Common\Collections\ArrayCollection;
  17. use Doctrine\Common\Collections\Collection;
  18. use JMS\Serializer\Annotation\ExclusionPolicy;
  19. use JMS\Serializer\Annotation\Expose;
  20. use JMS\Serializer\Annotation\Groups;
  21. use JMS\Serializer\Annotation\SerializedName;
  22. use JMS\Serializer\Annotation\VirtualProperty;
  23. use Sulu\Bundle\TrashBundle\Domain\Exception\TrashItemTranslationNotFoundException;
  24. use Sulu\Component\Security\Authentication\UserInterface;
  26. /**
  27.  * @ExclusionPolicy("all")
  28.  */
  29. class TrashItem implements TrashItemInterface
  30. {
  31.     /**
  32.      * @Expose
  33.      * @Groups({"trash_item_admin_api"})
  34.      *
  35.      * @var int
  36.      */
  37.     private $id;
  39.     /**
  40.      * @Expose
  41.      * @Groups({"trash_item_admin_api"})
  42.      *
  43.      * @var string
  44.      */
  45.     private $resourceKey;
  47.     /**
  48.      * @Expose
  49.      * @Groups({"trash_item_admin_api"})
  50.      *
  51.      * @var string
  52.      */
  53.     private $resourceId;
  55.     /**
  56.      * @Expose
  57.      * @Groups({"trash_item_admin_api"})
  58.      *
  59.      * @var mixed[]
  60.      */
  61.     private $restoreData = [];
  63.     /**
  64.      * The restoreType can be used to indicate a sub entity.
  65.      *     e.g.: Store and Restore a single translation of a page.
  66.      *          -> "translation".
  67.      *
  68.      * @Expose
  69.      * @Groups({"trash_item_admin_api"})
  70.      *
  71.      * @var string|null
  72.      */
  73.     private $restoreType;
  75.     /**
  76.      * The restoreOptions are used to change behaviour of store and restore handler.
  77.      *     e.g.: Store and Restore a single translation of a page.
  78.      *          -> ["locale" => "en"].
  79.      *
  80.      * @Expose
  81.      * @Groups({"trash_item_admin_api"})
  82.      *
  83.      * @var mixed[]
  84.      */
  85.     private $restoreOptions = [];
  87.     /**
  88.      * @Expose
  89.      * @Groups({"trash_item_admin_api"})
  90.      *
  91.      * @var string|null
  92.      */
  93.     private $resourceSecurityContext;
  95.     /**
  96.      * @Expose
  97.      *
  98.      * @var string|null
  99.      */
  100.     private $resourceSecurityObjectType;
  102.     /**
  103.      * @Expose
  104.      * @Groups({"trash_item_admin_api"})
  105.      *
  106.      * @var string|null
  107.      */
  108.     private $resourceSecurityObjectId;
  110.     /**
  111.      * @Expose
  112.      * @Groups({"trash_item_admin_api"})
  113.      *
  114.      * @var \DateTimeImmutable
  115.      */
  116.     private $storeTimestamp;
  118.     /**
  119.      * @var UserInterface|null
  120.      */
  121.     private $user;
  123.     /**
  124.      * @var Collection<int, TrashItemTranslation>
  125.      */
  126.     private $translations;
  128.     /**
  129.      * @var string|null
  130.      */
  131.     private $defaultLocale;
  133.     public function __construct()
  134.     {
  135.         $this->translations = new ArrayCollection();
  136.         $this->storeTimestamp = new \DateTimeImmutable();
  137.     }
  139.     public function getId(): ?int
  140.     {
  141.         return $this->id;
  142.     }
  144.     public function getResourceKey(): string
  145.     {
  146.         return $this->resourceKey;
  147.     }
  149.     public function setResourceKey(string $resourceKey): TrashItemInterface
  150.     {
  151.         $this->resourceKey = $resourceKey;
  153.         return $this;
  154.     }
  156.     public function getResourceId(): string
  157.     {
  158.         return $this->resourceId;
  159.     }
  161.     public function setResourceId(string $resourceId): TrashItemInterface
  162.     {
  163.         $this->resourceId = $resourceId;
  165.         return $this;
  166.     }
  168.     public function getRestoreData(): array
  169.     {
  170.         return $this->restoreData;
  171.     }
  173.     public function setRestoreData(array $restoreData): TrashItemInterface
  174.     {
  175.         $this->restoreData = $restoreData;
  177.         return $this;
  178.     }
  180.     public function getRestoreType(): ?string
  181.     {
  182.         return $this->restoreType;
  183.     }
  185.     public function setRestoreType(?string $restoreType): TrashItemInterface
  186.     {
  187.         $this->restoreType = $restoreType;
  189.         return $this;
  190.     }
  192.     public function getRestoreOptions(): array
  193.     {
  194.         return $this->restoreOptions;
  195.     }
  197.     public function setRestoreOptions(array $restoreOptions): TrashItemInterface
  198.     {
  199.         $this->restoreOptions = $restoreOptions;
  201.         return $this;
  202.     }
  204.     public function getResourceTitle(?string $locale = null): string
  205.     {
  206.         return $this->getTranslation($locale, true)->getTitle();
  207.     }
  209.     public function setResourceTitle(string $resourceTitle, ?string $locale = null): TrashItemInterface
  210.     {
  211.         if (!$this->hasTranslation($locale)) {
  212.             $translation = new TrashItemTranslation($this, $locale, $resourceTitle);
  213.             $this->addTranslation($translation);
  215.             return $this;
  216.         }
  218.         $translation = $this->getTranslation($locale, false);
  219.         $translation->setTitle($resourceTitle);
  221.         return $this;
  222.     }
  224.     public function getResourceSecurityContext(): ?string
  225.     {
  226.         return $this->resourceSecurityContext;
  227.     }
  229.     public function setResourceSecurityContext(?string $resourceSecurityContext): TrashItemInterface
  230.     {
  231.         $this->resourceSecurityContext = $resourceSecurityContext;
  233.         return $this;
  234.     }
  236.     public function getResourceSecurityObjectType(): ?string
  237.     {
  238.         return $this->resourceSecurityObjectType;
  239.     }
  241.     public function setResourceSecurityObjectType(?string $resourceSecurityObjectType): TrashItemInterface
  242.     {
  243.         $this->resourceSecurityObjectType = $resourceSecurityObjectType;
  245.         return $this;
  246.     }
  248.     public function getResourceSecurityObjectId(): ?string
  249.     {
  250.         return $this->resourceSecurityObjectId;
  251.     }
  253.     public function setResourceSecurityObjectId(?string $resourceSecurityObjectId): TrashItemInterface
  254.     {
  255.         $this->resourceSecurityObjectId = $resourceSecurityObjectId;
  257.         return $this;
  258.     }
  260.     public function getStoreTimestamp(): \DateTimeImmutable
  261.     {
  262.         return $this->storeTimestamp;
  263.     }
  265.     public function setStoreTimestamp(\DateTimeImmutable $storeTimestamp): TrashItemInterface
  266.     {
  267.         $this->storeTimestamp = $storeTimestamp;
  269.         return $this;
  270.     }
  272.     public function getUser(): ?UserInterface
  273.     {
  274.         return $this->user;
  275.     }
  277.     /**
  278.      * @VirtualProperty
  279.      * @SerializedName("userId")
  280.      * @Groups({"trash_item_api"})
  281.      */
  282.     public function getUserId(): ?int
  283.     {
  284.         return $this->user ? $this->user->getId() : null;
  285.     }
  287.     public function setUser(?UserInterface $user): TrashItemInterface
  288.     {
  289.         $this->user = $user;
  291.         return $this;
  292.     }
  294.     public function getTranslation(?string $locale = null, bool $fallback = false): TrashItemTranslation
  295.     {
  296.         /** @var TrashItemTranslation|false $translation */
  297.         $translation = $this->translations->filter(
  298.             function(TrashItemTranslation $translation) use ($locale) {
  299.                 return $translation->getLocale() === $locale;
  300.             }
  301.         )->first();
  303.         if (!$translation && $fallback) {
  304.             $translation = $this->translations->filter(
  305.                 function(TrashItemTranslation $translation) {
  306.                     return $translation->getLocale() === $this->defaultLocale;
  307.                 }
  308.             )->first();
  309.         }
  311.         if (!$translation) {
  312.             throw new TrashItemTranslationNotFoundException($locale);
  313.         }
  315.         return $translation;
  316.     }
  318.     private function hasTranslation(?string $locale): bool
  319.     {
  320.         return !$this->translations->filter(
  321.             function(TrashItemTranslation $translation) use ($locale) {
  322.                 return $translation->getLocale() === $locale;
  323.             }
  324.         )->isEmpty();
  325.     }
  327.     private function addTranslation(TrashItemTranslation $translation): void
  328.     {
  329.         if (0 === $this->translations->count()) {
  330.             $this->defaultLocale = $translation->getLocale();
  331.         }
  333.         $this->translations->add($translation);
  334.     }
  335. }