vendor/sulu/sulu/src/Sulu/Bundle/SecurityBundle/Entity/Group.php line 26

  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\SecurityBundle\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection;
  16. use JMS\Serializer\Annotation\Exclude;
  17. use Sulu\Bundle\CoreBundle\Entity\ApiEntity;
  18. use Sulu\Component\Persistence\Model\AuditableInterface;
  19. use Sulu\Component\Persistence\Model\AuditableTrait;
  20. use Sulu\Component\Security\Authentication\RoleInterface;
  21. use Sulu\Component\Security\Authentication\UserInterface;
  23. /**
  24.  * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  25.  */
  26. class Group extends ApiEntity implements AuditableInterface
  27. {
  28.     use AuditableTrait;
  30.     /**
  31.      * @var int
  32.      *
  33.      * @Exclude
  34.      */
  35.     private $lft;
  37.     /**
  38.      * @var int
  39.      *
  40.      * @Exclude
  41.      */
  42.     private $rgt;
  44.     /**
  45.      * @var int
  46.      *
  47.      * @Exclude
  48.      */
  49.     private $depth;
  51.     /**
  52.      * @var string
  53.      */
  54.     private $name;
  56.     /**
  57.      * @var int
  58.      */
  59.     private $id;
  61.     /**
  62.      * @var Collection<int, self>
  63.      */
  64.     private $children;
  66.     /**
  67.      * @var Collection<int, UserGroup>
  68.      */
  69.     private $userGroups;
  71.     /**
  72.      * @var Group|null
  73.      */
  74.     private $parent;
  76.     /**
  77.      * @var Collection<int, RoleInterface>
  78.      */
  79.     private $roles;
  81.     /**
  82.      * @var UserInterface|null
  83.      *
  84.      * @Exclude
  85.      */
  86.     protected $changer;
  88.     /**
  89.      * @var UserInterface|null
  90.      *
  91.      * @Exclude
  92.      */
  93.     protected $creator;
  95.     public function __construct()
  96.     {
  97.         $this->children = new ArrayCollection();
  98.         $this->userGroups = new ArrayCollection();
  99.         $this->roles = new ArrayCollection();
  100.     }
  102.     /**
  103.      * Set lft.
  104.      *
  105.      * @param int $lft
  106.      *
  107.      * @return Group
  108.      */
  109.     public function setLft($lft)
  110.     {
  111.         $this->lft = $lft;
  113.         return $this;
  114.     }
  116.     /**
  117.      * Get lft.
  118.      *
  119.      * @return int
  120.      */
  121.     public function getLft()
  122.     {
  123.         return $this->lft;
  124.     }
  126.     /**
  127.      * Set rgt.
  128.      *
  129.      * @param int $rgt
  130.      *
  131.      * @return Group
  132.      */
  133.     public function setRgt($rgt)
  134.     {
  135.         $this->rgt = $rgt;
  137.         return $this;
  138.     }
  140.     /**
  141.      * Get rgt.
  142.      *
  143.      * @return int
  144.      */
  145.     public function getRgt()
  146.     {
  147.         return $this->rgt;
  148.     }
  150.     /**
  151.      * Set depth.
  152.      *
  153.      * @param int $depth
  154.      *
  155.      * @return Group
  156.      */
  157.     public function setDepth($depth)
  158.     {
  159.         $this->depth = $depth;
  161.         return $this;
  162.     }
  164.     /**
  165.      * Get depth.
  166.      *
  167.      * @return int
  168.      */
  169.     public function getDepth()
  170.     {
  171.         return $this->depth;
  172.     }
  174.     /**
  175.      * Set name.
  176.      *
  177.      * @param string $name
  178.      *
  179.      * @return Group
  180.      */
  181.     public function setName($name)
  182.     {
  183.         $this->name = $name;
  185.         return $this;
  186.     }
  188.     /**
  189.      * Get name.
  190.      *
  191.      * @return string
  192.      */
  193.     public function getName()
  194.     {
  195.         return $this->name;
  196.     }
  198.     /**
  199.      * Get id.
  200.      *
  201.      * @return int
  202.      */
  203.     public function getId()
  204.     {
  205.         return $this->id;
  206.     }
  208.     /**
  209.      * Add children.
  210.      *
  211.      * @return Group
  212.      */
  213.     public function addChildren(self $children)
  214.     {
  215.         $this->children[] = $children;
  217.         return $this;
  218.     }
  220.     /**
  221.      * Remove children.
  222.      *
  223.      * @return void
  224.      */
  225.     public function removeChildren(self $children)
  226.     {
  227.         $this->children->removeElement($children);
  228.     }
  230.     /**
  231.      * Get children.
  232.      *
  233.      * @return Collection<int, self>
  234.      */
  235.     public function getChildren()
  236.     {
  237.         return $this->children;
  238.     }
  240.     /**
  241.      * Add userGroups.
  242.      *
  243.      * @return Group
  244.      */
  245.     public function addUserGroup(UserGroup $userGroups)
  246.     {
  247.         $this->userGroups[] = $userGroups;
  249.         return $this;
  250.     }
  252.     /**
  253.      * Remove userGroups.
  254.      *
  255.      * @return void
  256.      */
  257.     public function removeUserGroup(UserGroup $userGroups)
  258.     {
  259.         $this->userGroups->removeElement($userGroups);
  260.     }
  262.     /**
  263.      * Get userGroups.
  264.      *
  265.      * @return Collection<int, UserGroup>
  266.      */
  267.     public function getUserGroups()
  268.     {
  269.         return $this->userGroups;
  270.     }
  272.     /**
  273.      * Set parent.
  274.      *
  275.      * @return Group
  276.      */
  277.     public function setParent(self $parent = null)
  278.     {
  279.         $this->parent = $parent;
  281.         return $this;
  282.     }
  284.     /**
  285.      * Get parent.
  286.      *
  287.      * @return Group|null
  288.      */
  289.     public function getParent()
  290.     {
  291.         return $this->parent;
  292.     }
  294.     /**
  295.      * Add roles.
  296.      *
  297.      * @return Group
  298.      */
  299.     public function addRole(RoleInterface $roles)
  300.     {
  301.         $this->roles[] = $roles;
  303.         return $this;
  304.     }
  306.     /**
  307.      * Remove roles.
  308.      *
  309.      * @return void
  310.      */
  311.     public function removeRole(RoleInterface $roles)
  312.     {
  313.         $this->roles->removeElement($roles);
  314.     }
  316.     /**
  317.      * Get roles.
  318.      *
  319.      * @return Collection<int, RoleInterface>
  320.      */
  321.     public function getRoles()
  322.     {
  323.         return $this->roles;
  324.     }
  325. }