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.      * @Expose
  33.      */
  34.     protected $id;
  36.     /**
  37.      * @var string
  38.      * @Expose
  39.      */
  40.     protected $locale;
  42.     /**
  43.      * @var UserInterface
  44.      */
  45.     protected $user;
  47.     /**
  48.      * @var RoleInterface
  49.      * @Expose
  50.      */
  51.     protected $role;
  53.     /**
  54.      * Get id.
  55.      *
  56.      * @return int
  57.      */
  58.     public function getId()
  59.     {
  60.         return $this->id;
  61.     }
  63.     /**
  64.      * Set locale.
  65.      *
  66.      * @param string $locale
  67.      *
  68.      * @return UserRole
  69.      */
  70.     public function setLocale($locale)
  71.     {
  72.         $this->locale = $locale;
  74.         return $this;
  75.     }
  77.     /**
  78.      * Get locale.
  79.      *
  80.      * @return string
  81.      */
  82.     public function getLocale()
  83.     {
  84.         return $this->locale;
  85.     }
  87.     /**
  88.      * Get Locales as array.
  89.      *
  90.      * @return array
  91.      * @VirtualProperty
  92.      * @SerializedName("locales")
  93.      */
  94.     public function getLocales()
  95.     {
  96.         return \json_decode($this->locale);
  97.     }
  99.     /**
  100.      * Set user.
  101.      *
  102.      * @return UserRole
  103.      */
  104.     public function setUser(UserInterface $user)
  105.     {
  106.         $this->user = $user;
  108.         return $this;
  109.     }
  111.     /**
  112.      * Get user.
  113.      *
  114.      * @return UserInterface
  115.      */
  116.     public function getUser()
  117.     {
  118.         return $this->user;
  119.     }
  121.     /**
  122.      * Set role.
  123.      *
  124.      * @return UserRole
  125.      */
  126.     public function setRole(RoleInterface $role)
  127.     {
  128.         if ($role->getAnonymous()) {
  129.             throw new AssignAnonymousRoleException($role);
  130.         }
  132.         $this->role = $role;
  134.         return $this;
  135.     }
  137.     /**
  138.      * Get role.
  139.      *
  140.      * @return RoleInterface
  141.      */
  142.     public function getRole()
  143.     {
  144.         return $this->role;
  145.     }
  146. }