Add strict

[userbundle] / Entity / User.php

diff --git a/Entity/User.php b/Entity/User.php
index 8286e55dd59c7c7cad07b03744e768459c23ff29..549b176a290795e79b11866919e0044ae7b7afd5 100644 (file)
--- a/Entity/User.php
+++ b/Entity/User.php
@@ -1,13 +1,25 @@
-<?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;
 
 namespace Rapsys\UserBundle\Entity;
 

-use Rapsys\UserBundle\Entity\Group;
-use Symfony\Component\Security\Core\User\UserInterface;

 use Doctrine\Common\Collections\ArrayCollection;
 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
 class User implements UserInterface, \Serializable {
        /**
         * @var integer


@@ -44,6 +56,11 @@ class User implements UserInterface, \Serializable {
         */
        protected $active;
 
         */
        protected $active;
 

+       /**
+        * @var bool
+        */
+       protected $disabled;
+

        /**
         * @var \DateTime
         */
        /**
         * @var \DateTime
         */


@@ -55,20 +72,24 @@ class User implements UserInterface, \Serializable {
        protected $updated;
 
        /**
        protected $updated;
 
        /**

-        * @var \Rapsys\UserBundle\Entity\Title
+        * @var Civility

         */
         */

-       protected $title;
+       protected $civility;

 
        /**
 
        /**

-        * @var \Doctrine\Common\Collections\Collection
+        * @var ArrayCollection

         */
        protected $groups;
 
        /**
         * Constructor
         */
        protected $groups;
 
        /**
         * Constructor

+        *
+        * @param string $mail The user mail

         */
         */

-       public function __construct() {
+       public function __construct(string $mail) {
+               $this->mail = $mail;

                $this->active = false;
                $this->active = false;

+               $this->disabled = false;

                $this->groups = new ArrayCollection();
        }
 
                $this->groups = new ArrayCollection();
        }
 


@@ -77,7 +98,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return integer
         */
         *
         * @return integer
         */

-       public function getId() {
+       public function getId(): int {

                return $this->id;
        }
 
                return $this->id;
        }
 


@@ -88,7 +109,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setMail($mail) {
+       public function setMail(string $mail): User {

                $this->mail = $mail;
 
                return $this;
                $this->mail = $mail;
 
                return $this;


@@ -99,7 +120,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getMail() {
+       public function getMail(): ?string {

                return $this->mail;
        }
 
                return $this->mail;
        }
 


@@ -110,7 +131,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setPseudonym($pseudonym) {
+       public function setPseudonym(string $pseudonym): User {

                $this->pseudonym = $pseudonym;
 
                return $this;
                $this->pseudonym = $pseudonym;
 
                return $this;


@@ -121,7 +142,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getPseudonym() {
+       public function getPseudonym(): ?string {

                return $this->pseudonym;
        }
 
                return $this->pseudonym;
        }
 


@@ -132,7 +153,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setForename($forename) {
+       public function setForename(string $forename): User {

                $this->forename = $forename;
 
                return $this;
                $this->forename = $forename;
 
                return $this;


@@ -143,7 +164,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getForename() {
+       public function getForename(): ?string {

                return $this->forename;
        }
 
                return $this->forename;
        }
 


@@ -154,7 +175,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setSurname($surname) {
+       public function setSurname(string $surname): User {

                $this->surname = $surname;
 
                return $this;
                $this->surname = $surname;
 
                return $this;


@@ -165,7 +186,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getSurname() {
+       public function getSurname(): ?string {

                return $this->surname;
        }
 
                return $this->surname;
        }
 


@@ -176,7 +197,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setPassword($password) {
+       public function setPassword(string $password): User {

                $this->password = $password;
 
                return $this;
                $this->password = $password;
 
                return $this;


@@ -189,7 +210,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return string
         */
         *
         * @return string
         */

-       public function getPassword() {
+       public function getPassword(): ?string {

                return $this->password;
        }
 
                return $this->password;
        }
 


@@ -200,7 +221,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setActive($active) {
+       public function setActive(bool $active): User {

                $this->active = $active;
 
                return $this;
                $this->active = $active;
 
                return $this;


@@ -211,10 +232,32 @@ class User implements UserInterface, \Serializable {
         *
         * @return bool
         */
         *
         * @return bool
         */

-       public function getActive() {
+       public function getActive(): bool {

                return $this->active;
        }
 
                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
         *
        /**
         * Set created
         *


@@ -222,7 +265,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setCreated($created) {
+       public function setCreated(\DateTime $created): User {

                $this->created = $created;
 
                return $this;
                $this->created = $created;
 
                return $this;


@@ -233,7 +276,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

-       public function getCreated() {
+       public function getCreated(): \DateTime {

                return $this->created;
        }
 
                return $this->created;
        }
 


@@ -244,7 +287,7 @@ class User implements UserInterface, \Serializable {
         *
         * @return User
         */
         *
         * @return User
         */

-       public function setUpdated($updated) {
+       public function setUpdated(\DateTime $updated): User {

                $this->updated = $updated;
 
                return $this;
                $this->updated = $updated;
 
                return $this;


@@ -255,30 +298,30 @@ class User implements UserInterface, \Serializable {
         *
         * @return \DateTime
         */
         *
         * @return \DateTime
         */

-       public function getUpdated() {
+       public function getUpdated(): \DateTime {

                return $this->updated;
        }
 
        /**
                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;
        }
 
        /**
 
                return $this;
        }
 
        /**

-        * Get title
+        * Get civility

         */
         */

-       public function getTitle(): Title {
-               return $this->title;
+       public function getCivility(): ?Civility {
+               return $this->civility;

        }
 
        /**
         * Add group
         *
        }
 
        /**
         * Add group
         *

-        * @param \Rapsys\UserBundle\Entity\Group $group
+        * @param Group $group

         *
         * @return User
         */
         *
         * @return User
         */


@@ -291,7 +334,7 @@ class User implements UserInterface, \Serializable {
        /**
         * Remove group
         *
        /**
         * Remove group
         *

-        * @param \Rapsys\UserBundle\Entity\Group $group
+        * @param Group $group

         */
        public function removeGroup(Group $group) {
                $this->groups->removeElement($group);
         */
        public function removeGroup(Group $group) {
                $this->groups->removeElement($group);


@@ -300,16 +343,16 @@ class User implements UserInterface, \Serializable {
        /**
         * Get groups
         *
        /**
         * Get groups
         *

-        * @return \Doctrine\Common\Collections\Collection
+        * @return ArrayCollection

         */
         */

-       public function getGroups() {
+       public function getGroups(): ArrayCollection {

                return $this->groups;
        }
 
        /**
         * {@inheritdoc}
         */
                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
                //Get the unique roles list by id
                return array_unique(array_reduce(
                        //Cast groups as array


@@ -326,7 +369,10 @@ class User implements UserInterface, \Serializable {
                ));
        }
 
                ));
        }
 

-       public function getRole() {
+       /**
+        * {@inheritdoc}
+        */
+       public function getRole(): ?string {

                //Retrieve roles
                $roles = $this->getRoles();
 
                //Retrieve roles
                $roles = $this->getRoles();
 


@@ -353,7 +399,7 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

-       public function getSalt() {
+       public function getSalt(): ?string {

                //No salt required with bcrypt
                return null;
        }
                //No salt required with bcrypt
                return null;
        }


@@ -361,14 +407,14 @@ class User implements UserInterface, \Serializable {
        /**
         * {@inheritdoc}
         */
        /**
         * {@inheritdoc}
         */

-       public function getUsername() {
+       public function getUsername(): string {

                return $this->mail;
        }
 
        /**
         * {@inheritdoc}
         */
                return $this->mail;
        }
 
        /**
         * {@inheritdoc}
         */

-       public function eraseCredentials() {}
+       public function eraseCredentials(): void {}

 
        public function serialize(): string {
                return serialize([
 
        public function serialize(): string {
                return serialize([


@@ -376,6 +422,7 @@ class User implements UserInterface, \Serializable {
                        $this->mail,
                        $this->password,
                        $this->active,
                        $this->mail,
                        $this->password,
                        $this->active,

+                       $this->disabled,

                        $this->created,
                        $this->updated
                ]);
                        $this->created,
                        $this->updated
                ]);


@@ -387,22 +434,51 @@ class User implements UserInterface, \Serializable {
                        $this->mail,
                        $this->password,
                        $this->active,
                        $this->mail,
                        $this->password,
                        $this->active,

+                       $this->disabled,

                        $this->created,
                        $this->updated
                ) = unserialize($serialized);
        }
 
                        $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;
        }
 
                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 {
        /**
         * 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;

        }
 }
        }
 }