BaseUser::getEmail() - Code Metrics - Inspection of "Fix user serialization" - sumocoders/FrameworkMultiUserBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#77)

unknown

created 2018-10-18 08:51 UTC

BaseUser::getEmail() A

↳ Parent: BaseUser

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace SumoCoders\FrameworkMultiUserBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Serializable;
use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
use SumoCoders\FrameworkMultiUserBundle\Security\PasswordResetToken;
use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
use SumoCoders\FrameworkMultiUserBundle\ValueObject\Status;
use Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface;
use Symfony\Component\Security\Core\User\EquatableInterface;
use Symfony\Component\Security\Core\User\UserInterface;

/**
 * @ORM\Entity(repositoryClass="SumoCoders\FrameworkMultiUserBundle\User\DoctrineBaseUserRepository")
 * @ORM\InheritanceType("JOINED")
 * @ORM\DiscriminatorColumn(name="discr", type="string")
 */
class BaseUser implements User, Serializable, EquatableInterface
{
    /**
     * @var int
     *
     * @ORM\Column(type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue
     */
    protected $id;

    /**
     * @var string
     *
     * @ORM\Column(type="string")
     */
    protected $username;

    /**
     * @var string
     *
     * @ORM\Column(type="string")
     */
    protected $password;

    /**
     * @var string
     *
     * @ORM\Column(type="string")
     */
    protected $salt;

    /**
     * @var string
     *
     * @ORM\Column(type="string")
     */
    protected $displayName;

    /**
     * @var PasswordResetToken
     *
     * @ORM\Column(type="string", nullable=true)
     */
    protected $passwordResetToken;

    /**
     * @var string
     *
     * @ORM\Column(type="string")
     */
    protected $email;

    /**
     * @var Status
     *
     * @ORM\Column(type="user_status")
     */
    protected $status;

    /**
     * @var string
     */
    protected $plainPassword;

    /**
     * @param string $username
     * @param string $plainPassword
     * @param string $displayName
     * @param string $email
     * @param int $id
     * @param PasswordResetToken $token
     */
    public function __construct(
        string $username,
        string $plainPassword,
        string $displayName,
        string $email,
        int $id = null,
        PasswordResetToken $token = null
    ) {
        $this->username = $username;
        $this->plainPassword = $plainPassword;
        $this->displayName = $displayName;
        $this->email = $email;
        $this->id = $id;

        // set the default status to active
        $this->status = Status::active();


        if ($token) {
            $this->passwordResetToken = $token;
        }
    }

    public function getRoles(): array
    {
        return ['ROLE_USER'];
    }

    public function getPassword(): string
    {
        return $this->password;
    }

    public function getSalt(): string
    {
        return $this->salt;
    }

    public function encodePassword(PasswordEncoderInterface $encoder): void
    {
        if (empty($this->plainPassword)) {
            return;
        }

        if (empty($this->salt)) {
            $this->salt = base_convert(sha1(uniqid(mt_rand(), true)), 16, 36);
        }

        $this->password = $encoder->encodePassword($this->plainPassword, $this->salt);
        $this->eraseCredentials();
    }

    public function getUsername(): string
    {
        return $this->username;
    }

    public function eraseCredentials(): void
    {
        $this->plainPassword = null;
    }

    public function getDisplayName(): string
    {
        return $this->displayName;
    }

    public function __toString(): string
    {
        return $this->getDisplayName();
    }

    public function clearPasswordResetToken(): self
    {
        $this->passwordResetToken = null;

        return $this;
    }

    public function generatePasswordResetToken(): self
    {
        $this->passwordResetToken = PasswordResetToken::generate();

        return $this;
    }

    public function getPasswordResetToken(): ?PasswordResetToken
    {
        return $this->passwordResetToken;
    }

    public function getEmail(): string
    {
        return $this->email;
    }

    public function setPassword(string $password): self
    {
        $this->plainPassword = $password;

        return $this;
    }

    public function getId(): int
    {
        return $this->id;
    }

    public function hasPlainPassword(): bool
    {
        return !empty($this->plainPassword);
    }

    public function getPlainPassword(): string
    {
        return $this->plainPassword;
    }

    public function change(UserDataTransferObject $data): void
    {
        $this->username = $data->getUserName();
        $this->plainPassword = $data->getPlainPassword();
        $this->displayName = $data->getDisplayName();
        $this->email = $data->getEmail();
    }

    public function toggleBlock(): void
    {
        if ((string) $this->status === Status::BLOCKED) {
            $this->status = Status::active();


            return;
        }

        $this->status = Status::blocked();

    }

    public function isBlocked(): bool
    {
        return $this->status->isBlocked();
    }

    public function canSwitchTo(BaseUser $user): bool

    {
        return false;
    }

    public function serialize(): string
    {
        return serialize(
            [
                $this->id,
                $this->username,
                $this->password,
                $this->salt,
            ]
        );
    }

    public function unserialize($serialized): void
    {
        [$this->id, $this->username, $this->password, $this->salt] = unserialize($serialized);
    }

    public function isEqualTo(UserInterface $user): bool
    {
        return $user->getUsername() === $this->getUsername();
    }
}


1			<?php
2
3			namespace SumoCoders\FrameworkMultiUserBundle\Entity;
4
5			use Doctrine\ORM\Mapping as ORM;
6			use Serializable;
7			use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
8			use SumoCoders\FrameworkMultiUserBundle\Security\PasswordResetToken;
9			use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
10			use SumoCoders\FrameworkMultiUserBundle\ValueObject\Status;
11			use Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface;
12			use Symfony\Component\Security\Core\User\EquatableInterface;
13			use Symfony\Component\Security\Core\User\UserInterface;
14
15			/**
16			* @ORM\Entity(repositoryClass="SumoCoders\FrameworkMultiUserBundle\User\DoctrineBaseUserRepository")
17			* @ORM\InheritanceType("JOINED")
18			* @ORM\DiscriminatorColumn(name="discr", type="string")
19			*/
20			class BaseUser implements User, Serializable, EquatableInterface
21			{
22			/**
23			* @var int
24			*
25			* @ORM\Column(type="integer")
26			* @ORM\Id
27			* @ORM\GeneratedValue
28			*/
29			protected $id;
30
31			/**
32			* @var string
33			*
34			* @ORM\Column(type="string")
35			*/
36			protected $username;
37
38			/**
39			* @var string
40			*
41			* @ORM\Column(type="string")
42			*/
43			protected $password;
44
45			/**
46			* @var string
47			*
48			* @ORM\Column(type="string")
49			*/
50			protected $salt;
51
52			/**
53			* @var string
54			*
55			* @ORM\Column(type="string")
56			*/
57			protected $displayName;
58
59			/**
60			* @var PasswordResetToken
61			*
62			* @ORM\Column(type="string", nullable=true)
63			*/
64			protected $passwordResetToken;
65
66			/**
67			* @var string
68			*
69			* @ORM\Column(type="string")
70			*/
71			protected $email;
72
73			/**
74			* @var Status
75			*
76			* @ORM\Column(type="user_status")
77			*/
78			protected $status;
79
80			/**
81			* @var string
82			*/
83			protected $plainPassword;
84
85			/**
86			* @param string $username
87			* @param string $plainPassword
88			* @param string $displayName
89			* @param string $email
90			* @param int $id
91			* @param PasswordResetToken $token
92			*/
93			public function __construct(
94			string $username,
95			string $plainPassword,
96			string $displayName,
97			string $email,
98			int $id = null,
99			PasswordResetToken $token = null
100			) {
101			$this->username = $username;
102			$this->plainPassword = $plainPassword;
103			$this->displayName = $displayName;
104			$this->email = $email;
105			$this->id = $id;
106
107			// set the default status to active
108			$this->status = Status::active();
			0 ignored issues – show Documentation Bug introduced 2017-11-16 07:56 UTC by Report Bug Copy Issue Report It seems like `\SumoCoders\FrameworkMul...Object\Status::active()` of type `object<self>` is incompatible with the declared type `object<SumoCoders\Framew...dle\ValueObject\Status>` of property `$status`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
109
110			if ($token) {
111			$this->passwordResetToken = $token;
112			}
113			}
114
115			public function getRoles(): array
116			{
117			return ['ROLE_USER'];
118			}
119
120			public function getPassword(): string
121			{
122			return $this->password;
123			}
124
125			public function getSalt(): string
126			{
127			return $this->salt;
128			}
129
130			public function encodePassword(PasswordEncoderInterface $encoder): void
131			{
132			if (empty($this->plainPassword)) {
133			return;
134			}
135
136			if (empty($this->salt)) {
137			$this->salt = base_convert(sha1(uniqid(mt_rand(), true)), 16, 36);
138			}
139
140			$this->password = $encoder->encodePassword($this->plainPassword, $this->salt);
141			$this->eraseCredentials();
142			}
143
144			public function getUsername(): string
145			{
146			return $this->username;
147			}
148
149			public function eraseCredentials(): void
150			{
151			$this->plainPassword = null;
152			}
153
154			public function getDisplayName(): string
155			{
156			return $this->displayName;
157			}
158
159			public function __toString(): string
160			{
161			return $this->getDisplayName();
162			}
163
164			public function clearPasswordResetToken(): self
165			{
166			$this->passwordResetToken = null;
167
168			return $this;
169			}
170
171			public function generatePasswordResetToken(): self
172			{
173			$this->passwordResetToken = PasswordResetToken::generate();
174
175			return $this;
176			}
177
178			public function getPasswordResetToken(): ?PasswordResetToken
179			{
180			return $this->passwordResetToken;
181			}
182
183			public function getEmail(): string
184			{
185			return $this->email;
186			}
187
188			public function setPassword(string $password): self
189			{
190			$this->plainPassword = $password;
191
192			return $this;
193			}
194
195			public function getId(): int
196			{
197			return $this->id;
198			}
199
200			public function hasPlainPassword(): bool
201			{
202			return !empty($this->plainPassword);
203			}
204
205			public function getPlainPassword(): string
206			{
207			return $this->plainPassword;
208			}
209
210			public function change(UserDataTransferObject $data): void
211			{
212			$this->username = $data->getUserName();
213			$this->plainPassword = $data->getPlainPassword();
214			$this->displayName = $data->getDisplayName();
215			$this->email = $data->getEmail();
216			}
217
218			public function toggleBlock(): void
219			{
220			if ((string) $this->status === Status::BLOCKED) {
221			$this->status = Status::active();
			0 ignored issues – show Documentation Bug introduced 2017-11-16 07:56 UTC by Report Bug Copy Issue Report It seems like `\SumoCoders\FrameworkMul...Object\Status::active()` of type `object<self>` is incompatible with the declared type `object<SumoCoders\Framew...dle\ValueObject\Status>` of property `$status`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
222
223			return;
224			}
225
226			$this->status = Status::blocked();
			0 ignored issues – show Documentation Bug introduced 2017-11-16 07:56 UTC by Report Bug Copy Issue Report It seems like `\SumoCoders\FrameworkMul...bject\Status::blocked()` of type `object<self>` is incompatible with the declared type `object<SumoCoders\Framew...dle\ValueObject\Status>` of property `$status`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
227			}
228
229			public function isBlocked(): bool
230			{
231			return $this->status->isBlocked();
232			}
233
234			public function canSwitchTo(BaseUser $user): bool
			0 ignored issues – show Unused Code introduced 2017-10-24 09:46 UTC by Report Bug Copy Issue Report The parameter `$user` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
235			{
236			return false;
237			}
238
239			public function serialize(): string
240			{
241			return serialize(
242			[
243			$this->id,
244			$this->username,
245			$this->password,
246			$this->salt,
247			]
248			);
249			}
250
251			public function unserialize($serialized): void
252			{
253			[$this->id, $this->username, $this->password, $this->salt] = unserialize($serialized);
254			}
255
256			public function isEqualTo(UserInterface $user): bool
257			{
258			return $user->getUsername() === $this->getUsername();
259			}
260			}
261

sumocoders / FrameworkMultiUserBundle

Pull Request — master (#77)

BaseUser::getEmail() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like