Replace hardcoded role by configurable key

[userbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index c4c14df4f5c8240c264f3c1df9279fcd6a32f2df..5220e77dd0bec6410bc184ef0dd487e1ac433e46 100644 (file)
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -11,100 +11,66 @@
 
 namespace Rapsys\UserBundle\Entity;
 
 
 namespace Rapsys\UserBundle\Entity;
 

+use Doctrine\Common\Collections\Collection;

 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Event\PreUpdateEventArgs;

-use Symfony\Component\Security\Core\User\UserInterface;

 
 use Rapsys\UserBundle\Entity\Civility;
 use Rapsys\UserBundle\Entity\Group;
 
 
 use Rapsys\UserBundle\Entity\Civility;
 use Rapsys\UserBundle\Entity\Group;
 

+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
+

 /**
  * User
  */
 /**
  * User
  */

-class User implements UserInterface, \Serializable {
-       /**
-        * @var integer
-        */
-       protected $id;
-
-       /**
-        * @var string
-        */
-       protected $mail;
-
-       /**
-        * @var string
-        */
-       protected $pseudonym;
-
-       /**
-        * @var string
-        */
-       protected $forename;
-
-       /**
-        * @var string
-        */
-       protected $surname;
-
-       /**
-        * @var string
-        */
-       protected $password;
-
-       /**
-        * @var string
-        */
-       protected $slug;
-
-       /**
-        * @var bool
-        */
-       protected $active;
-
-       /**
-        * @var bool
-        */
-       protected $disabled;
-
+class User implements UserInterface, PasswordAuthenticatedUserInterface {

        /**
        /**

-        * @var \DateTime
+        * Primary key

         */
         */

-       protected $created;
+       protected ?int $id = null;

 
        /**
 
        /**

-        * @var \DateTime
+        * Create datetime

         */
         */

-       protected $updated;
+       protected \DateTime $created;

 
        /**
 
        /**

-        * @var Civility
+        * Update datetime

         */
         */

-       protected $civility;
+       protected \DateTime $updated;

 
        /**
 
        /**

-        * @var ArrayCollection
+        * Groups collection

         */
         */

-       protected $groups;
+       protected Collection $groups;

 
        /**
         * Constructor
         *
         * @param string $mail The user mail
 
        /**
         * Constructor
         *
         * @param string $mail The user mail

-        */
-       public function __construct(string $mail) {
-               $this->mail = $mail;
-               $this->active = false;
-               $this->disabled = false;
+        * @param string $password The user password
+        * @param ?Civility $civility The user civility
+        * @param ?string $forename The user forename
+        * @param ?string $surname The user surname
+        * @param bool $active The user active
+        * @param bool $enable The user enable
+        */
+       public function __construct(protected string $mail, protected string $password, protected ?Civility $civility = null, protected ?string $forename = null, protected ?string $surname = null, protected bool $active = false, protected bool $enable = true) {
+               //Set defaults
+               $this->created = new \DateTime('now');
+               $this->updated = new \DateTime('now');
+
+               //Set collections

                $this->groups = new ArrayCollection();
        }
 
        /**
         * Get id
         *
                $this->groups = new ArrayCollection();
        }
 
        /**
         * Get id
         *

-        * @return integer
+        * @return ?int

         */
         */

-       public function getId(): int {
+       public function getId(): ?int {

                return $this->id;
        }
 
                return $this->id;
        }
 


@@ -112,10 +78,10 @@ class User implements UserInterface, \Serializable {
         * Set mail
         *
         * @param string $mail
         * Set mail
         *
         * @param string $mail

-        *

         * @return User
         */
        public function setMail(string $mail): User {
         * @return User
         */
        public function setMail(string $mail): User {

+               //Set mail

                $this->mail = $mail;
 
                return $this;
                $this->mail = $mail;
 
                return $this;


@@ -126,40 +92,18 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getMail(): ?string {
+       public function getMail(): string {

                return $this->mail;
        }
 
                return $this->mail;
        }
 

-       /**
-        * Set pseudonym
-        *
-        * @param string $pseudonym
-        *
-        * @return User
-        */
-       public function setPseudonym(string $pseudonym): User {
-               $this->pseudonym = $pseudonym;
-
-               return $this;
-       }
-
-       /**
-        * Get pseudonym
-        *
-        * @return string
-        */
-       public function getPseudonym(): ?string {
-               return $this->pseudonym;
-       }
-

        /**
         * Set forename
         *
        /**
         * Set forename
         *

-        * @param string $forename
+        * @param ?string $forename

         *
         * @return User
         */
         *
         * @return User
         */

-       public function setForename(string $forename): User {
+       public function setForename(?string $forename): User {

                $this->forename = $forename;
 
                return $this;
                $this->forename = $forename;
 
                return $this;


@@ -168,7 +112,7 @@ class User implements UserInterface, \Serializable {
        /**
         * Get forename
         *
        /**
         * Get forename
         *

-        * @return string
+        * @return ?string

         */
        public function getForename(): ?string {
                return $this->forename;
         */
        public function getForename(): ?string {
                return $this->forename;


@@ -177,11 +121,11 @@ class User implements UserInterface, \Serializable {
        /**
         * Set surname
         *
        /**
         * Set surname
         *

-        * @param string $surname
+        * @param ?string $surname

         *
         * @return User
         */
         *
         * @return User
         */

-       public function setSurname(string $surname): User {
+       public function setSurname(?string $surname): User {

                $this->surname = $surname;
 
                return $this;
                $this->surname = $surname;
 
                return $this;


@@ -190,7 +134,7 @@ class User implements UserInterface, \Serializable {
        /**
         * Get surname
         *
        /**
         * Get surname
         *

-        * @return string
+        * @return ?string

         */
        public function getSurname(): ?string {
                return $this->surname;
         */
        public function getSurname(): ?string {
                return $this->surname;


@@ -204,42 +148,21 @@ class User implements UserInterface, \Serializable {
         * @return User
         */
        public function setPassword(string $password): User {
         * @return User
         */
        public function setPassword(string $password): User {

+               //Set password

                $this->password = $password;
 
                return $this;
        }
 
        /**
                $this->password = $password;
 
                return $this;
        }
 
        /**

-        * Get password
-        *

         * {@inheritdoc}
         *
         * {@inheritdoc}
         *

-        * @return string
-        */
-       public function getPassword(): ?string {
-               return $this->password;
-       }
-
-       /**
-        * Set slug
-        *
-        * @param string $slug
-        *
-        * @return User
-        */
-       public function setSlug(?string $slug): User {
-               $this->slug = $slug;
-
-               return $this;
-       }
-
-       /**
-        * Get slug
+        * Get password

         *
         * @return string
         */
         *
         * @return string
         */

-       public function getSlug(): ?string {
-               return $this->slug;
+       public function getPassword(): string {
+               return $this->password;

        }
 
        /**
        }
 
        /**


@@ -265,25 +188,25 @@ class User implements UserInterface, \Serializable {
        }
 
        /**
        }
 
        /**

-        * Set disabled
+        * Set enable

         *
         *

-        * @param bool $disabled
+        * @param bool $enable

         *
         * @return User
         */
         *
         * @return User
         */

-       public function setDisabled(bool $disabled): User {
-               $this->disabled = $disabled;
+       public function setEnable(bool $enable): User {
+               $this->enable = $enable;

 
                return $this;
        }
 
        /**
 
                return $this;
        }
 
        /**

-        * Get disabled
+        * Get enable

         *
         * @return bool
         */
         *
         * @return bool
         */

-       public function getDisabled(): bool {
-               return $this->disabled;
+       public function getEnable(): bool {
+               return $this->enable;

        }
 
        /**
        }
 
        /**


@@ -333,7 +256,7 @@ class User implements UserInterface, \Serializable {
        /**
         * Set civility
         */
        /**
         * Set civility
         */

-       public function setCivility(Civility $civility): User {
+       public function setCivility(?Civility $civility = null): User {

                $this->civility = $civility;
 
                return $this;
                $this->civility = $civility;
 
                return $this;


@@ -353,7 +276,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function addGroup(Group $group) {
+       public function addGroup(Group $group): User {

                $this->groups[] = $group;
 
                return $this;
                $this->groups[] = $group;
 
                return $this;


@@ -363,17 +286,19 @@ class User implements UserInterface, \Serializable {
         * Remove group
         *
         * @param Group $group
         * Remove group
         *
         * @param Group $group

+        *
+        * @return Doctrine\Common\Collections\Collection

         */
         */

-       public function removeGroup(Group $group) {
-               $this->groups->removeElement($group);
+       public function removeGroup(Group $group): Collection {
+               return $this->groups->removeElement($group);

        }
 
        /**
         * Get groups
         *
        }
 
        /**
         * Get groups
         *

-        * @return ArrayCollection
+        * @return Doctrine\Common\Collections\Collection

         */
         */

-       public function getGroups(): ArrayCollection {
+       public function getGroups(): Collection {

                return $this->groups;
        }
 
                return $this->groups;
        }
 


@@ -391,7 +316,7 @@ class User implements UserInterface, \Serializable {
                                return $array;
                        },
                        //Init with empty array
                                return $array;
                        },
                        //Init with empty array

-                       //XXX: on registration, add each group present in rapsys_user.default.group array to user
+                       //XXX: on registration, add each group present in rapsysuser.default.group array to user

                        //XXX: see vendor/rapsys/userbundle/Controller/DefaultController.php +450
                        []
                ));
                        //XXX: see vendor/rapsys/userbundle/Controller/DefaultController.php +450
                        []
                ));


@@ -439,55 +364,68 @@ class User implements UserInterface, \Serializable {
                return $this->mail;
        }
 
                return $this->mail;
        }
 

+       /**
+        * {@inheritdoc}
+        */
+       public function getUserIdentifier(): string {
+               return $this->mail;
+       }
+

        /**
         * {@inheritdoc}
         */
        public function eraseCredentials(): void {}
 
        /**
         * {@inheritdoc}
         */
        public function eraseCredentials(): void {}
 

-       public function serialize(): string {
-               return serialize([
+       /**
+        * {@inheritdoc}
+        */
+       public function __serialize(): array {
+               return [

                        $this->id,
                        $this->mail,
                        $this->id,
                        $this->mail,

+                       $this->forename,
+                       $this->surname,

                        $this->password,
                        $this->active,
                        $this->password,
                        $this->active,

-                       $this->disabled,
+                       $this->enable,

                        $this->created,
                        $this->updated
                        $this->created,
                        $this->updated

-               ]);
+               ];

        }
 
        }
 

-       public function unserialize($serialized) {
+       /**
+        * {@inheritdoc}
+        */
+       public function __unserialize(array $data): void {

                list(
                        $this->id,
                        $this->mail,
                list(
                        $this->id,
                        $this->mail,

+                       $this->forename,
+                       $this->surname,

                        $this->password,
                        $this->active,
                        $this->password,
                        $this->active,

-                       $this->disabled,
+                       $this->enable,

                        $this->created,
                        $this->updated
                        $this->created,
                        $this->updated

-               ) = unserialize($serialized);
+               ) = $data;

        }
 
        /**
         * Check if account is activated
         *
        }
 
        /**
         * Check if account is activated
         *

-        * It was from deprecated AdvancedUserInterface, see if it's used anymore
-        *
-        * @see vendor/symfony/security-core/User/AdvancedUserInterface.php
+        * @see vendor/rapsys/userbundle/Checker/UserChecker.php

         */
        public function isActivated(): bool {
                return $this->active;
        }
 
        /**
         */
        public function isActivated(): bool {
                return $this->active;
        }
 
        /**

-        * Check if account is disabled
-        *
-        * It was from deprecated AdvancedUserInterface, see if it's used anymore
+        * Check if account is enabled

         *
         *

-        * @see vendor/symfony/security-core/User/AdvancedUserInterface.php
+        * @see vendor/symfony/security-core/User/InMemoryUserChecker.php

         */
         */

-       public function isDisabled(): bool {
-               return $this->disabled;
+       public function isEnabled(): bool {
+               return $this->enable;

        }
 
        /**
        }
 
        /**


@@ -495,12 +433,28 @@ class User implements UserInterface, \Serializable {
         */
        public function preUpdate(PreUpdateEventArgs $eventArgs) {
                //Check that we have an user instance
         */
        public function preUpdate(PreUpdateEventArgs $eventArgs) {
                //Check that we have an user instance

-               if (($user = $eventArgs->getEntity()) instanceof User) {
+               if (($user = $eventArgs->getObject()) instanceof User) {

                        //Set updated value
                        $user->setUpdated(new \DateTime('now'));
                }
        }
 
                        //Set updated value
                        $user->setUpdated(new \DateTime('now'));
                }
        }
 

+       /**
+        * Returns a recipient name of the user
+        *
+        * @return string
+        */
+       public function getRecipientName(): string {
+               //Without forename and surname
+               if (empty($this->forename) && empty($this->surname)) {
+                       //Return recipient name from mail
+                       return ucwords(trim(preg_replace('/[^a-zA-Z]+/', ' ', current(explode('@', $this->mail)))));
+               }
+
+               //Return recipient name from forename and surname
+               return implode(' ', [$this->forename, $this->surname]);
+       }
+

        /**
         * Returns a string representation of the user
         *
        /**
         * Returns a string representation of the user
         *