]> Raphaƫl G. Git Repositories - userbundle/blobdiff - Entity/User.php
Cleanup
[userbundle] / Entity / User.php
index 1e36a931b364da2678c99123ec557333bc752668..445c3bdddec00fd78e55481942f09c167648dae3 100644 (file)
 
 namespace Rapsys\UserBundle\Entity;
 
+use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
+
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 
@@ -22,80 +24,40 @@ use Rapsys\UserBundle\Entity\Group;
 /**
  * User
  */
-class User implements UserInterface, PasswordAuthenticatedUserInterface, \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
-        */
-       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
-               $this->forename = null;
-               $this->surname = null;
-               $this->active = false;
-               $this->disabled = false;
                $this->created = new \DateTime('now');
                $this->updated = new \DateTime('now');
 
@@ -106,9 +68,9 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
        /**
         * Get id
         *
-        * @return integer
+        * @return ?int
         */
-       public function getId(): int {
+       public function getId(): ?int {
                return $this->id;
        }
 
@@ -116,18 +78,11 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
         * Set mail
         *
         * @param string $mail
-        *
         * @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;
        }
@@ -193,19 +148,20 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
         * @return User
         */
        public function setPassword(string $password): User {
+               //Set password
                $this->password = $password;
 
                return $this;
        }
 
        /**
-        * Get password
-        *
         * {@inheritdoc}
         *
+        * Get password
+        *
         * @return string
         */
-       public function getPassword(): ?string {
+       public function getPassword(): string {
                return $this->password;
        }
 
@@ -232,25 +188,25 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
        }
 
        /**
-        * Set disabled
+        * Set enable
         *
-        * @param bool $disabled
+        * @param bool $enable
         *
         * @return User
         */
-       public function setDisabled(bool $disabled): User {
-               $this->disabled = $disabled;
+       public function setEnable(bool $enable): User {
+               $this->enable = $enable;
 
                return $this;
        }
 
        /**
-        * Get disabled
+        * Get enable
         *
         * @return bool
         */
-       public function getDisabled(): bool {
-               return $this->disabled;
+       public function getEnable(): bool {
+               return $this->enable;
        }
 
        /**
@@ -300,7 +256,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
        /**
         * Set civility
         */
-       public function setCivility(Civility $civility): User {
+       public function setCivility(?Civility $civility = null): User {
                $this->civility = $civility;
 
                return $this;
@@ -320,7 +276,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
         *
         * @return User
         */
-       public function addGroup(Group $group) {
+       public function addGroup(Group $group): User {
                $this->groups[] = $group;
 
                return $this;
@@ -330,17 +286,19 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
         * 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
         *
-        * @return ArrayCollection
+        * @return Doctrine\Common\Collections\Collection
         */
-       public function getGroups(): ArrayCollection {
+       public function getGroups(): Collection {
                return $this->groups;
        }
 
@@ -358,7 +316,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
                                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
                        []
                ));
@@ -421,24 +379,24 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
        /**
         * {@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->disabled,
+                       $this->enable,
                        $this->created,
                        $this->updated
-               ]);
+               ];
        }
 
        /**
         * {@inheritdoc}
         */
-       public function unserialize($serialized) {
+       public function __unserialize(array $data): void {
                list(
                        $this->id,
                        $this->mail,
@@ -446,32 +404,28 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
                        $this->surname,
                        $this->password,
                        $this->active,
-                       $this->disabled,
+                       $this->enable,
                        $this->created,
                        $this->updated
-               ) = unserialize($serialized);
+               ) = $data;
        }
 
        /**
         * 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;
        }
 
        /**
-        * 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;
        }
 
        /**
@@ -479,7 +433,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface, \Serial
         */
        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'));
                }