Merge pull request #78 from Senjutsumo/add-roles

Add roles
sumocoders · Nov 27, 2018 · ac8b9ea · ac8b9ea
2 parents a42f176 + b114769
commit ac8b9ea
Show file tree

Hide file tree

Showing 11 changed files with 197 additions and 3 deletions.
diff --git a/DataTransferObject/BaseUserDataTransferObject.php b/DataTransferObject/BaseUserDataTransferObject.php
@@ -2,6 +2,8 @@
 
 namespace SumoCoders\FrameworkMultiUserBundle\DataTransferObject;
 
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
 use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
 use SumoCoders\FrameworkMultiUserBundle\Entity\BaseUser;
@@ -26,6 +28,9 @@ class BaseUserDataTransferObject implements UserDataTransferObject
     /** @var User */
     protected $user;
 
+    /** @var Collection|null */
+    public $roles;
+
     public static function fromUser(User $user): UserDataTransferObject
     {
         $baseUserTransferObject = new static();
@@ -34,6 +39,7 @@ public static function fromUser(User $user): UserDataTransferObject
         $baseUserTransferObject->userName = $user->getUsername();
         $baseUserTransferObject->displayName = $user->getDisplayName();
         $baseUserTransferObject->email = $user->getEmail();
+        $baseUserTransferObject->roles = $user->getRolesAsCollection();
         if ($user->hasPlainPassword()) {
             $baseUserTransferObject->plainPassword = $user->getPlainPassword();
         }
@@ -53,7 +59,8 @@ public function getEntity(): User
             $this->userName,
             $this->plainPassword,
             $this->displayName,
-            $this->email
+            $this->email,
+            $this->roles instanceof Collection ? $this->roles : new ArrayCollection()
         );
     }
 
@@ -81,4 +88,9 @@ public function getPlainPassword(): ?string
     {
         return $this->plainPassword;
     }
+
+    public function getRoles(): ?Collection
+    {
+        return $this->roles;
+    }
 }
diff --git a/DataTransferObject/Interfaces/UserDataTransferObject.php b/DataTransferObject/Interfaces/UserDataTransferObject.php
@@ -2,6 +2,7 @@
 
 namespace SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces;
 
+use Doctrine\Common\Collections\Collection;
 use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
 
 interface UserDataTransferObject
@@ -19,4 +20,6 @@ public function getPlainPassword(): ?string;
     public static function fromUser(User $user): self;
 
     public function getEntity(): User;
+
+    public function getRoles(): ?Collection;
 }
diff --git a/Entity/BaseUser.php b/Entity/BaseUser.php
@@ -2,6 +2,8 @@
 
 namespace SumoCoders\FrameworkMultiUserBundle\Entity;
 
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Serializable;
 use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
@@ -82,11 +84,19 @@ class BaseUser implements User, Serializable, EquatableInterface
      */
     protected $plainPassword;
 
+    /**
+     * @var Collection
+     *
+     * @ORM\ManyToMany(targetEntity="SumoCoders\FrameworkMultiUserBundle\Entity\UserRole")
+     */
+    protected $roles;
+
     /**
      * @param string $username
      * @param string $plainPassword
      * @param string $displayName
      * @param string $email
+     * @param Collection $roles
      * @param int $id
      * @param PasswordResetToken $token
      */
@@ -95,13 +105,15 @@ public function __construct(
         string $plainPassword,
         string $displayName,
         string $email,
+        Collection $roles,
         int $id = null,
         PasswordResetToken $token = null
     ) {
         $this->username = $username;
         $this->plainPassword = $plainPassword;
         $this->displayName = $displayName;
         $this->email = $email;
+        $this->roles = $roles;
         $this->id = $id;
 
         // set the default status to active
@@ -112,9 +124,14 @@ public function __construct(
         }
     }
 
-    public function getRoles(): array
+    public function getRoles(): ?array
+    {
+        return $this->roles->toArray();
+    }
+
+    public function getRolesAsCollection(): ?Collection
     {
-        return ['ROLE_USER'];
+        return $this->roles;
     }
 
     public function getPassword(): string

diff --git a/Entity/UserRole.php b/Entity/UserRole.php
@@ -0,0 +1,94 @@
+<?php
+
+namespace SumoCoders\FrameworkMultiUserBundle\Entity;
+
+use DateTime;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Security\Core\Role\Role;
+
+/**
+ * @ORM\Entity
+ * @ORM\Table
+ * @ORM\HasLifecycleCallbacks
+ */
+class UserRole extends Role
+{
+    /**
+     * @var int
+     *
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     * @ORM\Column(type="integer")
+     */
+    private $id;
+
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="string")
+     */
+    private $roleName;
+
+    /**
+     * @var DateTime
+     *
+     * @ORM\Column(type="datetime")
+     */
+    private $createdOn;
+
+    /**
+     * @var DateTime
+     *
+     * @ORM\Column(type="datetime")
+     */
+    private $editedOn;
+
+    public function __construct(string $roleName)
+    {
+        parent::__construct($roleName);
+
+        $this->roleName = $roleName;
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getRole(): string
+    {
+        return $this->roleName;
+    }
+
+    public function getCreatedOn(): DateTime
+    {
+        return $this->createdOn;
+    }
+
+    public function getEditedOn(): DateTime
+    {
+        return $this->editedOn;
+    }
+
+    /**
+     * @ORM\PrePersist
+     */
+    public function onPrePersist(): void
+    {
+        $this->createdOn = new DateTime();
+        $this->editedOn = new DateTime();
+    }
+
+    /**
+     * @ORM\PreUpdate
+     */
+    public function onPreUpdate(): void
+    {
+        $this->editedOn = new DateTime();
+    }
+
+    public function __toString(): string
+    {
+        return $this->roleName;
+    }
+}
diff --git a/Form/AddBaseUserType.php b/Form/AddBaseUserType.php
@@ -3,17 +3,30 @@
 namespace SumoCoders\FrameworkMultiUserBundle\Form;
 
 use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\BaseUserDataTransferObject;
+use SumoCoders\FrameworkMultiUserBundle\Entity\UserRole;
 use SumoCoders\FrameworkMultiUserBundle\Form\Interfaces\FormWithDataTransferObject;
+use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\EmailType;
 use Symfony\Component\Form\Extension\Core\Type\PasswordType;
 use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\Translation\TranslatorInterface;
 
 class AddBaseUserType extends AbstractType implements FormWithDataTransferObject
 {
+    /**
+     * @var TranslatorInterface
+     */
+    private $translator;
+
+    public function __construct(TranslatorInterface $translator)
+    {
+        $this->translator = $translator;
+    }
+
     public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
@@ -38,6 +51,21 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             [
                 'type' => PasswordType::class,
             ]
+        )->add(
+            'roles',
+            EntityType::class,
+            [
+                'attr' => [
+                    'class' => 'select2',
+                ],
+                'class' => UserRole::class,
+                'choice_label' => function (UserRole $userRole) {
+                    return $this->translator->trans($userRole);
+                },
+                'required' => false,
+                'multiple' => true,
+                'placeholder' => '',
+            ]
         );
     }
 

diff --git a/Form/EditBaseUserType.php b/Form/EditBaseUserType.php
@@ -3,17 +3,30 @@
 namespace SumoCoders\FrameworkMultiUserBundle\Form;
 
 use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\BaseUserDataTransferObject;
+use SumoCoders\FrameworkMultiUserBundle\Entity\UserRole;
 use SumoCoders\FrameworkMultiUserBundle\Form\Interfaces\FormWithDataTransferObject;
+use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\EmailType;
 use Symfony\Component\Form\Extension\Core\Type\PasswordType;
 use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\Translation\TranslatorInterface;
 
 class EditBaseUserType extends AbstractType implements FormWithDataTransferObject
 {
+    /**
+     * @var TranslatorInterface
+     */
+    protected $translator;
+
+    public function __construct(TranslatorInterface $translator)
+    {
+        $this->translator = $translator;
+    }
+
     public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults(
@@ -41,6 +54,21 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'type' => PasswordType::class,
                 'required' => false,
             ]
+        )->add(
+            'roles',
+            EntityType::class,
+            [
+                'attr' => [
+                    'class' => 'select2',
+                ],
+                'class' => UserRole::class,
+                'choice_label' => function (UserRole $userRole) {
+                    return $this->translator->trans($userRole);
+                },
+                'required' => false,
+                'multiple' => true,
+                'placeholder' => '',
+            ]
         );
     }
 

diff --git a/Resources/config/forms.yml b/Resources/config/forms.yml
@@ -1,10 +1,14 @@
 services:
   multi_user_form_add_base_user:
     class: SumoCoders\FrameworkMultiUserBundle\Form\AddBaseUserType
+    arguments:
+      - "@translator"
     tags:
       - { name: form.type }
 
   multi_user_form_edit_base_user:
     class: SumoCoders\FrameworkMultiUserBundle\Form\EditBaseUserType
+    arguments:
+      - "@translator"
     tags:
       - { name: form.type }
diff --git a/Resources/translations/messages.en.yml b/Resources/translations/messages.en.yml
@@ -43,6 +43,7 @@ change:
       second: repeat password
     submit: Set new password
 user:
+  roles: User roles
   header:
     title:
       login: Login
diff --git a/Resources/translations/messages.nl.yml b/Resources/translations/messages.nl.yml
@@ -43,6 +43,7 @@ change:
       second: herhaal wachtwoord
     submit: Stel nieuw wachtwoord in
 user:
+  roles: Gebruikersrollen
   header:
     title:
       login: Login
diff --git a/User/InMemoryBaseUserRepository.php b/User/InMemoryBaseUserRepository.php
@@ -2,6 +2,7 @@
 
 namespace SumoCoders\FrameworkMultiUserBundle\User;
 
+use Doctrine\Common\Collections\ArrayCollection;
 use SumoCoders\FrameworkMultiUserBundle\Entity\BaseUser;
 use SumoCoders\FrameworkMultiUserBundle\Security\PasswordResetToken;
 use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
@@ -20,6 +21,7 @@ public function __construct(EncoderFactory $encoderFactory)
             'test',
             'Wouter Sioen',
             '[email protected]',
+            new ArrayCollection(['ROLE_USER']),
             1
         );
         $user->encodePassword($encoderFactory->getEncoder($user));
@@ -31,6 +33,7 @@ public function __construct(EncoderFactory $encoderFactory)
             'reset',
             'reset',
             '[email protected]',
+            new ArrayCollection(['ROLE_USER']),
             2,
             PasswordResetToken::generate()
         );

diff --git a/User/Interfaces/User.php b/User/Interfaces/User.php
@@ -2,6 +2,7 @@
 
 namespace SumoCoders\FrameworkMultiUserBundle\User\Interfaces;
 
+use Doctrine\Common\Collections\Collection;
 use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
 use Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -21,4 +22,6 @@ public function hasPlainPassword(): bool;
     public function getPlainPassword(): string;
 
     public function encodePassword(PasswordEncoderInterface $encoder): void;
+
+    public function getRolesAsCollection(): ?Collection;
 }