X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/bab59a4b88a081a7a27a53b4559d74e63b68db92..038e583ee27e5e1fe587c4798d5dcc7d831be5a8:/Entity/User.php?ds=inline
diff --git a/Entity/User.php b/Entity/User.php
index c6a6cdf..4393db6 100644
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,9 +1,27 @@
-<?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;
-class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterface, \Serializable {
+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;
+
+/**
+ * User
+ */
+class User implements UserInterface, \Serializable {
/**
* @var integer
*/
@@ -14,11 +32,6 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*/
protected $mail;
- /**
- * @var string
- */
- protected $pseudonym;
-
/**
* @var string
*/
@@ -39,6 +52,11 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*/
protected $active;
+ /**
+ * @var bool
+ */
+ protected $disabled;
+
/**
* @var \DateTime
*/
@@ -50,21 +68,38 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
protected $updated;
/**
- * @var \Rapsys\UserBundle\Entity\Title
+ * @var Civility
*/
- protected $title;
+ protected $civility;
/**
- * @var \Doctrine\Common\Collections\Collection
+ * @var ArrayCollection
*/
protected $groups;
/**
- * User constructor.
- */
- public function __construct() {
+ * Constructor
+ *
+ * @param string $mail The user mail
+ */
+ public function __construct(string $mail) {
+ //With mail
+ if (!empty($this->mail = $mail)) {
+ $this->password = $mail;
+ } else {
+ $this->password = '';
+ }
+
+ //Set defaults
+ $this->forename = '';
+ $this->surname = '';
$this->active = false;
- $this->groups = new \Doctrine\Common\Collections\ArrayCollection();
+ $this->disabled = false;
+ $this->created = new \DateTime('now');
+ $this->updated = new \DateTime('now');
+
+ //Set collections
+ $this->groups = new ArrayCollection();
}
/**
@@ -72,7 +107,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return integer
*/
- public function getId() {
+ public function getId(): int {
return $this->id;
}
@@ -83,8 +118,15 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setMail($mail) {
- $this->mail = $mail;
+ public function setMail(string $mail): User {
+ //With mail
+ if (!empty($this->mail = $mail)) {
+ //Without password
+ if (empty($this->password)) {
+ //Set mail as password
+ $this->password = $mail;
+ }
+ }
return $this;
}
@@ -94,32 +136,10 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @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
*
@@ -127,7 +147,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setForename($forename) {
+ public function setForename(string $forename): User {
$this->forename = $forename;
return $this;
@@ -138,7 +158,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return string
*/
- public function getForename() {
+ public function getForename(): string {
return $this->forename;
}
@@ -149,7 +169,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setSurname($surname) {
+ public function setSurname(string $surname): User {
$this->surname = $surname;
return $this;
@@ -160,7 +180,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return string
*/
- public function getSurname() {
+ public function getSurname(): string {
return $this->surname;
}
@@ -171,7 +191,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setPassword($password) {
+ public function setPassword(string $password): User {
$this->password = $password;
return $this;
@@ -180,9 +200,11 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
/**
* Get password
*
+ * {@inheritdoc}
+ *
* @return string
*/
- public function getPassword() {
+ public function getPassword(): ?string {
return $this->password;
}
@@ -193,7 +215,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setActive($active) {
+ public function setActive(bool $active): User {
$this->active = $active;
return $this;
@@ -204,10 +226,32 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return bool
*/
- public function getActive() {
+ public function getActive(): bool {
return $this->active;
}
+ /**
+ * Set disabled
+ *
+ * @param bool $disabled
+ *
+ * @return User
+ */
+ public function setDisabled(bool $disabled): User {
+ $this->disabled = $disabled;
+
+ return $this;
+ }
+
+ /**
+ * Get disabled
+ *
+ * @return bool
+ */
+ public function getDisabled(): bool {
+ return $this->disabled;
+ }
+
/**
* Set created
*
@@ -215,7 +259,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setCreated($created) {
+ public function setCreated(\DateTime $created): User {
$this->created = $created;
return $this;
@@ -226,7 +270,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return \DateTime
*/
- public function getCreated() {
+ public function getCreated(): \DateTime {
return $this->created;
}
@@ -237,7 +281,7 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @return User
*/
- public function setUpdated($updated) {
+ public function setUpdated(\DateTime $updated): User {
$this->updated = $updated;
return $this;
@@ -248,34 +292,34 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
*
* @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): 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(\Rapsys\UserBundle\Entity\Group $group) {
+ public function addGroup(Group $group) {
$this->groups[] = $group;
return $this;
@@ -284,72 +328,177 @@ class User implements \Symfony\Component\Security\Core\User\AdvancedUserInterfac
/**
* Remove group
*
- * @param \Rapsys\UserBundle\Entity\Group $group
+ * @param Group $group
*/
- public function removeGroup(\Rapsys\UserBundle\Entity\Group $group) {
+ public function removeGroup(Group $group) {
$this->groups->removeElement($group);
}
/**
* Get groups
*
- * @return \Doctrine\Common\Collections\Collection
+ * @return ArrayCollection
*/
- public function getGroups() {
+ public function getGroups(): ArrayCollection {
return $this->groups;
}
- public function getRoles() {
- return $this->groups->toArray();
+ /**
+ * {@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 rapsys_user.default.group array to user
+ //XXX: see vendor/rapsys/userbundle/Controller/DefaultController.php +450
+ []
+ ));
}
- public function getSalt() {
+ /**
+ * {@inheritdoc}
+ */
+ public function getRole(): ?string {
+ //Retrieve roles
+ $roles = $this->getRoles();
+
+ //With roles array empty
+ if ($roles === []) {
+ //Return null
+ return null;
+ }
+
+ //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
+ )];
+ }
+
+ /**
+ * {@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 eraseCredentials(): void {}
- public function serialize() {
- return serialize(array(
+ /**
+ * {@inheritdoc}
+ */
+ public function serialize(): string {
+ return serialize([
$this->id,
$this->mail,
+ $this->forename,
+ $this->surname,
$this->password,
$this->active,
+ $this->disabled,
$this->created,
$this->updated
- ));
+ ]);
}
+ /**
+ * {@inheritdoc}
+ */
public function unserialize($serialized) {
list(
$this->id,
$this->mail,
+ $this->forename,
+ $this->surname,
$this->password,
$this->active,
+ $this->disabled,
$this->created,
$this->updated
) = unserialize($serialized);
}
- public function isAccountNonExpired() {
- return true;
+ /**
+ * Check if account is activated
+ *
+ * It was from deprecated AdvancedUserInterface, see if it's used anymore
+ *
+ * @see vendor/symfony/security-core/User/AdvancedUserInterface.php
+ */
+ public function isActivated(): bool {
+ return $this->active;
+ }
+
+ /**
+ * Check if account is disabled
+ *
+ * It was from deprecated AdvancedUserInterface, see if it's used anymore
+ *
+ * @see vendor/symfony/security-core/User/AdvancedUserInterface.php
+ */
+ public function isDisabled(): bool {
+ return $this->disabled;
}
- public function isAccountNonLocked() {
- return true;
+ /**
+ * {@inheritdoc}
+ */
+ public function preUpdate(PreUpdateEventArgs $eventArgs) {
+ //Check that we have an user instance
+ if (($user = $eventArgs->getEntity()) instanceof User) {
+ //Set updated value
+ $user->setUpdated(new \DateTime('now'));
+ }
}
- public function isCredentialsNonExpired() {
- return true;
+ /**
+ * 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]);
}
- public function isEnabled() {
- return $this->active;
+ /**
+ * Returns a string representation of the user
+ *
+ * @return string
+ */
+ public function __toString(): string {
+ return $this->civility.' '.$this->forename.' '.$this->surname;
}
}