vendor/sulu/sulu/src/Sulu/Bundle/MediaBundle/Entity/Collection.php line 23

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\MediaBundle\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection as DoctrineCollection;
  16. use JMS\Serializer\Annotation\Exclude;
  17. use Sulu\Bundle\SecurityBundle\Entity\PermissionInheritanceInterface;
  18. use Sulu\Component\Security\Authentication\UserInterface;
  20. /**
  21.  * Collection.
  22.  */
  23. class Collection implements CollectionInterface, PermissionInheritanceInterface
  24. {
  25.     /**
  26.      * @var int
  27.      */
  28.     protected $id;
  30.     /**
  31.      * @var string|null
  32.      */
  33.     protected $style;
  35.     /**
  36.      * @var int
  37.      *
  38.      * @Exclude
  39.      */
  40.     protected $lft;
  42.     /**
  43.      * @var int
  44.      *
  45.      * @Exclude
  46.      */
  47.     protected $rgt;
  49.     /**
  50.      * @var int
  51.      *
  52.      * @Exclude
  53.      */
  54.     protected $depth;
  56.     /**
  57.      * @var \DateTime
  58.      */
  59.     protected $created;
  61.     /**
  62.      * @var \DateTime
  63.      */
  64.     protected $changed;
  66.     /**
  67.      * @var CollectionType
  68.      */
  69.     protected $type;
  71.     /**
  72.      * @var UserInterface|null
  73.      *
  74.      * @Exclude
  75.      */
  76.     protected $changer;
  78.     /**
  79.      * @var UserInterface|null
  80.      *
  81.      * @Exclude
  82.      */
  83.     protected $creator;
  85.     /**
  86.      * @var string|null
  87.      */
  88.     private $key;
  90.     /**
  91.      * @var DoctrineCollection<int, CollectionMeta>
  92.      */
  93.     private $meta;
  95.     /**
  96.      * @var DoctrineCollection<int, MediaInterface>
  97.      *
  98.      * @Exclude
  99.      */
  100.     private $media;
  102.     /**
  103.      * @var DoctrineCollection<int, CollectionInterface>
  104.      */
  105.     private $children;
  107.     /**
  108.      * @var CollectionInterface|null
  109.      */
  110.     private $parent;
  112.     /**
  113.      * @var CollectionMeta
  114.      */
  115.     private $defaultMeta;
  117.     public function __construct()
  118.     {
  119.         $this->meta = new ArrayCollection();
  120.         $this->media = new ArrayCollection();
  121.         $this->children = new ArrayCollection();
  122.     }
  124.     /**
  125.      * Get id.
  126.      *
  127.      * @return int
  128.      */
  129.     public function getId()
  130.     {
  131.         return $this->id;
  132.     }
  134.     /**
  135.      * Set changer.
  136.      *
  137.      * @return CollectionInterface
  138.      */
  139.     public function setChanger(UserInterface $changer = null)
  140.     {
  141.         $this->changer = $changer;
  143.         return $this;
  144.     }
  146.     /**
  147.      * Get changer.
  148.      *
  149.      * @return UserInterface|null
  150.      */
  151.     public function getChanger()
  152.     {
  153.         return $this->changer;
  154.     }
  156.     /**
  157.      * Set creator.
  158.      *
  159.      * @return CollectionInterface
  160.      */
  161.     public function setCreator(UserInterface $creator = null)
  162.     {
  163.         $this->creator = $creator;
  165.         return $this;
  166.     }
  168.     /**
  169.      * Get creator.
  170.      *
  171.      * @return UserInterface|null
  172.      */
  173.     public function getCreator()
  174.     {
  175.         return $this->creator;
  176.     }
  178.     /**
  179.      * Set style.
  180.      *
  181.      * @param string|null $style
  182.      *
  183.      * @return CollectionInterface
  184.      */
  185.     public function setStyle($style)
  186.     {
  187.         $this->style = $style;
  189.         return $this;
  190.     }
  192.     /**
  193.      * Get style.
  194.      *
  195.      * @return string|null
  196.      */
  197.     public function getStyle()
  198.     {
  199.         return $this->style;
  200.     }
  202.     /**
  203.      * Set lft.
  204.      *
  205.      * @param int $lft
  206.      *
  207.      * @return CollectionInterface
  208.      */
  209.     public function setLft($lft)
  210.     {
  211.         $this->lft = $lft;
  213.         return $this;
  214.     }
  216.     /**
  217.      * Get lft.
  218.      *
  219.      * @return int
  220.      */
  221.     public function getLft()
  222.     {
  223.         return $this->lft;
  224.     }
  226.     /**
  227.      * Set rgt.
  228.      *
  229.      * @param int $rgt
  230.      *
  231.      * @return CollectionInterface
  232.      */
  233.     public function setRgt($rgt)
  234.     {
  235.         $this->rgt = $rgt;
  237.         return $this;
  238.     }
  240.     /**
  241.      * Get rgt.
  242.      *
  243.      * @return int
  244.      */
  245.     public function getRgt()
  246.     {
  247.         return $this->rgt;
  248.     }
  250.     /**
  251.      * Set depth.
  252.      *
  253.      * @param int $depth
  254.      *
  255.      * @return CollectionInterface
  256.      */
  257.     public function setDepth($depth)
  258.     {
  259.         $this->depth = $depth;
  261.         return $this;
  262.     }
  264.     /**
  265.      * Get depth.
  266.      *
  267.      * @return int
  268.      */
  269.     public function getDepth()
  270.     {
  271.         return $this->depth;
  272.     }
  274.     /**
  275.      * Get created.
  276.      *
  277.      * @return \DateTime
  278.      */
  279.     public function getCreated()
  280.     {
  281.         return $this->created;
  282.     }
  284.     /**
  285.      * Get changed.
  286.      *
  287.      * @return \DateTime
  288.      */
  289.     public function getChanged()
  290.     {
  291.         return $this->changed;
  292.     }
  294.     /**
  295.      * @return $this
  296.      */
  297.     public function setCreated(\DateTime $created)
  298.     {
  299.         $this->created = $created;
  301.         return $this;
  302.     }
  304.     /**
  305.      * @return $this
  306.      */
  307.     public function setChanged(\DateTime $changed)
  308.     {
  309.         $this->changed = $changed;
  311.         return $this;
  312.     }
  314.     /**
  315.      * Set type.
  316.      *
  317.      * @return CollectionInterface
  318.      */
  319.     public function setType(CollectionType $type)
  320.     {
  321.         $this->type = $type;
  323.         return $this;
  324.     }
  326.     /**
  327.      * Get type.
  328.      *
  329.      * @return CollectionType
  330.      */
  331.     public function getType()
  332.     {
  333.         return $this->type;
  334.     }
  336.     /**
  337.      * Set key.
  338.      *
  339.      * @return string|null
  340.      */
  341.     public function getKey()
  342.     {
  343.         return $this->key;
  344.     }
  346.     /**
  347.      * Get key.
  348.      *
  349.      * @param string|null $key
  350.      *
  351.      * @return CollectionInterface
  352.      */
  353.     public function setKey($key)
  354.     {
  355.         $this->key = $key;
  357.         return $this;
  358.     }
  360.     /**
  361.      * @return DoctrineCollection<int, self>
  362.      */
  363.     public function getChildren()
  364.     {
  365.         return $this->children;
  366.     }
  368.     public function setChildren(DoctrineCollection $children)
  369.     {
  370.         $this->children = $children;
  371.     }
  373.     /**
  374.      * Set parent.
  375.      *
  376.      * @return CollectionInterface
  377.      */
  378.     public function setParent(CollectionInterface $parent = null)
  379.     {
  380.         $this->parent = $parent;
  382.         return $this;
  383.     }
  385.     /**
  386.      * Get parent.
  387.      *
  388.      * @return CollectionInterface|null
  389.      */
  390.     public function getParent()
  391.     {
  392.         return $this->parent;
  393.     }
  395.     /**
  396.      * @return int|null
  397.      */
  398.     public function getParentId()
  399.     {
  400.         if ($this->parent) {
  401.             return $this->parent->getId();
  402.         }
  404.         return null;
  405.     }
  407.     /**
  408.      * Add meta.
  409.      *
  410.      * @return Collection
  411.      */
  412.     public function addMeta(CollectionMeta $meta)
  413.     {
  414.         $this->meta[] = $meta;
  416.         return $this;
  417.     }
  419.     /**
  420.      * Remove meta.
  421.      *
  422.      * @return void
  423.      */
  424.     public function removeMeta(CollectionMeta $meta)
  425.     {
  426.         $this->meta->removeElement($meta);
  427.     }
  429.     /**
  430.      * Get meta.
  431.      *
  432.      * @return DoctrineCollection<int, CollectionMeta>
  433.      */
  434.     public function getMeta()
  435.     {
  436.         return $this->meta;
  437.     }
  439.     /**
  440.      * Add media.
  441.      *
  442.      * @return Collection
  443.      */
  444.     public function addMedia(MediaInterface $media)
  445.     {
  446.         $this->media[] = $media;
  448.         return $this;
  449.     }
  451.     /**
  452.      * Remove media.
  453.      *
  454.      * @return void
  455.      */
  456.     public function removeMedia(MediaInterface $media)
  457.     {
  458.         $this->media->removeElement($media);
  459.     }
  461.     /**
  462.      * Get media.
  463.      *
  464.      * @return DoctrineCollection<int, MediaInterface>
  465.      */
  466.     public function getMedia()
  467.     {
  468.         return $this->media;
  469.     }
  471.     /**
  472.      * Add children.
  473.      *
  474.      * @return Collection
  475.      */
  476.     public function addChildren(CollectionInterface $children)
  477.     {
  478.         $this->children[] = $children;
  480.         return $this;
  481.     }
  483.     /**
  484.      * Remove children.
  485.      *
  486.      * @return void
  487.      */
  488.     public function removeChildren(CollectionInterface $children)
  489.     {
  490.         $this->children->removeElement($children);
  491.     }
  493.     /**
  494.      * Set defaultMeta.
  495.      *
  496.      * @param CollectionMeta $defaultMeta
  497.      *
  498.      * @return Collection
  499.      */
  500.     public function setDefaultMeta(CollectionMeta $defaultMeta = null)
  501.     {
  502.         $this->defaultMeta = $defaultMeta;
  504.         return $this;
  505.     }
  507.     /**
  508.      * Get defaultMeta.
  509.      *
  510.      * @return CollectionMeta
  511.      */
  512.     public function getDefaultMeta()
  513.     {
  514.         return $this->defaultMeta;
  515.     }
  517.     public function getSecurityContext()
  518.     {
  519.         return 'sulu.media.collections';
  520.     }
  521. }