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 Rapsys\UserBundle\Entity\Civility;
use Rapsys\UserBundle\Entity\Group;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
+
/**
* User
*/
-class User implements UserInterface, \Serializable {
- /**
- * @var integer
- */
- protected $id;
-
- /**
- * @var string
- */
- protected $mail;
-
- /**
- * @var string
- */
- protected $forename;
-
- /**
- * @var string
- */
- protected $surname;
-
+class User implements UserInterface, PasswordAuthenticatedUserInterface {
/**
- * @var string
+ * Primary key
*/
- protected $password;
+ protected ?int $id = null;
/**
- * @var bool
+ * Create datetime
*/
- protected $active;
+ protected \DateTime $created;
/**
- * @var bool
+ * Update datetime
*/
- protected $disabled;
+ protected \DateTime $updated;
/**
- * @var \DateTime
+ * Groups collection
*/
- protected $created;
-
- /**
- * @var \DateTime
- */
- 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) {
+ * @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');
/**
* Get id
*
- * @return integer
+ * @return ?int
*/
- public function getId(): int {
+ public function getId(): ?int {
return $this->id;
}
* 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;
}
/**
* 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;
/**
* 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;
/**
* Get surname
*
- * @return string
+ * @return ?string
*/
- public function getSurname(): string {
+ public function getSurname(): ?string {
return $this->surname;
}
* @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;
}
}
/**
- * 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;
}
/**
/**
* Set civility
*/
- public function setCivility(Civility $civility): User {
+ public function setCivility(?Civility $civility = null): User {
$this->civility = $civility;
return $this;
*
* @return User
*/
- public function addGroup(Group $group) {
+ public function addGroup(Group $group): User {
$this->groups[] = $group;
return $this;
* 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;
}
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
[]
));
return $this->mail;
}
+ /**
+ * {@inheritdoc}
+ */
+ public function getUserIdentifier(): string {
+ return $this->mail;
+ }
+
/**
* {@inheritdoc}
*/
/**
* {@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,
$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;
}
/**
*/
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
*
Rapsys Git / userbundle / blobdiff