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. */
  59. private $permissions;
  61. /**
  62. * @var Collection<int, UserRole>
  63. *
  64. * @Exclude
  65. */
  66. private $userRoles;
  68. /**
  69. * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  70. *
  71. * @var Collection<int, Group>
  72. *
  73. * @Exclude
  74. */
  75. private $groups;
  77. /**
  78. * @var Collection<string, RoleSettingInterface>
  79. */
  80. private $settings;
  82. /**
  83. * @var bool
  84. */
  85. private $anonymous = false;
  87. /**
  88. * Constructor.
  89. */
  90. public function __construct()
  91. {
  92. $this->permissions = new ArrayCollection();
  93. $this->userRoles = new ArrayCollection();
  94. $this->groups = new ArrayCollection();
  95. $this->settings = new ArrayCollection();
  96. }
  98. /**
  99. * Get id.
  100. *
  101. * @return int
  102. */
  103. public function getId()
  104. {
  105. return $this->id;
  106. }
  108. /**
  109. * @deprecated since 2.1 and will be removed in 3.0. Use "getIdentifier" instead.
  110. *
  111. * @return string
  112. */
  113. public function getRole()
  114. {
  115. @trigger_deprecation('sulu/sulu', '2.1', 'The "%s" method is deprecated, use "%s" instead.', __METHOD__, 'getIdentifier');
  117. return $this->getIdentifier();
  118. }
  120. public function getIdentifier()
  121. {
  122. if ($this->anonymous) {
  123. return RoleInterface::IS_SULU_ANONYMOUS;
  124. }
  126. $key = $this->getKey();
  128. // keep backwards compatibility as name was used for generating identifier before key was introduced
  129. if (!$key) {
  130. $key = $this->getName();
  131. }
  133. return 'ROLE_SULU_' . \strtoupper($key);
  134. }
  136. public function setName($name)
  137. {
  138. $this->name = $name;
  140. return $this;
  141. }
  143. public function getName()
  144. {
  145. return $this->name;
  146. }
  148. public function getKey()
  149. {
  150. return $this->key;
  151. }
  153. public function setKey($key)
  154. {
  155. $this->key = $key;
  157. return $this;
  158. }
  160. public function setSystem($system)
  161. {
  162. $this->system = $system;
  164. return $this;
  165. }
  167. public function getSystem()
  168. {
  169. return $this->system;
  170. }
  172. public function setSecurityType(?SecurityType $securityType = null)
  173. {
  174. $this->securityType = $securityType;
  176. return $this;
  177. }
  179. public function getSecurityType()
  180. {
  181. return $this->securityType;
  182. }
  184. public function addPermission(Permission $permissions)
  185. {
  186. $this->permissions[] = $permissions;
  188. return $this;
  189. }
  191. public function removePermission(Permission $permissions)
  192. {
  193. $this->permissions->removeElement($permissions);
  194. }
  196. public function getPermissions()
  197. {
  198. return $this->permissions;
  199. }
  201. public function addUserRole(UserRole $userRoles)
  202. {
  203. $this->userRoles[] = $userRoles;
  205. return $this;
  206. }
  208. public function removeUserRole(UserRole $userRoles)
  209. {
  210. $this->userRoles->removeElement($userRoles);
  211. }
  213. public function getUserRoles()
  214. {
  215. return $this->userRoles;
  216. }
  218. public function addGroup(Group $groups)
  219. {
  220. $this->groups[] = $groups;
  222. return $this;
  223. }
  225. public function removeGroup(Group $groups)
  226. {
  227. $this->groups->removeElement($groups);
  228. }
  230. public function getGroups()
  231. {
  232. return $this->groups;
  233. }
  235. /**
  236. * @return $this
  237. */
  238. public function addSetting(RoleSettingInterface $setting)
  239. {
  240. $this->settings->set($setting->getKey(), $setting);
  242. return $this;
  243. }
  245. /**
  246. * @return void
  247. */
  248. public function removeSetting(RoleSettingInterface $setting)
  249. {
  250. $this->settings->remove($setting->getKey());
  251. }
  253. /**
  254. * Get settings.
  255. *
  256. * @return Collection<string, RoleSettingInterface>
  257. */
  258. public function getSettings()
  259. {
  260. return $this->settings;
  261. }
  263. public function getSetting($key)
  264. {
  265. return $this->settings->get($key);
  266. }
  268. public function getAnonymous(): bool
  269. {
  270. return $this->anonymous;
  271. }
  273. public function setAnonymous(bool $anonymous)
  274. {
  275. $this->anonymous = $anonymous;
  276. }
  277. }