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

Open in your IDE?
  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. private $lft;
  36. /**
  37. * @var int
  38. */
  39. #[Exclude]
  40. private $rgt;
  42. /**
  43. * @var int
  44. */
  45. #[Exclude]
  46. private $depth;
  48. /**
  49. * @var string
  50. */
  51. private $name;
  53. /**
  54. * @var int
  55. */
  56. private $id;
  58. /**
  59. * @var Collection<int, self>
  60. */
  61. private $children;
  63. /**
  64. * @var Collection<int, UserGroup>
  65. */
  66. private $userGroups;
  68. /**
  69. * @var Group|null
  70. */
  71. private $parent;
  73. /**
  74. * @var Collection<int, RoleInterface>
  75. */
  76. private $roles;
  78. /**
  79. * @var UserInterface|null
  80. */
  81. #[Exclude]
  82. protected $changer;
  84. /**
  85. * @var UserInterface|null
  86. */
  87. #[Exclude]
  88. protected $creator;
  90. public function __construct()
  91. {
  92. $this->children = new ArrayCollection();
  93. $this->userGroups = new ArrayCollection();
  94. $this->roles = new ArrayCollection();
  95. }
  97. /**
  98. * Set lft.
  99. *
  100. * @param int $lft
  101. *
  102. * @return Group
  103. */
  104. public function setLft($lft)
  105. {
  106. $this->lft = $lft;
  108. return $this;
  109. }
  111. /**
  112. * Get lft.
  113. *
  114. * @return int
  115. */
  116. public function getLft()
  117. {
  118. return $this->lft;
  119. }
  121. /**
  122. * Set rgt.
  123. *
  124. * @param int $rgt
  125. *
  126. * @return Group
  127. */
  128. public function setRgt($rgt)
  129. {
  130. $this->rgt = $rgt;
  132. return $this;
  133. }
  135. /**
  136. * Get rgt.
  137. *
  138. * @return int
  139. */
  140. public function getRgt()
  141. {
  142. return $this->rgt;
  143. }
  145. /**
  146. * Set depth.
  147. *
  148. * @param int $depth
  149. *
  150. * @return Group
  151. */
  152. public function setDepth($depth)
  153. {
  154. $this->depth = $depth;
  156. return $this;
  157. }
  159. /**
  160. * Get depth.
  161. *
  162. * @return int
  163. */
  164. public function getDepth()
  165. {
  166. return $this->depth;
  167. }
  169. /**
  170. * Set name.
  171. *
  172. * @param string $name
  173. *
  174. * @return Group
  175. */
  176. public function setName($name)
  177. {
  178. $this->name = $name;
  180. return $this;
  181. }
  183. /**
  184. * Get name.
  185. *
  186. * @return string
  187. */
  188. public function getName()
  189. {
  190. return $this->name;
  191. }
  193. /**
  194. * Get id.
  195. *
  196. * @return int
  197. */
  198. public function getId()
  199. {
  200. return $this->id;
  201. }
  203. /**
  204. * Add children.
  205. *
  206. * @return Group
  207. */
  208. public function addChildren(self $children)
  209. {
  210. $this->children[] = $children;
  212. return $this;
  213. }
  215. /**
  216. * Remove children.
  217. *
  218. * @return void
  219. */
  220. public function removeChildren(self $children)
  221. {
  222. $this->children->removeElement($children);
  223. }
  225. /**
  226. * Get children.
  227. *
  228. * @return Collection<int, self>
  229. */
  230. public function getChildren()
  231. {
  232. return $this->children;
  233. }
  235. /**
  236. * Add userGroups.
  237. *
  238. * @return Group
  239. */
  240. public function addUserGroup(UserGroup $userGroups)
  241. {
  242. $this->userGroups[] = $userGroups;
  244. return $this;
  245. }
  247. /**
  248. * Remove userGroups.
  249. *
  250. * @return void
  251. */
  252. public function removeUserGroup(UserGroup $userGroups)
  253. {
  254. $this->userGroups->removeElement($userGroups);
  255. }
  257. /**
  258. * Get userGroups.
  259. *
  260. * @return Collection<int, UserGroup>
  261. */
  262. public function getUserGroups()
  263. {
  264. return $this->userGroups;
  265. }
  267. /**
  268. * Set parent.
  269. *
  270. * @return Group
  271. */
  272. public function setParent(?self $parent = null)
  273. {
  274. $this->parent = $parent;
  276. return $this;
  277. }
  279. /**
  280. * Get parent.
  281. *
  282. * @return Group|null
  283. */
  284. public function getParent()
  285. {
  286. return $this->parent;
  287. }
  289. /**
  290. * Add roles.
  291. *
  292. * @return Group
  293. */
  294. public function addRole(RoleInterface $roles)
  295. {
  296. $this->roles[] = $roles;
  298. return $this;
  299. }
  301. /**
  302. * Remove roles.
  303. *
  304. * @return void
  305. */
  306. public function removeRole(RoleInterface $roles)
  307. {
  308. $this->roles->removeElement($roles);
  309. }
  311. /**
  312. * Get roles.
  313. *
  314. * @return Collection<int, RoleInterface>
  315. */
  316. public function getRoles()
  317. {
  318. return $this->roles;
  319. }
  320. }