X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/cadb2ec013de2fae74003e6764c454f37cd30c90..b303dcc7dbce3020c49aaa823ac60e4e90ad062e:/Entity/User.php?ds=sidebyside

diff --git a/Entity/User.php b/Entity/User.php
index df88e5c..5220e77 100644
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,82 +1,76 @@
-<?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 Doctrine\ORM\Event\PreUpdateEventArgs;
 
-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;
+use Rapsys\UserBundle\Entity\Civility;
+use Rapsys\UserBundle\Entity\Group;
 
-	/**
-	 * @var bool
-	 */
-	protected $active;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 
+/**
+ * User
+ */
+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 \Rapsys\UserBundle\Entity\Title
+	 * Update datetime
 	 */
-	protected $title;
+	protected \DateTime $updated;
 
 	/**
-	 * @var \Doctrine\Common\Collections\Collection
+	 * Groups collection
 	 */
-	protected $groups;
+	protected Collection $groups;
 
 	/**
-	 * User constructor.
-	 */
-	public function __construct() {
-		$this->active = false;
+	 * 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 $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() {
+	public function getId(): ?int {
 		return $this->id;
 	}
 
@@ -84,10 +78,10 @@ class User implements UserInterface, \Serializable {
 	 * Set mail
 	 *
 	 * @param string $mail
-	 *
 	 * @return User
 	 */
-	public function setMail($mail) {
+	public function setMail(string $mail): User {
+		//Set mail
 		$this->mail = $mail;
 
 		return $this;
@@ -98,40 +92,18 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return string
 	 */
-	public function getMail() {
+	public function getMail(): string {
 		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
 	 *
-	 * @param string $forename
+	 * @param ?string $forename
 	 *
 	 * @return User
 	 */
-	public function setForename($forename) {
+	public function setForename(?string $forename): User {
 		$this->forename = $forename;
 
 		return $this;
@@ -140,20 +112,20 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Get forename
 	 *
-	 * @return string
+	 * @return ?string
 	 */
-	public function getForename() {
+	public function getForename(): ?string {
 		return $this->forename;
 	}
 
 	/**
 	 * Set surname
 	 *
-	 * @param string $surname
+	 * @param ?string $surname
 	 *
 	 * @return User
 	 */
-	public function setSurname($surname) {
+	public function setSurname(?string $surname): User {
 		$this->surname = $surname;
 
 		return $this;
@@ -162,9 +134,9 @@ class User implements UserInterface, \Serializable {
 	/**
 	 * Get surname
 	 *
-	 * @return string
+	 * @return ?string
 	 */
-	public function getSurname() {
+	public function getSurname(): ?string {
 		return $this->surname;
 	}
 
@@ -175,18 +147,21 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setPassword($password) {
+	public function setPassword(string $password): User {
+		//Set password
 		$this->password = $password;
 
 		return $this;
 	}
 
 	/**
+	 * {@inheritdoc}
+	 *
 	 * Get password
 	 *
 	 * @return string
 	 */
-	public function getPassword() {
+	public function getPassword(): string {
 		return $this->password;
 	}
 
@@ -197,7 +172,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setActive($active) {
+	public function setActive(bool $active): User {
 		$this->active = $active;
 
 		return $this;
@@ -208,10 +183,32 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return bool
 	 */
-	public function getActive() {
+	public function getActive(): bool {
 		return $this->active;
 	}
 
+	/**
+	 * Set enable
+	 *
+	 * @param bool $enable
+	 *
+	 * @return User
+	 */
+	public function setEnable(bool $enable): User {
+		$this->enable = $enable;
+
+		return $this;
+	}
+
+	/**
+	 * Get enable
+	 *
+	 * @return bool
+	 */
+	public function getEnable(): bool {
+		return $this->enable;
+	}
+
 	/**
 	 * Set created
 	 *
@@ -219,7 +216,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setCreated($created) {
+	public function setCreated(\DateTime $created): User {
 		$this->created = $created;
 
 		return $this;
@@ -230,7 +227,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return \DateTime
 	 */
-	public function getCreated() {
+	public function getCreated(): \DateTime {
 		return $this->created;
 	}
 
@@ -241,7 +238,7 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return User
 	 */
-	public function setUpdated($updated) {
+	public function setUpdated(\DateTime $updated): User {
 		$this->updated = $updated;
 
 		return $this;
@@ -252,34 +249,34 @@ class User implements UserInterface, \Serializable {
 	 *
 	 * @return \DateTime
 	 */
-	public function getUpdated() {
+	public function getUpdated(): \DateTime {
 		return $this->updated;
 	}
 
 	/**
-	 * Set title
+	 * Set civility
 	 */
-	public function setTitle($title) {
-		$this->title = $title;
+	public function setCivility(?Civility $civility = null): User {
+		$this->civility = $civility;
 
 		return $this;
 	}
 
 	/**
-	 * Get title
+	 * Get civility
 	 */
-	public function getTitle() {
-		return $this->title;
+	public function getCivility(): ?Civility {
+		return $this->civility;
 	}
 
 	/**
 	 * 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;
@@ -288,67 +285,182 @@ 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\Collection
+	 * @return Doctrine\Common\Collections\Collection
 	 */
-	public function getGroups() {
+	public function getGroups(): Collection {
 		return $this->groups;
 	}
 
-	public function getRoles() {
-		$roles = [ 'ROLE_USER' ];
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getRoles(): array {
+		//Get the unique roles list by id
+		return array_unique(array_reduce(
+			//Cast groups as array
+			$this->groups->toArray(),
+			//Reduce to an array of id => group tuples
+			function ($array, $group) {
+				$array[$group->getId()] = $group->getRole();
+				return $array;
+			},
+			//Init with empty array
+			//XXX: on registration, add each group present in rapsysuser.default.group array to user
+			//XXX: see vendor/rapsys/userbundle/Controller/DefaultController.php +450
+			[]
+		));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getRole(): ?string {
+		//Retrieve roles
+		$roles = $this->getRoles();
 
-		foreach($this->groups->toArray() as $group) {
-			$roles[] = $group->getRole();
+		//With roles array empty
+		if ($roles === []) {
+			//Return null
+			return null;
 		}
 
-		return array_unique($roles);
+		//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 ($cur === null || $id > $cur) {
+					return $id;
+				}
+				return $cur;
+			},
+			null
+		)];
 	}
 
-	public function getSalt() {
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getSalt(): ?string {
 		//No salt required with bcrypt
 		return null;
 	}
 
-	public function getUsername() {
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUsername(): string {
 		return $this->mail;
 	}
 
-	public function eraseCredentials() {
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserIdentifier(): string {
+		return $this->mail;
 	}
 
-	public function serialize() {
-		return serialize(array(
+	/**
+	 * {@inheritdoc}
+	 */
+	public function eraseCredentials(): void {}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function __serialize(): array {
+		return [
 			$this->id,
 			$this->mail,
+			$this->forename,
+			$this->surname,
 			$this->password,
 			$this->active,
+			$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->enable,
 			$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;
 	}
+
+	/**
+	 * Check if account is enabled
+	 *
+	 * @see vendor/symfony/security-core/User/InMemoryUserChecker.php
+	 */
+	public function isEnabled(): bool {
+		return $this->enable;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function preUpdate(PreUpdateEventArgs $eventArgs) {
+		//Check that we have an user instance
+		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
+	 *
+	 * @return string
+	 */
+	public function __toString(): string {
+		return $this->civility.' '.$this->forename.' '.$this->surname;
+	}
 }