X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/c10ada0bebaf63162b0db1866f643984bdadbb30..38bbc6345098782376b9a0d14de901bc7af9cf0b:/Entity/User.php

diff --git a/Entity/User.php b/Entity/User.php
index 549b176..44680fb 100644
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -11,8 +11,12 @@
 
 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;
 
 use Rapsys\UserBundle\Entity\Civility;
 use Rapsys\UserBundle\Entity\Group;
@@ -20,85 +24,53 @@ use Rapsys\UserBundle\Entity\Group;
 /**
  * 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;
-
+class User implements UserInterface, PasswordAuthenticatedUserInterface {
 	/**
-	 * @var bool
+	 * Primary key
 	 */
-	protected $active;
+	protected ?int $id = null;
 
 	/**
-	 * @var bool
+	 * Creation datetime
 	 */
-	protected $disabled;
+	protected \DateTime $created;
 
 	/**
-	 * @var \DateTime
+	 * Update datetime
 	 */
-	protected $created;
+	protected \DateTime $updated;
 
 	/**
-	 * @var \DateTime
+	 * Groups collection
 	 */
-	protected $updated;
-
-	/**
-	 * @var Civility
-	 */
-	protected $civility;
-
-	/**
-	 * @var ArrayCollection
-	 */
-	protected $groups;
+	protected Collection $groups;
 
 	/**
 	 * 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
 	 *
-	 * @return integer
+	 * @return ?int
 	 */
-	public function getId(): int {
+	public function getId(): ?int {
 		return $this->id;
 	}
 
@@ -106,10 +78,10 @@ class User implements UserInterface, \Serializable {
 	 * Set mail
 	 *
 	 * @param string $mail
-	 *
 	 * @return User
 	 */
 	public function setMail(string $mail): User {
+		//Set mail
 		$this->mail = $mail;
 
 		return $this;
@@ -120,40 +92,18 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return string
 	 */
-	public function getMail(): ?string {
+	public function getMail(): string {
 		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
 	 *
-	 * @param string $forename
+	 * @param ?string $forename
 	 *
 	 * @return User
 	 */
-	public function setForename(string $forename): User {
+	public function setForename(?string $forename): User {
 		$this->forename = $forename;
 
 		return $this;
@@ -162,7 +112,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Get forename
 	 *
-	 * @return string
+	 * @return ?string
 	 */
 	public function getForename(): ?string {
 		return $this->forename;
@@ -171,11 +121,11 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Set surname
 	 *
-	 * @param string $surname
+	 * @param ?string $surname
 	 *
 	 * @return User
 	 */
-	public function setSurname(string $surname): User {
+	public function setSurname(?string $surname): User {
 		$this->surname = $surname;
 
 		return $this;
@@ -184,7 +134,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Get surname
 	 *
-	 * @return string
+	 * @return ?string
 	 */
 	public function getSurname(): ?string {
 		return $this->surname;
@@ -198,19 +148,20 @@ class User implements UserInterface, \Serializable {
 	 * @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;
 	}
 
@@ -237,25 +188,25 @@ class User implements UserInterface, \Serializable {
 	}
 
 	/**
-	 * 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;
 	}
 
 	/**
@@ -305,7 +256,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Set civility
 	 */
-	public function setCivility(Civility $civility): User {
+	public function setCivility(?Civility $civility = null): User {
 		$this->civility = $civility;
 
 		return $this;
@@ -325,7 +276,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function addGroup(Group $group) {
+	public function addGroup(Group $group): User {
 		$this->groups[] = $group;
 
 		return $this;
@@ -335,17 +286,19 @@ class User implements UserInterface, \Serializable {
 	 * 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;
 	}
 
@@ -363,7 +316,7 @@ class User implements UserInterface, \Serializable {
 				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
 			[]
 		));
@@ -411,68 +364,97 @@ class User implements UserInterface, \Serializable {
 		return $this->mail;
 	}
 
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserIdentifier(): string {
+		return $this->mail;
+	}
+
 	/**
 	 * {@inheritdoc}
 	 */
 	public function eraseCredentials(): void {}
 
-	public function serialize(): string {
-		return serialize([
+	/**
+	 * {@inheritdoc}
+	 */
+	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
-		]);
+		];
 	}
 
-	public function unserialize($serialized) {
+	/**
+	 * {@inheritdoc}
+	 */
+	public function __unserialize(array $data): void {
 		list(
 			$this->id,
 			$this->mail,
+			$this->forename,
+			$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
+	 * Check if account is enabled
 	 *
-	 * It was from deprecated AdvancedUserInterface, see if it's used anymore
-	 *
-	 * @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;
 	}
 
 	/**
 	 * {@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) {
+		if (($user = $eventArgs->getObject()) instanceof User) {
 			//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
 	 *