vendor/sulu/sulu/src/Sulu/Bundle/SecurityBundle/Entity/UserRole.php line 28

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 JMS\Serializer\Annotation\ExclusionPolicy;
  15. use JMS\Serializer\Annotation\Expose;
  16. use JMS\Serializer\Annotation\SerializedName;
  17. use JMS\Serializer\Annotation\VirtualProperty;
  18. use Sulu\Bundle\CoreBundle\Entity\ApiEntity;
  19. use Sulu\Bundle\SecurityBundle\Exception\AssignAnonymousRoleException;
  20. use Sulu\Component\Security\Authentication\RoleInterface;
  21. use Sulu\Component\Security\Authentication\UserInterface;
  23. /**
  24. * UserRole.
  25. *
  26. * @ExclusionPolicy("all");
  27. */
  28. class UserRole extends ApiEntity
  29. {
  30. /**
  31. * @var int
  32. *
  33. * @Expose
  34. */
  35. protected $id;
  37. /**
  38. * @var string
  39. *
  40. * @Expose
  41. */
  42. protected $locale;
  44. /**
  45. * @var UserInterface
  46. */
  47. protected $user;
  49. /**
  50. * @var RoleInterface
  51. *
  52. * @Expose
  53. */
  54. protected $role;
  56. /**
  57. * Get id.
  58. *
  59. * @return int
  60. */
  61. public function getId()
  62. {
  63. return $this->id;
  64. }
  66. /**
  67. * Set locale.
  68. *
  69. * @param string $locale
  70. *
  71. * @return UserRole
  72. */
  73. public function setLocale($locale)
  74. {
  75. $this->locale = $locale;
  77. return $this;
  78. }
  80. /**
  81. * Get locale.
  82. *
  83. * @return string
  84. */
  85. public function getLocale()
  86. {
  87. return $this->locale;
  88. }
  90. /**
  91. * Get Locales as array.
  92. *
  93. * @return array
  94. *
  95. * @VirtualProperty
  96. * @SerializedName("locales")
  97. */
  98. public function getLocales()
  99. {
  100. return \json_decode($this->locale);
  101. }
  103. /**
  104. * Set user.
  105. *
  106. * @return UserRole
  107. */
  108. public function setUser(UserInterface $user)
  109. {
  110. $this->user = $user;
  112. return $this;
  113. }
  115. /**
  116. * Get user.
  117. *
  118. * @return UserInterface
  119. */
  120. public function getUser()
  121. {
  122. return $this->user;
  123. }
  125. /**
  126. * Set role.
  127. *
  128. * @return UserRole
  129. */
  130. public function setRole(RoleInterface $role)
  131. {
  132. if ($role->getAnonymous()) {
  133. throw new AssignAnonymousRoleException($role);
  134. }
  136. $this->role = $role;
  138. return $this;
  139. }
  141. /**
  142. * Get role.
  143. *
  144. * @return RoleInterface
  145. */
  146. public function getRole()
  147. {
  148. return $this->role;
  149. }
  150. }