X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/ca1fa03aacc37a791a99bc80cefbb2e208126c1b..6699a79d7f3e958907a0f580e4685b95be79296c:/Entity/User.php

diff --git a/Entity/User.php b/Entity/User.php
index 3c1c768..4eee930 100644
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,89 +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;
 
-use Rapsys\UserBundle\Entity\Group;
-use Symfony\Component\Security\Core\User\UserInterface;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Collections\ArrayCollection;
-use Rapsys\UserBundle\Entity\Civility;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 
-class User implements UserInterface, \Serializable {
-	/**
-	 * @var integer
-	 */
-	protected $id;
+use Rapsys\UserBundle\Entity\Civility;
+use Rapsys\UserBundle\Entity\Group;
 
+/**
+ * User
+ */
+class User implements UserInterface, PasswordAuthenticatedUserInterface {
 	/**
-	 * @var string
+	 * @var ?integer
 	 */
-	protected $mail;
+	protected ?int $id;
 
 	/**
 	 * @var string
 	 */
-	protected $pseudonym;
+	protected string $mail;
 
 	/**
 	 * @var string
 	 */
-	protected $forename;
+	protected string $password;
 
 	/**
-	 * @var string
+	 * @var ?string
 	 */
-	protected $surname;
+	protected ?string $forename;
 
 	/**
-	 * @var string
+	 * @var ?string
 	 */
-	protected $password;
+	protected ?string $surname;
 
 	/**
 	 * @var bool
 	 */
-	protected $active;
+	protected bool $active;
 
 	/**
 	 * @var bool
 	 */
-	protected $disabled;
+	protected bool $disabled;
 
 	/**
 	 * @var \DateTime
 	 */
-	protected $created;
+	protected \DateTime $created;
 
 	/**
 	 * @var \DateTime
 	 */
-	protected $updated;
+	protected \DateTime $updated;
 
 	/**
-	 * @var \Rapsys\UserBundle\Entity\Civility
+	 * @var Civility
 	 */
-	protected $civility;
+	protected ?Civility $civility;
 
 	/**
-	 * @var \Doctrine\Common\Collections\ArrayCollection
+	 * @var Doctrine\Common\Collections\Collection
 	 */
-	protected $groups;
+	protected Collection $groups;
 
 	/**
 	 * Constructor
+	 *
+	 * @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() {
-		$this->active = false;
-		$this->disabled = false;
+	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
 	 *
-	 * @return integer
+	 * @return ?int
 	 */
-	public function getId(): int {
+	public function getId(): ?int {
 		return $this->id;
 	}
 
@@ -91,10 +119,10 @@ class User implements UserInterface, \Serializable {
 	 * Set mail
 	 *
 	 * @param string $mail
-	 *
 	 * @return User
 	 */
-	public function setMail(string $mail) {
+	public function setMail(string $mail): User {
+		//Set mail
 		$this->mail = $mail;
 
 		return $this;
@@ -105,40 +133,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) {
-		$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) {
+	public function setForename(?string $forename): User {
 		$this->forename = $forename;
 
 		return $this;
@@ -147,7 +153,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Get forename
 	 *
-	 * @return string
+	 * @return ?string
 	 */
 	public function getForename(): ?string {
 		return $this->forename;
@@ -156,11 +162,11 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Set surname
 	 *
-	 * @param string $surname
+	 * @param ?string $surname
 	 *
 	 * @return User
 	 */
-	public function setSurname(string $surname) {
+	public function setSurname(?string $surname): User {
 		$this->surname = $surname;
 
 		return $this;
@@ -169,7 +175,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Get surname
 	 *
-	 * @return string
+	 * @return ?string
 	 */
 	public function getSurname(): ?string {
 		return $this->surname;
@@ -182,7 +188,8 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setPassword(string $password) {
+	public function setPassword(string $password): User {
+		//Set password
 		$this->password = $password;
 
 		return $this;
@@ -195,7 +202,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return string
 	 */
-	public function getPassword(): ?string {
+	public function getPassword(): string {
 		return $this->password;
 	}
 
@@ -206,7 +213,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setActive(bool $active) {
+	public function setActive(bool $active): User {
 		$this->active = $active;
 
 		return $this;
@@ -228,7 +235,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setDisabled(bool $disabled) {
+	public function setDisabled(bool $disabled): User {
 		$this->disabled = $disabled;
 
 		return $this;
@@ -250,7 +257,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setCreated(\DateTime $created) {
+	public function setCreated(\DateTime $created): User {
 		$this->created = $created;
 
 		return $this;
@@ -272,7 +279,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setUpdated(\DateTime $updated) {
+	public function setUpdated(\DateTime $updated): User {
 		$this->updated = $updated;
 
 		return $this;
@@ -290,7 +297,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Set civility
 	 */
-	public function setCivility(Civility $civility) {
+	public function setCivility(?Civility $civility = null): User {
 		$this->civility = $civility;
 
 		return $this;
@@ -306,11 +313,11 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Add group
 	 *
-	 * @param \Rapsys\UserBundle\Entity\Group $group
+	 * @param Group $group
 	 *
 	 * @return User
 	 */
-	public function addGroup(Group $group) {
+	public function addGroup(Group $group): User {
 		$this->groups[] = $group;
 
 		return $this;
@@ -319,18 +326,20 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * 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
 	 *
-	 * @return \Doctrine\Common\Collections\ArrayCollection
+	 * @return Doctrine\Common\Collections\Collection
 	 */
-	public function getGroups(): ArrayCollection {
+	public function getGroups(): Collection {
 		return $this->groups;
 	}
 
@@ -396,33 +405,50 @@ 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->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->created,
 			$this->updated
-		) = unserialize($serialized);
+		) = $data;
 	}
 
 	/**
@@ -450,7 +476,7 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * {@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
@@ -458,6 +484,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
 	 *