X-Git-Url: https://git.rapsys.eu/userbundle/blobdiff_plain/d5e370cc785ba90e35ad3c97896c62e863fd7b33..8e4e85c8806751174baf531b04ad78c51e3083dc:/Entity/User.php?ds=inline diff --git a/Entity/User.php b/Entity/User.php index cca45c7..8e6a671 100644 --- a/Entity/User.php +++ b/Entity/User.php @@ -1,13 +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 Rapsys\UserBundle\Entity\Title; +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 @@ -44,6 +56,11 @@ class User implements UserInterface, \Serializable { */ protected $active; + /** + * @var bool + */ + protected $disabled; + /** * @var \DateTime */ @@ -55,12 +72,12 @@ 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; @@ -69,6 +86,7 @@ class User implements UserInterface, \Serializable { */ public function __construct() { $this->active = false; + $this->disabled = false; $this->groups = new ArrayCollection(); } @@ -77,7 +95,7 @@ class User implements UserInterface, \Serializable { * * @return integer */ - public function getId() { + public function getId(): int { return $this->id; } @@ -88,7 +106,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setMail($mail) { + public function setMail(string $mail) { $this->mail = $mail; return $this; @@ -99,7 +117,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getMail() { + public function getMail(): ?string { return $this->mail; } @@ -110,7 +128,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setPseudonym($pseudonym) { + public function setPseudonym(string $pseudonym) { $this->pseudonym = $pseudonym; return $this; @@ -121,7 +139,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getPseudonym() { + public function getPseudonym(): ?string { return $this->pseudonym; } @@ -132,7 +150,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setForename($forename) { + public function setForename(string $forename) { $this->forename = $forename; return $this; @@ -143,7 +161,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getForename() { + public function getForename(): ?string { return $this->forename; } @@ -154,7 +172,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setSurname($surname) { + public function setSurname(string $surname) { $this->surname = $surname; return $this; @@ -165,7 +183,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getSurname() { + public function getSurname(): ?string { return $this->surname; } @@ -176,7 +194,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setPassword($password) { + public function setPassword(string $password) { $this->password = $password; return $this; @@ -189,7 +207,7 @@ class User implements UserInterface, \Serializable { * * @return string */ - public function getPassword() { + public function getPassword(): ?string { return $this->password; } @@ -200,7 +218,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setActive($active) { + public function setActive(bool $active) { $this->active = $active; return $this; @@ -211,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 * @@ -222,7 +262,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setCreated($created) { + public function setCreated(\DateTime $created) { $this->created = $created; return $this; @@ -233,7 +273,7 @@ class User implements UserInterface, \Serializable { * * @return \DateTime */ - public function getCreated() { + public function getCreated(): \DateTime { return $this->created; } @@ -244,7 +284,7 @@ class User implements UserInterface, \Serializable { * * @return User */ - public function setUpdated($updated) { + public function setUpdated(\DateTime $updated) { $this->updated = $updated; return $this; @@ -255,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 $title) { - $this->title = $title; + public function setCivility(Civility $civility) { + $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 +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); @@ -300,16 +340,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 +359,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,14 +404,14 @@ class User implements UserInterface, \Serializable { /** * {@inheritdoc} */ - public function getUsername() { + public function getUsername(): string { return $this->mail; } /** * {@inheritdoc} */ - public function eraseCredentials() {} + public function eraseCredentials(): void {} public function serialize(): string { return serialize([ @@ -369,6 +419,7 @@ class User implements UserInterface, \Serializable { $this->mail, $this->password, $this->active, + $this->disabled, $this->created, $this->updated ]); @@ -380,22 +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->title.' '.$this->forename.' '.$this->surname; + return $this->civility.' '.$this->forename.' '.$this->surname; } }