Adapt entity and user checker to match with symfony classes and interfaces

[userbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index 8fb41053a352ab4de738eb8351e2aec9d23dde4b..809d363777ea36555d855b7ca991318de32b5a65 100644 (file)
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,83 +1,117 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * this file is part of the rapsys packbundle package.
+ *
+ * (c) raphaël gertz <symfony@rapsys.eu>
+ *
+ * for the full copyright and license information, please view the license
+ * file that was distributed with this source code.
+ */

 
 

-// src/Rapsys/UserBundle/Entity/User.php

 namespace Rapsys\UserBundle\Entity;
 
 namespace Rapsys\UserBundle\Entity;
 

-use Rapsys\UserBundle\Entity\Group;
-use Symfony\Component\Security\Core\User\UserInterface;
+use Doctrine\Common\Collections\Collection;

 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\ArrayCollection;

+use Doctrine\ORM\Event\PreUpdateEventArgs;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
+

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

+use Rapsys\UserBundle\Entity\Group;

 
 

-class User implements UserInterface, \Serializable {
+/**
+ * User
+ */
+class User implements UserInterface, PasswordAuthenticatedUserInterface {

        /**
        /**

-        * @var integer
+        * @var ?integer

         */
         */

-       protected $id;
+       protected ?int $id;

 
        /**
         * @var string
         */
 
        /**
         * @var string
         */

-       protected $mail;
+       protected string $mail;

 
        /**
         * @var string
         */
 
        /**
         * @var string
         */

-       protected $pseudonym;
+       protected string $password;

 
        /**
 
        /**

-        * @var string
+        * @var ?string

         */
         */

-       protected $forename;
+       protected ?string $forename;

 
        /**
 
        /**

-        * @var string
+        * @var ?string

         */
         */

-       protected $surname;
+       protected ?string $surname;

 
        /**
 
        /**

-        * @var string
+        * @var bool

         */
         */

-       protected $password;
+       protected bool $active;

 
        /**
         * @var bool
         */
 
        /**
         * @var bool
         */

-       protected $active;
+       protected bool $disabled;

 
        /**
         * @var \DateTime
         */
 
        /**
         * @var \DateTime
         */

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

 
        /**
         * @var \DateTime
         */
 
        /**
         * @var \DateTime
         */

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

 
        /**
 
        /**

-        * @var \Rapsys\UserBundle\Entity\Civility
+        * @var Civility

         */
         */

-       protected $civility;
+       protected ?Civility $civility;

 
        /**
 
        /**

-        * @var \Doctrine\Common\Collections\Collection
+        * @var Doctrine\Common\Collections\Collection

         */
         */

-       protected $groups;
+       protected Collection $groups;

 
        /**
         * Constructor
 
        /**
         * Constructor

-        */
-       public function __construct() {
-               $this->active = false;
+        *
+        * @param string $mail The user mail
+        * @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 $disabled The user disabled
+        */
+       public function __construct(string $mail, string $password, ?Civility $civility = null, ?string $forename = null, ?string $surname = null, bool $active = false, bool $disabled = false) {
+               //Set defaults
+               $this->mail = $mail;
+               $this->password = $password;
+               $this->civility = $civility;
+               $this->forename = $forename;
+               $this->surname = $surname;
+               $this->active = $active;
+               $this->disabled = $disabled;
+               $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() {
+       public function getId(): ?int {

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


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

-        *

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

-       public function setMail($mail) {
+       public function setMail(string $mail): User {
+               //Set mail

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


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

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

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

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

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

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

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

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

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


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

-        * @return string
+        * @return ?string

         */
         */

-       public function getForename() {
+       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($surname) {
+       public function setSurname(?string $surname): User {

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


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

-        * @return string
+        * @return ?string

         */
         */

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

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


@@ -176,7 +188,8 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setPassword($password) {
+       public function setPassword(string $password): User {
+               //Set password

                $this->password = $password;
 
                return $this;
                $this->password = $password;
 
                return $this;


@@ -189,7 +202,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

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

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


@@ -200,7 +213,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setActive($active) {
+       public function setActive(bool $active): User {

                $this->active = $active;
 
                return $this;
                $this->active = $active;
 
                return $this;


@@ -211,10 +224,32 @@ class User implements UserInterface, \Serializable {
         *
         * @return bool
         */
         *
         * @return bool
         */

-       public function getActive() {
+       public function getActive(): bool {

                return $this->active;
        }
 
                return $this->active;
        }
 

+       /**
+        * Set disabled
+        *
+        * @param bool $disabled
+        *
+        * @return User
+        */
+       public function setDisabled(bool $disabled): User {
+               $this->disabled = $disabled;
+
+               return $this;
+       }
+
+       /**
+        * Get disabled
+        *
+        * @return bool
+        */
+       public function getDisabled(): bool {
+               return $this->disabled;
+       }
+

        /**
         * Set created
         *
        /**
         * Set created
         *


@@ -222,7 +257,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setCreated($created) {
+       public function setCreated(\DateTime $created): User {

                $this->created = $created;
 
                return $this;
                $this->created = $created;
 
                return $this;


@@ -233,7 +268,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

-       public function getCreated() {
+       public function getCreated(): \DateTime {

                return $this->created;
        }
 
                return $this->created;
        }
 


@@ -244,7 +279,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setUpdated($updated) {
+       public function setUpdated(\DateTime $updated): User {

                $this->updated = $updated;
 
                return $this;
                $this->updated = $updated;
 
                return $this;


@@ -255,14 +290,14 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

-       public function getUpdated() {
+       public function getUpdated(): \DateTime {

                return $this->updated;
        }
 
        /**
         * Set civility
         */
                return $this->updated;
        }
 
        /**
         * Set civility
         */

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

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


@@ -278,11 +313,11 @@ class User implements UserInterface, \Serializable {
        /**
         * Add group
         *
        /**
         * Add group
         *

-        * @param \Rapsys\UserBundle\Entity\Group $group
+        * @param Group $group

         *
         * @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;


@@ -291,25 +326,27 @@ class User implements UserInterface, \Serializable {
        /**
         * Remove group
         *
        /**
         * Remove group
         *

-        * @param \Rapsys\UserBundle\Entity\Group $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 \Doctrine\Common\Collections\Collection
+        * @return Doctrine\Common\Collections\Collection

         */
         */

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

                return $this->groups;
        }
 
        /**
         * {@inheritdoc}
         */
                return $this->groups;
        }
 
        /**
         * {@inheritdoc}
         */

-       public function getRoles() {
+       public function getRoles(): array {

                //Get the unique roles list by id
                return array_unique(array_reduce(
                        //Cast groups as array
                //Get the unique roles list by id
                return array_unique(array_reduce(
                        //Cast groups as array


@@ -329,7 +366,7 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

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

                //Retrieve roles
                $roles = $this->getRoles();
 
                //Retrieve roles
                $roles = $this->getRoles();
 


@@ -356,7 +393,7 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

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

                //No salt required with bcrypt
                return null;
        }
                //No salt required with bcrypt
                return null;
        }


@@ -364,46 +401,78 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

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

                return $this->mail;
        }
 
        /**
         * {@inheritdoc}
         */
                return $this->mail;
        }
 
        /**
         * {@inheritdoc}
         */

-       public function eraseCredentials() {}
+       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->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->created,
                        $this->updated
                        $this->created,
                        $this->updated

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

        }
 
        }
 

-       //XXX: was from vendor/symfony/security-core/User/AdvancedUserInterface.php, see if it's used anymore
-       public function isEnabled() {
+       /**
+        * Check if account is activated
+        *
+        * @see vendor/rapsys/userbundle/Checker/UserChecker.php
+        */
+       public function isActivated(): bool {

                return $this->active;
        }
 
                return $this->active;
        }
 

+       /**
+        * Check if account is enabled
+        *
+        * @see vendor/symfony/security-core/User/InMemoryUserChecker.php
+        */
+       public function isEnabled(): bool {
+               return !$this->disabled;
+       }
+

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

-       public function preUpdate(\Doctrine\ORM\Event\PreUpdateEventArgs $eventArgs) {
+       public function preUpdate(PreUpdateEventArgs $eventArgs) {

                //Check that we have an user instance
                if (($user = $eventArgs->getEntity()) instanceof User) {
                        //Set updated value
                //Check that we have an user instance
                if (($user = $eventArgs->getEntity()) instanceof User) {
                        //Set updated value


@@ -411,6 +480,22 @@ class User implements UserInterface, \Serializable {
                }
        }
 
                }
        }
 

+       /**
+        * 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
         *