Cleanup

[userbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index e1693cc06a2934ba21db9cc50745a83b143d0cd2..5220e77dd0bec6410bc184ef0dd487e1ac433e46 100644 (file)
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -11,90 +11,53 @@
 
 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 $forename;
-
-       /**
-        * @var string
-        */
-       protected $surname;
-
-       /**
-        * @var string
-        */
-       protected $password;
-
-       /**
-        * @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) {
-               //With mail
-               if (!empty($this->mail = $mail)) {
-                       $this->password = $mail;
-               } else {
-                       $this->password = '';
-               }
-
+        * @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
                //Set defaults

-               $this->forename = '';
-               $this->surname = '';
-               $this->active = false;
-               $this->disabled = false;

                $this->created = new \DateTime('now');
                $this->updated = new \DateTime('now');
 
                $this->created = new \DateTime('now');
                $this->updated = new \DateTime('now');
 


@@ -105,9 +68,9 @@ class User implements UserInterface, \Serializable {
        /**
         * Get id
         *
        /**
         * Get id
         *

-        * @return integer
+        * @return ?int

         */
         */

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

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


@@ -115,18 +78,11 @@ 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 {

-               //With mail
-               if (!empty($this->mail = $mail)) {
-                       //Without password
-                       if (empty($this->password)) {
-                               //Set mail as password
-                               $this->password = $mail;
-                       }
-               }
+               //Set mail
+               $this->mail = $mail;

 
                return $this;
        }
 
                return $this;
        }


@@ -143,11 +99,11 @@ class User implements UserInterface, \Serializable {
        /**
         * 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;


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

-        * @return string
+        * @return ?string

         */
         */

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

                return $this->forename;
        }
 
        /**
         * Set surname
         *
                return $this->forename;
        }
 
        /**
         * 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;


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

-        * @return string
+        * @return ?string

         */
         */

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

                return $this->surname;
        }
 
                return $this->surname;
        }
 


@@ -192,19 +148,20 @@ 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}
         *

+        * Get password
+        *

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

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

                return $this->password;
        }
 
                return $this->password;
        }
 


@@ -231,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;

        }
 
        /**
        }
 
        /**


@@ -299,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;


@@ -319,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;


@@ -329,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;
        }
 


@@ -357,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
                        []
                ));


@@ -398,6 +357,13 @@ class User implements UserInterface, \Serializable {
                return null;
        }
 
                return null;
        }
 

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

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


@@ -413,24 +379,24 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

-       public function serialize(): string {
-               return serialize([
+       public function __serialize(): array {
+               return [

                        $this->id,
                        $this->mail,
                        $this->forename,
                        $this->surname,
                        $this->password,
                        $this->active,
                        $this->id,
                        $this->mail,
                        $this->forename,
                        $this->surname,
                        $this->password,
                        $this->active,

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

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

-               ]);
+               ];

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

-       public function unserialize($serialized) {
+       public function __unserialize(array $data): void {

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


@@ -438,32 +404,28 @@ class User implements UserInterface, \Serializable {
                        $this->surname,
                        $this->password,
                        $this->active,
                        $this->surname,
                        $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;

        }
 
        /**
        }
 
        /**


@@ -471,7 +433,7 @@ 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'));
                }