Fix extraction of forename and surname from mail when empty

[userbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index cca45c74c28998b4086c2190910e5666c5996025..9ccad72e5a17fb405bfa0b5f8d2dc163e951d55a 100644 (file)
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,13 +1,26 @@
-<?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\ArrayCollection;
 use Doctrine\Common\Collections\ArrayCollection;

-use Rapsys\UserBundle\Entity\Title;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+use Symfony\Component\Security\Core\User\UserInterface;

 
 

+use Rapsys\UserBundle\Entity\Civility;
+use Rapsys\UserBundle\Entity\Group;
+
+/**
+ * User
+ */

 class User implements UserInterface, \Serializable {
        /**
         * @var integer
 class User implements UserInterface, \Serializable {
        /**
         * @var integer


@@ -19,11 +32,6 @@ class User implements UserInterface, \Serializable {
         */
        protected $mail;
 
         */
        protected $mail;
 

-       /**
-        * @var string
-        */
-       protected $pseudonym;
-

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


@@ -44,6 +52,11 @@ class User implements UserInterface, \Serializable {
         */
        protected $active;
 
         */
        protected $active;
 

+       /**
+        * @var bool
+        */
+       protected $disabled;
+

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


@@ -55,20 +68,38 @@ class User implements UserInterface, \Serializable {
        protected $updated;
 
        /**
        protected $updated;
 
        /**

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

         */
         */

-       protected $title;
+       protected $civility;

 
        /**
 
        /**

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

         */
        protected $groups;
 
        /**
         * Constructor
         */
        protected $groups;
 
        /**
         * Constructor

-        */
-       public function __construct() {
+        *
+        * @param string $mail The user mail
+        */
+       public function __construct(string $mail) {
+               //Set defaults
+               if (!empty($this->mail = $mail)) {
+                       //Extract names from mail
+                       $names = explode(' ', ucwords(trim(preg_replace('/[^a-zA-Z]+/', ' ', current(explode('@', $mail))))));
+                       $this->forename = $names[0];
+                       $this->surname = $names[1]??$names[0];
+               } else {
+                       $this->forename = '';
+                       $this->surname = '';
+               }
+               $this->password = $mail;

                $this->active = false;
                $this->active = false;

+               $this->disabled = false;
+               $this->created = new \DateTime('now');
+               $this->updated = new \DateTime('now');
+
+               //Set collections

                $this->groups = new ArrayCollection();
        }
 
                $this->groups = new ArrayCollection();
        }
 


@@ -77,7 +108,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return integer
         */
         *
         * @return integer
         */

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

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


@@ -88,8 +119,19 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setMail($mail) {
-               $this->mail = $mail;
+       public function setMail(string $mail): User {
+               //With mail
+               if (!empty($this->mail = $mail)) {
+                       //Without forename and surname
+                       if (empty($this->forename) && empty($this->surname)) {
+                               //Extract names from mail
+                               $names = explode(' ', ucwords(trim(preg_replace('/[^a-zA-Z]+/', ' ', current(explode('@', $mail))))));
+                               //Set forename
+                               $this->forename = $names[0];
+                               //Set surname
+                               $this->surname = $names[1]??$names[0];
+                       }
+               }

 
                return $this;
        }
 
                return $this;
        }


@@ -99,32 +141,10 @@ 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
         *


@@ -132,7 +152,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

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

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


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

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

                return $this->forename;
        }
 
                return $this->forename;
        }
 


@@ -154,7 +174,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

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

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


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

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

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


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

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

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


@@ -189,7 +209,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 +220,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 +231,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 +264,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 +275,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 +286,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,30 +297,30 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

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

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

-        * Set title
+        * Set civility

         */
         */

-       public function setTitle(Title $title) {
-               $this->title = $title;
+       public function setCivility(Civility $civility): User {
+               $this->civility = $civility;

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

-        * Get title
+        * Get civility

         */
         */

-       public function getTitle(): Title {
-               return $this->title;
+       public function getCivility(): ?Civility {
+               return $this->civility;

        }
 
        /**
         * Add group
         *
        }
 
        /**
         * Add group
         *

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

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


@@ -291,7 +333,7 @@ class User implements UserInterface, \Serializable {
        /**
         * Remove group
         *
        /**
         * Remove group
         *

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

         */
        public function removeGroup(Group $group) {
                $this->groups->removeElement($group);
         */
        public function removeGroup(Group $group) {
                $this->groups->removeElement($group);


@@ -300,16 +342,16 @@ class User implements UserInterface, \Serializable {
        /**
         * Get groups
         *
        /**
         * Get groups
         *

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

         */
         */

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

                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


@@ -319,34 +361,44 @@ class User implements UserInterface, \Serializable {
                                $array[$group->getId()] = $group->getRole();
                                return $array;
                        },
                                $array[$group->getId()] = $group->getRole();
                                return $array;
                        },

-                       //Init with ROLE_USER
-                       //XXX: we assume that ROLE_USER has id 1 in database
-                       [ 1 => 'ROLE_USER' ]
+                       //Init with empty array
+                       //XXX: on registration, add each group present in rapsys_user.default.group array to user
+                       //XXX: see vendor/rapsys/userbundle/Controller/DefaultController.php +450
+                       []

                ));
        }
 
                ));
        }
 

-       public function getRole() {
+       /**
+        * {@inheritdoc}
+        */
+       public function getRole(): ?string {

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

+               //With roles array empty
+               if ($roles === []) {
+                       //Return null
+                       return null;
+               }
+

                //Return the role with max id
                //XXX: should be rewriten if it change in your configuration
                return $roles[array_reduce(
                        array_keys($roles),
                        function($cur, $id) {
                //Return the role with max id
                //XXX: should be rewriten if it change in your configuration
                return $roles[array_reduce(
                        array_keys($roles),
                        function($cur, $id) {

-                               if ($id > $cur) {
+                               if ($cur === null || $id > $cur) {

                                        return $id;
                                }
                                return $cur;
                        },
                                        return $id;
                                }
                                return $cur;
                        },

-                       0
+                       null

                )];
        }
 
        /**
         * {@inheritdoc}
         */
                )];
        }
 
        /**
         * {@inheritdoc}
         */

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

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


@@ -354,48 +406,88 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

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

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

-       public function eraseCredentials() {}
+       public function eraseCredentials(): void {}

 
 

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

        public function serialize(): string {
                return serialize([
                        $this->id,
                        $this->mail,
        public function serialize(): string {
                return serialize([
                        $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
                ]);
        }
 

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

        public function unserialize($serialized) {
                list(
                        $this->id,
                        $this->mail,
        public function unserialize($serialized) {
                list(
                        $this->id,
                        $this->mail,

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

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

+                       $this->disabled,

                        $this->created,
                        $this->updated
                ) = unserialize($serialized);
        }
 
                        $this->created,
                        $this->updated
                ) = unserialize($serialized);
        }
 

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

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

+       /**
+        * Check if account is disabled
+        *
+        * It was from deprecated AdvancedUserInterface, see if it's used anymore
+        *
+        * @see vendor/symfony/security-core/User/AdvancedUserInterface.php
+        */
+       public function isDisabled(): bool {
+               return $this->disabled;
+       }
+
+       /**
+        * {@inheritdoc}
+        */
+       public function preUpdate(PreUpdateEventArgs $eventArgs) {
+               //Check that we have an user instance
+               if (($user = $eventArgs->getEntity()) instanceof User) {
+                       //Set updated value
+                       $user->setUpdated(new \DateTime('now'));
+               }
+       }
+

        /**
         * Returns a string representation of the user
         *
         * @return string
         */
        public function __toString(): string {
        /**
         * Returns a string representation of the user
         *
         * @return string
         */
        public function __toString(): string {

-               return $this->title.' '.$this->forename.' '.$this->surname;
+               return $this->civility.' '.$this->forename.' '.$this->surname;

        }
 }
        }
 }