X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/d5e370cc785ba90e35ad3c97896c62e863fd7b33..c7b85c37453e97a5234a061b701f8250b86a1a4b:/Entity/User.php?ds=sidebyside
diff --git a/Entity/User.php b/Entity/User.php
index cca45c7..4393db6 100644
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,13 +1,26 @@
-<?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\ArrayCollection;
-use Rapsys\UserBundle\Entity\Title;
+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
@@ -19,11 +32,6 @@ class User implements UserInterface, \Serializable {
*/
protected $mail;
- /**
- * @var string
- */
- protected $pseudonym;
-
/**
* @var string
*/
@@ -44,6 +52,11 @@ class User implements UserInterface, \Serializable {
*/
protected $active;
+ /**
+ * @var bool
+ */
+ protected $disabled;
+
/**
* @var \DateTime
*/
@@ -55,20 +68,37 @@ class User implements UserInterface, \Serializable {
protected $updated;
/**
- * @var \Rapsys\UserBundle\Entity\Title
+ * @var Civility
*/
- protected $title;
+ protected $civility;
/**
- * @var \Doctrine\Common\Collections\Collection
+ * @var ArrayCollection
*/
protected $groups;
/**
* Constructor
- */
- public function __construct() {
+ *
+ * @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->disabled = false;
+ $this->created = new \DateTime('now');
+ $this->updated = new \DateTime('now');
+
+ //Set collections
$this->groups = new ArrayCollection();
}
@@ -77,7 +107,7 @@ class User implements UserInterface, \Serializable {
*
* @return integer
*/
- public function getId() {
+ public function getId(): int {
return $this->id;
}
@@ -88,8 +118,15 @@ class User implements UserInterface, \Serializable {
*
* @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;
}
@@ -99,32 +136,10 @@ 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
*
@@ -132,7 +147,7 @@ class User implements UserInterface, \Serializable {
*
* @return User
*/
- public function setForename($forename) {
+ public function setForename(string $forename): User {
$this->forename = $forename;
return $this;
@@ -143,7 +158,7 @@ class User implements UserInterface, \Serializable {
*
* @return string
*/
- public function getForename() {
+ public function getForename(): string {
return $this->forename;
}
@@ -154,7 +169,7 @@ class User implements UserInterface, \Serializable {
*
* @return User
*/
- public function setSurname($surname) {
+ public function setSurname(string $surname): User {
$this->surname = $surname;
return $this;
@@ -165,7 +180,7 @@ class User implements UserInterface, \Serializable {
*
* @return string
*/
- public function getSurname() {
+ public function getSurname(): string {
return $this->surname;
}
@@ -176,7 +191,7 @@ class User implements UserInterface, \Serializable {
*
* @return User
*/
- public function setPassword($password) {
+ public function setPassword(string $password): User {
$this->password = $password;
return $this;
@@ -189,7 +204,7 @@ class User implements UserInterface, \Serializable {
*
* @return string
*/
- public function getPassword() {
+ public function getPassword(): ?string {
return $this->password;
}
@@ -200,7 +215,7 @@ class User implements UserInterface, \Serializable {
*
* @return User
*/
- public function setActive($active) {
+ public function setActive(bool $active): User {
$this->active = $active;
return $this;
@@ -211,10 +226,32 @@ class User implements UserInterface, \Serializable {
*
* @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
*
@@ -222,7 +259,7 @@ class User implements UserInterface, \Serializable {
*
* @return User
*/
- public function setCreated($created) {
+ public function setCreated(\DateTime $created): User {
$this->created = $created;
return $this;
@@ -233,7 +270,7 @@ class User implements UserInterface, \Serializable {
*
* @return \DateTime
*/
- public function getCreated() {
+ public function getCreated(): \DateTime {
return $this->created;
}
@@ -244,7 +281,7 @@ class User implements UserInterface, \Serializable {
*
* @return User
*/
- public function setUpdated($updated) {
+ public function setUpdated(\DateTime $updated): User {
$this->updated = $updated;
return $this;
@@ -255,30 +292,30 @@ 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 $title) {
- $this->title = $title;
+ public function setCivility(Civility $civility): User {
+ $this->civility = $civility;
return $this;
}
/**
- * Get title
+ * Get civility
*/
- public function getTitle(): Title {
- return $this->title;
+ public function getCivility(): ?Civility {
+ return $this->civility;
}
/**
* Add group
*
- * @param \Rapsys\UserBundle\Entity\Group $group
+ * @param Group $group
*
* @return User
*/
@@ -291,7 +328,7 @@ class User implements UserInterface, \Serializable {
/**
* Remove group
*
- * @param \Rapsys\UserBundle\Entity\Group $group
+ * @param Group $group
*/
public function removeGroup(Group $group) {
$this->groups->removeElement($group);
@@ -300,16 +337,16 @@ class User implements UserInterface, \Serializable {
/**
* Get groups
*
- * @return \Doctrine\Common\Collections\Collection
+ * @return ArrayCollection
*/
- public function getGroups() {
+ public function getGroups(): ArrayCollection {
return $this->groups;
}
/**
* {@inheritdoc}
*/
- public function getRoles() {
+ public function getRoles(): array {
//Get the unique roles list by id
return array_unique(array_reduce(
//Cast groups as array
@@ -319,34 +356,44 @@ class User implements UserInterface, \Serializable {
$array[$group->getId()] = $group->getRole();
return $array;
},
- //Init with ROLE_USER
- //XXX: we assume that ROLE_USER has id 1 in database
- [ 1 => 'ROLE_USER' ]
+ //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 getRole() {
+ /**
+ * {@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 ($id > $cur) {
+ if ($cur === null || $id > $cur) {
return $id;
}
return $cur;
},
- 0
+ null
)];
}
/**
* {@inheritdoc}
*/
- public function getSalt() {
+ public function getSalt(): ?string {
//No salt required with bcrypt
return null;
}
@@ -354,48 +401,104 @@ class User implements UserInterface, \Serializable {
/**
* {@inheritdoc}
*/
- public function getUsername() {
+ public function getUsername(): string {
return $this->mail;
}
/**
* {@inheritdoc}
*/
- public function eraseCredentials() {}
+ public function eraseCredentials(): void {}
+ /**
+ * {@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);
}
- //XXX: was from vendor/symfony/security-core/User/AdvancedUserInterface.php, see if it's used anymore
- public function isEnabled() {
+ /**
+ * 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;
+ }
+
+ /**
+ * {@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'));
+ }
+ }
+
+ /**
+ * 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->title.' '.$this->forename.' '.$this->surname;
+ return $this->civility.' '.$this->forename.' '.$this->surname;
}
}