vendor/sulu/sulu/src/Sulu/Bundle/SecurityBundle/Entity/Role.php line 25

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 JMS\Serializer\Annotation\Groups;
  18. use Sulu\Component\Persistence\Model\AuditableTrait;
  19. use Sulu\Component\Security\Authentication\RoleInterface;
  20. use Sulu\Component\Security\Authentication\RoleSettingInterface;
  22. /**
  23. * Role.
  24. */
  25. class Role implements RoleInterface
  26. {
  27. use AuditableTrait;
  29. /**
  30. * @var int
  31. */
  32. private $id;
  34. /**
  35. * @var string
  36. */
  37. private $name;
  39. /**
  40. * @var string|null
  41. */
  42. private $key;
  44. /**
  45. * @var string
  46. */
  47. private $system;
  49. /**
  50. * @var SecurityType|null
  51. */
  52. private $securityType;
  54. /**
  55. * @var Collection<int, Permission>
  56. */
  57. #[Groups(['fullRole'])]
  58. private $permissions;
  60. /**
  61. * @var Collection<int, UserRole>
  62. */
  63. #[Exclude]
  64. private $userRoles;
  66. /**
  67. * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  68. *
  69. * @var Collection<int, Group>
  70. */
  71. #[Exclude]
  72. private $groups;
  74. /**
  75. * @var Collection<string, RoleSettingInterface>
  76. */
  77. private $settings;
  79. /**
  80. * @var bool
  81. */
  82. private $anonymous = false;
  84. /**
  85. * Constructor.
  86. */
  87. public function __construct()
  88. {
  89. $this->permissions = new ArrayCollection();
  90. $this->userRoles = new ArrayCollection();
  91. $this->groups = new ArrayCollection();
  92. $this->settings = new ArrayCollection();
  93. }
  95. /**
  96. * Get id.
  97. *
  98. * @return int
  99. */
  100. public function getId()
  101. {
  102. return $this->id;
  103. }
  105. /**
  106. * @deprecated since 2.1 and will be removed in 3.0. Use "getIdentifier" instead.
  107. *
  108. * @return string
  109. */
  110. public function getRole()
  111. {
  112. @trigger_deprecation('sulu/sulu', '2.1', 'The "%s" method is deprecated, use "%s" instead.', __METHOD__, 'getIdentifier');
  114. return $this->getIdentifier();
  115. }
  117. public function getIdentifier()
  118. {
  119. if ($this->anonymous) {
  120. return RoleInterface::IS_SULU_ANONYMOUS;
  121. }
  123. $key = $this->getKey();
  125. // keep backwards compatibility as name was used for generating identifier before key was introduced
  126. if (!$key) {
  127. $key = $this->getName();
  128. }
  130. return 'ROLE_SULU_' . \strtoupper($key);
  131. }
  133. public function setName($name)
  134. {
  135. $this->name = $name;
  137. return $this;
  138. }
  140. public function getName()
  141. {
  142. return $this->name;
  143. }
  145. public function getKey()
  146. {
  147. return $this->key;
  148. }
  150. public function setKey($key)
  151. {
  152. $this->key = $key;
  154. return $this;
  155. }
  157. public function setSystem($system)
  158. {
  159. $this->system = $system;
  161. return $this;
  162. }
  164. public function getSystem()
  165. {
  166. return $this->system;
  167. }
  169. public function setSecurityType(?SecurityType $securityType = null)
  170. {
  171. $this->securityType = $securityType;
  173. return $this;
  174. }
  176. public function getSecurityType()
  177. {
  178. return $this->securityType;
  179. }
  181. public function addPermission(Permission $permissions)
  182. {
  183. $this->permissions[] = $permissions;
  185. return $this;
  186. }
  188. public function removePermission(Permission $permissions)
  189. {
  190. $this->permissions->removeElement($permissions);
  191. }
  193. public function getPermissions()
  194. {
  195. return $this->permissions;
  196. }
  198. public function addUserRole(UserRole $userRoles)
  199. {
  200. $this->userRoles[] = $userRoles;
  202. return $this;
  203. }
  205. public function removeUserRole(UserRole $userRoles)
  206. {
  207. $this->userRoles->removeElement($userRoles);
  208. }
  210. public function getUserRoles()
  211. {
  212. return $this->userRoles;
  213. }
  215. public function addGroup(Group $groups)
  216. {
  217. $this->groups[] = $groups;
  219. return $this;
  220. }
  222. public function removeGroup(Group $groups)
  223. {
  224. $this->groups->removeElement($groups);
  225. }
  227. public function getGroups()
  228. {
  229. return $this->groups;
  230. }
  232. /**
  233. * @return $this
  234. */
  235. public function addSetting(RoleSettingInterface $setting)
  236. {
  237. $this->settings->set($setting->getKey(), $setting);
  239. return $this;
  240. }
  242. /**
  243. * @return void
  244. */
  245. public function removeSetting(RoleSettingInterface $setting)
  246. {
  247. $this->settings->remove($setting->getKey());
  248. }
  250. /**
  251. * Get settings.
  252. *
  253. * @return Collection<string, RoleSettingInterface>
  254. */
  255. public function getSettings()
  256. {
  257. return $this->settings;
  258. }
  260. public function getSetting($key)
  261. {
  262. return $this->settings->get($key);
  263. }
  265. public function getAnonymous(): bool
  266. {
  267. return $this->anonymous;
  268. }
  270. public function setAnonymous(bool $anonymous)
  271. {
  272. $this->anonymous = $anonymous;
  273. }
  274. }