X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/cadb2ec013de2fae74003e6764c454f37cd30c90..71c0edfd65c95bd05705d7c037766f477aac2791:/Entity/User.php?ds=inline diff --git a/Entity/User.php b/Entity/User.php index df88e5c..8e6a671 100644 --- a/Entity/User.php +++ b/Entity/User.php @@ -1,12 +1,25 @@ - + * + * 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 Symfony\Component\Security\Core\User\UserInterface; +use Rapsys\UserBundle\Entity\Civility; +use Rapsys\UserBundle\Entity\Group; + +/** + * User + */ class User implements UserInterface, \Serializable { /** * @var integer @@ -43,6 +56,11 @@ class User implements UserInterface, \Serializable { */ protected $active; + /** + * @var bool + */ + protected $disabled; + /** * @var \DateTime */ @@ -54,20 +72,21 @@ 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; /** - * User constructor. + * Constructor */ public function __construct() { $this->active = false; + $this->disabled = false; $this->groups = new ArrayCollection(); } @@ -76,7 +95,7 @@ class User implements UserInterface, \Serializable { * * @return integer */ - public function getId() { + public function getId(): int { return $this->id; } @@ -87,7 +106,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setMail($mail) { + public function setMail(string $mail) { $this->mail = $mail; return $this; @@ -98,7 +117,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getMail() { + public function getMail(): ?string { return $this->mail; } @@ -109,7 +128,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setPseudonym($pseudonym) { + public function setPseudonym(string $pseudonym) { $this->pseudonym = $pseudonym; return $this; @@ -120,7 +139,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getPseudonym() { + public function getPseudonym(): ?string { return $this->pseudonym; } @@ -131,7 +150,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setForename($forename) { + public function setForename(string $forename) { $this->forename = $forename; return $this; @@ -142,7 +161,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getForename() { + public function getForename(): ?string { return $this->forename; } @@ -153,7 +172,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setSurname($surname) { + public function setSurname(string $surname) { $this->surname = $surname; return $this; @@ -164,7 +183,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getSurname() { + public function getSurname(): ?string { return $this->surname; } @@ -175,7 +194,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setPassword($password) { + public function setPassword(string $password) { $this->password = $password; return $this; @@ -184,9 +203,11 @@ class User implements UserInterface, \Serializable { /** * Get password * + * {@inheritdoc} + * * @return string */ - public function getPassword() { + public function getPassword(): ?string { return $this->password; } @@ -197,7 +218,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setActive($active) { + public function setActive(bool $active) { $this->active = $active; return $this; @@ -208,10 +229,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) { + $this->disabled = $disabled; + + return $this; + } + + /** + * Get disabled + * + * @return bool + */ + public function getDisabled(): bool { + return $this->disabled; + } + /** * Set created * @@ -219,7 +262,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setCreated($created) { + public function setCreated(\DateTime $created) { $this->created = $created; return $this; @@ -230,7 +273,7 @@ class User implements UserInterface, \Serializable { * * @return \DateTime */ - public function getCreated() { + public function getCreated(): \DateTime { return $this->created; } @@ -241,7 +284,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setUpdated($updated) { + public function setUpdated(\DateTime $updated) { $this->updated = $updated; return $this; @@ -252,30 +295,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) { - $this->title = $title; + public function setCivility(Civility $civility) { + $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 */ @@ -288,7 +331,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); @@ -297,43 +340,89 @@ class User implements UserInterface, \Serializable { /** * Get groups * - * @return \Doctrine\Common\Collections\Collection + * @return ArrayCollection */ - public function getGroups() { + public function getGroups(): ArrayCollection { 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 rapsys_user.default.group array to user + //XXX: see vendor/rapsys/userbundle/Controller/DefaultController.php +450 + [] + )); + } - foreach($this->groups->toArray() as $group) { - $roles[] = $group->getRole(); + /** + * {@inheritdoc} + */ + public function getRole(): ?string { + //Retrieve roles + $roles = $this->getRoles(); + + //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 eraseCredentials(): void {} - public function serialize() { - return serialize(array( + public function serialize(): string { + return serialize([ $this->id, $this->mail, $this->password, $this->active, + $this->disabled, $this->created, $this->updated - )); + ]); } public function unserialize($serialized) { @@ -342,13 +431,51 @@ class User implements UserInterface, \Serializable { $this->mail, $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(\Doctrine\ORM\Event\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 string representation of the user + * + * @return string + */ + public function __toString(): string { + return $this->civility.' '.$this->forename.' '.$this->surname; + } }