Improve disabled 403 status code response

[userbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index 6d10f33dd9be026fdc5f41eb4e4321db8e3389d2..c4c14df4f5c8240c264f3c1df9279fcd6a32f2df 100644 (file)
--- 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 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
@@ -39,11 +52,21 @@ class User implements UserInterface, \Serializable {
         */
        protected $password;
 
+       /**
+        * @var string
+        */
+       protected $slug;
+
        /**
         * @var bool
         */
        protected $active;
 
+       /**
+        * @var bool
+        */
+       protected $disabled;
+
        /**
         * @var \DateTime
         */
@@ -55,20 +78,24 @@ class User implements UserInterface, \Serializable {
        protected $updated;
 
        /**
-        * @var \Rapsys\UserBundle\Entity\Civility
+        * @var Civility
         */
        protected $civility;
 
        /**
-        * @var \Doctrine\Common\Collections\Collection
+        * @var ArrayCollection
         */
        protected $groups;
 
        /**
         * Constructor
+        *
+        * @param string $mail The user mail
         */
-       public function __construct() {
+       public function __construct(string $mail) {
+               $this->mail = $mail;
                $this->active = false;
+               $this->disabled = false;
                $this->groups = new ArrayCollection();
        }
 
@@ -77,7 +104,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return integer
         */
-       public function getId() {
+       public function getId(): int {
                return $this->id;
        }
 
@@ -88,7 +115,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
-       public function setMail($mail) {
+       public function setMail(string $mail): User {
                $this->mail = $mail;
 
                return $this;
@@ -99,7 +126,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
-       public function getMail() {
+       public function getMail(): ?string {
                return $this->mail;
        }
 
@@ -110,7 +137,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
-       public function setPseudonym($pseudonym) {
+       public function setPseudonym(string $pseudonym): User {
                $this->pseudonym = $pseudonym;
 
                return $this;
@@ -121,7 +148,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
-       public function getPseudonym() {
+       public function getPseudonym(): ?string {
                return $this->pseudonym;
        }
 
@@ -132,7 +159,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 +170,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
-       public function getForename() {
+       public function getForename(): ?string {
                return $this->forename;
        }
 
@@ -154,7 +181,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 +192,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
-       public function getSurname() {
+       public function getSurname(): ?string {
                return $this->surname;
        }
 
@@ -176,7 +203,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
-       public function setPassword($password) {
+       public function setPassword(string $password): User {
                $this->password = $password;
 
                return $this;
@@ -189,10 +216,32 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
-       public function getPassword() {
+       public function getPassword(): ?string {
                return $this->password;
        }
 
+       /**
+        * Set slug
+        *
+        * @param string $slug
+        *
+        * @return User
+        */
+       public function setSlug(?string $slug): User {
+               $this->slug = $slug;
+
+               return $this;
+       }
+
+       /**
+        * Get slug
+        *
+        * @return string
+        */
+       public function getSlug(): ?string {
+               return $this->slug;
+       }
+
        /**
         * Set active
         *
@@ -200,7 +249,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 +260,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 +293,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 +304,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
-       public function getCreated() {
+       public function getCreated(): \DateTime {
                return $this->created;
        }
 
@@ -244,7 +315,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
-       public function setUpdated($updated) {
+       public function setUpdated(\DateTime $updated): User {
                $this->updated = $updated;
 
                return $this;
@@ -255,14 +326,14 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
-       public function getUpdated() {
+       public function getUpdated(): \DateTime {
                return $this->updated;
        }
 
        /**
         * Set civility
         */
-       public function setCivility(Civility $civility) {
+       public function setCivility(Civility $civility): User {
                $this->civility = $civility;
 
                return $this;
@@ -271,14 +342,14 @@ class User implements UserInterface, \Serializable {
        /**
         * Get civility
         */
-       public function getCivility(): Civility {
+       public function getCivility(): ?Civility {
                return $this->civility;
        }
 
        /**
         * Add group
         *
-        * @param \Rapsys\UserBundle\Entity\Group $group
+        * @param Group $group
         *
         * @return User
         */
@@ -291,7 +362,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 +371,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
@@ -329,7 +400,7 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
-       public function getRole() {
+       public function getRole(): ?string {
                //Retrieve roles
                $roles = $this->getRoles();
 
@@ -356,7 +427,7 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
-       public function getSalt() {
+       public function getSalt(): ?string {
                //No salt required with bcrypt
                return null;
        }
@@ -364,14 +435,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([
@@ -379,6 +450,7 @@ class User implements UserInterface, \Serializable {
                        $this->mail,
                        $this->password,
                        $this->active,
+                       $this->disabled,
                        $this->created,
                        $this->updated
                ]);
@@ -390,16 +462,45 @@ 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(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
         *