X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/fac6439a8d449e9f34f26270bd423af526ae7e21..7bd5dff399fc53ee52f78a410168916abca32447:/Entity/User.php?ds=inline diff --git a/Entity/User.php b/Entity/User.php index 9ccad72..299303b 100644 --- a/Entity/User.php +++ b/Entity/User.php @@ -11,9 +11,11 @@ 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; @@ -21,81 +23,40 @@ use Rapsys\UserBundle\Entity\Group; /** * User */ -class User implements UserInterface, \Serializable { +class User implements UserInterface, PasswordAuthenticatedUserInterface { /** - * @var integer + * @var ?integer */ - protected $id; - - /** - * @var string - */ - protected $mail; - - /** - * @var string - */ - protected $forename; - - /** - * @var string - */ - protected $surname; - - /** - * @var string - */ - protected $password; - - /** - * @var bool - */ - protected $active; - - /** - * @var bool - */ - protected $disabled; + protected ?int $id; /** * @var \DateTime */ - protected $created; + protected \DateTime $created; /** * @var \DateTime */ - protected $updated; + protected \DateTime $updated; /** - * @var Civility + * @var Doctrine\Common\Collections\Collection */ - protected $civility; - - /** - * @var ArrayCollection - */ - protected $groups; + protected Collection $groups; /** * Constructor * * @param string $mail The user mail - */ - public function __construct(string $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 - 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->disabled = false; $this->created = new \DateTime('now'); $this->updated = new \DateTime('now'); @@ -106,9 +67,9 @@ class User implements UserInterface, \Serializable { /** * Get id * - * @return integer + * @return ?int */ - public function getId(): int { + public function getId(): ?int { return $this->id; } @@ -116,22 +77,11 @@ class User implements UserInterface, \Serializable { * Set mail * * @param string $mail - * * @return User */ 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]; - } - } + //Set mail + $this->mail = $mail; return $this; } @@ -148,11 +98,11 @@ class User implements UserInterface, \Serializable { /** * 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; @@ -161,20 +111,20 @@ class User implements UserInterface, \Serializable { /** * Get forename * - * @return string + * @return ?string */ - public function getForename(): string { + public function getForename(): ?string { return $this->forename; } /** * 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; @@ -183,9 +133,9 @@ class User implements UserInterface, \Serializable { /** * Get surname * - * @return string + * @return ?string */ - public function getSurname(): string { + public function getSurname(): ?string { return $this->surname; } @@ -197,6 +147,7 @@ class User implements UserInterface, \Serializable { * @return User */ public function setPassword(string $password): User { + //Set password $this->password = $password; return $this; @@ -209,7 +160,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getPassword(): ?string { + public function getPassword(): string { return $this->password; } @@ -236,25 +187,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; } /** @@ -304,7 +255,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; @@ -324,7 +275,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function addGroup(Group $group) { + public function addGroup(Group $group): User { $this->groups[] = $group; return $this; @@ -334,17 +285,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; } @@ -362,7 +315,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 [] )); @@ -410,6 +363,13 @@ class User implements UserInterface, \Serializable { return $this->mail; } + /** + * {@inheritdoc} + */ + public function getUserIdentifier(): string { + return $this->mail; + } + /** * {@inheritdoc} */ @@ -418,24 +378,24 @@ class User implements UserInterface, \Serializable { /** * {@inheritdoc} */ - public function serialize(): string { - return serialize([ + 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 - ]); + ]; } /** * {@inheritdoc} */ - public function unserialize($serialized) { + public function __unserialize(array $data): void { list( $this->id, $this->mail, @@ -443,32 +403,28 @@ class User implements UserInterface, \Serializable { $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 - * - * It was from deprecated AdvancedUserInterface, see if it's used anymore + * Check if account is enabled * - * @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; } /** @@ -476,12 +432,28 @@ class User implements UserInterface, \Serializable { */ 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 *