UserEntityTrait - Code Metrics - Inspection of "Added base user repository" - sinergi/users - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 28b716...7b7eb1 )

by Gabriel

created 2016-06-29 03:40 UTC

UserEntityTrait B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	292
Duplicated Lines	5.48 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	46
c	0
b	0
f	0
lcom	1
cbo	1
dl	16
loc	292
rs	8.3999

42 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getId()	0	4	1
A	setId()	0	5	1
A	getStatus()	0	4	1
A	setStatus()	0	5	1
A	isAdmin()	0	4	1
A	setIsAdmin()	0	5	1
A	isActive()	0	4	1
A	getEmail()	0	4	1
A	setEmail()	0	5	1
A	getPendingEmail()	0	4	1
A	setPendingEmail()	0	5	1
A	isEmailConfirmed()	0	4	1
A	setIsEmailConfirmed()	0	5	1
A	getEmailConfirmationToken()	0	4	1
A	setEmailConfirmationToken()	0	5	1
A	getEmailConfirmationTokenExpirationDatetime()	0	4	1
A	setEmailConfirmationTokenExpirationDatetime()	0	6	1
A	getLastEmailTokenGeneratedDatetime()	0	4	1
A	setLastEmailTokenGeneratedDatetime()	0	6	1
A	canGenerateNewEmailConfirmationToken()	8	8	2
A	generateEmailConfirmationToken()	0	8	2
A	getDeletedEmail()	0	4	1
A	setDeletedEmail()	0	5	1
A	getPassword()	0	4	1
A	setPassword()	0	6	1
A	getPasswordResetToken()	0	4	1
A	setPasswordResetToken()	0	5	1
A	getPasswordResetTokenExpirationDatetime()	0	4	1
A	setPasswordResetTokenExpirationDatetime()	0	6	1
A	getLastPasswordResetTokenGeneratedDatetime()	0	4	1
A	setLastPasswordResetTokenGeneratedDatetime()	0	6	1
A	canGenerateNewResetPasswordToken()	8	8	2
A	generatePasswordResetToken()	0	8	2
A	hashPassword()	0	8	1
A	testPassword()	0	4	1
A	getCreationDatetime()	0	4	1
A	setCreationDatetime()	0	5	1
A	getModificationDatetime()	0	4	1
A	setModificationDatetime()	0	5	1
B	toArray()	0	25	1
A	jsonSerialize()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like UserEntityTrait often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UserEntityTrait, and based on these observations, apply Extract Interface, too.

<?php

namespace Sinergi\Users\User;

use DateTime;
use Sinergi\Users\Utils\Token;

trait UserEntityTrait
{
    protected $id;
    protected $status = UserEntityInterface::STATUS_ACTIVE;
    protected $isAdmin;
    protected $email = null;
    protected $pendingEmail = null;
    protected $deletedEmail = null;
    protected $isEmailConfirmed = false;
    protected $emailConfirmationToken;
    protected $emailConfirmationTokenExpirationDatetime;
    protected $lastEmailTokenGeneratedDatetime;
    protected $password;
    protected $passwordResetToken;
    protected $passwordResetTokenExpirationDatetime;
    protected $lastPasswordResetTokenGeneratedDatetime;
    protected $creationDatetime;
    protected $modificationDatetime;

    public function __construct()
    {
        $this->setCreationDatetime(new DateTime());
        $this->setModificationDatetime(new DateTime());
    }

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

    public function setId(int $id): UserEntityInterface
    {
        $this->id = $id;
        return $this;
    }

    public function getStatus(): string
    {
        return $this->status;
    }

    public function setStatus(string $status): UserEntityInterface
    {
        $this->status = $status;
        return $this;
    }

    public function isAdmin(): boolean
    {
        return $this->isAdmin;
    }

    public function setIsAdmin(boolean $isAdmin): UserEntityInterface
    {
        $this->isAdmin = $isAdmin;
        return $this;
    }

    public function isActive(): boolean
    {
        return $this->getStatus() === UserEntityInterface::STATUS_ACTIVE;
    }

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

    public function setEmail(string $email): UserEntityInterface
    {
        $this->email = $email;
        return $this;
    }

    public function getPendingEmail(): string
    {
        return $this->pendingEmail;
    }

    public function setPendingEmail(string $pendingEmail): UserEntityInterface
    {
        $this->pendingEmail = $pendingEmail;
        return $this;
    }

    public function isEmailConfirmed(): boolean
    {
        return $this->isEmailConfirmed;
    }

    public function setIsEmailConfirmed(boolean $isEmailConfirmed): UserEntityInterface
    {
        $this->isEmailConfirmed = $isEmailConfirmed;

        return $this;
    }

    public function getEmailConfirmationToken(): string
    {
        return $this->emailConfirmationToken;
    }

    public function setEmailConfirmationToken(string $emailConfirmationToken): UserEntityInterface
    {
        $this->emailConfirmationToken = $emailConfirmationToken;
        return $this;
    }

    public function getEmailConfirmationTokenExpirationDatetime(): DateTime
    {
        return $this->emailConfirmationTokenExpirationDatetime;
    }

    public function setEmailConfirmationTokenExpirationDatetime(
        DateTime $emailConfirmationTokenExpirationDatetime
    ): UserEntityInterface {
        $this->emailConfirmationTokenExpirationDatetime = $emailConfirmationTokenExpirationDatetime;
        return $this;
    }

    public function getLastEmailTokenGeneratedDatetime(): DateTime
    {
        return $this->lastEmailTokenGeneratedDatetime;
    }

    public function setLastEmailTokenGeneratedDatetime(
        DateTime $lastEmailTokenGeneratedDatetime
    ): UserEntityInterface {
        $this->lastEmailTokenGeneratedDatetime = $lastEmailTokenGeneratedDatetime;
        return $this;
    }

    public function canGenerateNewEmailConfirmationToken(): boolean

    {
        $lastGenerated = $this->getLastEmailTokenGeneratedDatetime();
        return (
            empty($lastGenerated) ||
            (new DateTime())->getTimestamp() - $lastGenerated->getTimestamp() > UserEntityInterface::EMAIL_COOLDOWN
        );
    }

    public function generateEmailConfirmationToken(): UserEntityInterface
    {
        if ($this->canGenerateNewEmailConfirmationToken()) {
            $this->setEmailConfirmationToken(Token::generate(40));
            $this->setLastEmailTokenGeneratedDatetime(new DateTime());
        }
        return $this;
    }

    public function getDeletedEmail(): string
    {
        return $this->deletedEmail;
    }

    public function setDeletedEmail(string $deletedEmail): UserEntityInterface
    {
        $this->deletedEmail = $deletedEmail;
        return $this;
    }

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

    public function setPassword(string $password): UserEntityInterface
    {
        $this->password = $password;
        $this->hashPassword();
        return $this;
    }

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

    public function setPasswordResetToken(string $passwordResetToken): UserEntityInterface
    {
        $this->passwordResetToken = $passwordResetToken;
        return $this;
    }

    public function getPasswordResetTokenExpirationDatetime(): DateTime
    {
        return $this->passwordResetTokenExpirationDatetime;
    }

    public function setPasswordResetTokenExpirationDatetime(
        DateTime $passwordResetTokenExpirationDatetime
    ): UserEntityInterface {
        $this->passwordResetTokenExpirationDatetime = $passwordResetTokenExpirationDatetime;
        return $this;
    }

    public function getLastPasswordResetTokenGeneratedDatetime(): DateTime
    {
        return $this->lastPasswordResetTokenGeneratedDatetime;
    }

    public function setLastPasswordResetTokenGeneratedDatetime(
        DateTime $lastPasswordResetTokenGeneratedDatetime
    ): UserEntityInterface {
        $this->lastPasswordResetTokenGeneratedDatetime = $lastPasswordResetTokenGeneratedDatetime;
        return $this;
    }

    public function canGenerateNewResetPasswordToken(): boolean

    {
        $lastGenerated = $this->getLastPasswordResetTokenGeneratedDatetime();
        return (
            empty($lastGenerated) ||
            (new DateTime())->getTimestamp() - $lastGenerated->getTimestamp() > UserEntityInterface::EMAIL_COOLDOWN
        );
    }

    public function generatePasswordResetToken(): UserEntityInterface
    {
        if ($this->canGenerateNewResetPasswordToken()) {
            $this->setPasswordResetToken(Token::generate(40));
            $this->setLastPasswordResetTokenGeneratedDatetime(new DateTime());
        }
        return $this;
    }

    protected function hashPassword(): UserEntityInterface
    {
        $this->password = password_hash(
            (string) $this->password,
            PASSWORD_DEFAULT
        );
        return $this;
    }

    public function testPassword(string $password): boolean
    {
        return password_verify($password, $this->password);
    }

    public function getCreationDatetime(): DateTime
    {
        return $this->creationDatetime;
    }

    public function setCreationDatetime(DateTime $creationDatetime): UserEntityInterface
    {
        $this->creationDatetime = $creationDatetime;
        return $this;
    }

    public function getModificationDatetime(): DateTime
    {
        return $this->modificationDatetime;
    }

    public function setModificationDatetime(DateTime $modificationDatetime): UserEntityInterface
    {
        $this->modificationDatetime = $modificationDatetime;
        return $this;
    }

    public function toArray(): array
    {
        return [
            'id' => $this->getId(),
            'status' => $this->getStatus(),
            'email' => $this->getEmail(),
            'pendingEmail' => $this->getPendingEmail(),
            'deletedEmail' => $this->getDeletedEmail(),
            'isEmailConfirmed' => $this->isEmailConfirmed(),
            'emailConfirmationToken' => $this->getEmailConfirmationToken(),
            'emailConfirmationTokenExpirationDatetime' => $this->getEmailConfirmationTokenExpirationDatetime()
                ->format('Y-m-d H:i:s'),
            'lastEmailTokenGeneratedDatetime' => $this->getEmailConfirmationTokenExpirationDatetime()
                ->format('Y-m-d H:i:s'),
            'password' => $this->getPassword(),
            'passwordResetToken' => $this->getPasswordResetToken(),
            'passwordResetTokenExpirationDatetime' => $this->getPasswordResetTokenExpirationDatetime()
                ->format('Y-m-d H:i:s'),
            'lastPasswordResetTokenGeneratedDatetime' => $this->getLastPasswordResetTokenGeneratedDatetime()
                ->format('Y-m-d H:i:s'),
            'isAdmin' => $this->isAdmin(),
            'creationDatetime' => $this->getCreationDatetime()->format('Y-m-d H:i:s'),
            'modificationDatetime' => $this->getModificationDatetime()->format('Y-m-d H:i:s'),
        ];
    }

    public function jsonSerialize(): array
    {
        return $this->toArray();
    }
}


1		<?php
2
3		namespace Sinergi\Users\User;
4
5		use DateTime;
6		use Sinergi\Users\Utils\Token;
7
8		trait UserEntityTrait
9		{
10		protected $id;
11		protected $status = UserEntityInterface::STATUS_ACTIVE;
12		protected $isAdmin;
13		protected $email = null;
14		protected $pendingEmail = null;
15		protected $deletedEmail = null;
16		protected $isEmailConfirmed = false;
17		protected $emailConfirmationToken;
18		protected $emailConfirmationTokenExpirationDatetime;
19		protected $lastEmailTokenGeneratedDatetime;
20		protected $password;
21		protected $passwordResetToken;
22		protected $passwordResetTokenExpirationDatetime;
23		protected $lastPasswordResetTokenGeneratedDatetime;
24		protected $creationDatetime;
25		protected $modificationDatetime;
26
27		public function __construct()
28		{
29		$this->setCreationDatetime(new DateTime());
30		$this->setModificationDatetime(new DateTime());
31		}
32
33		public function getId(): int
34		{
35		return $this->id;
36		}
37
38		public function setId(int $id): UserEntityInterface
39		{
40		$this->id = $id;
41		return $this;
42		}
43
44		public function getStatus(): string
45		{
46		return $this->status;
47		}
48
49		public function setStatus(string $status): UserEntityInterface
50		{
51		$this->status = $status;
52		return $this;
53		}
54
55		public function isAdmin(): boolean
56		{
57		return $this->isAdmin;
58		}
59
60		public function setIsAdmin(boolean $isAdmin): UserEntityInterface
61		{
62		$this->isAdmin = $isAdmin;
63		return $this;
64		}
65
66		public function isActive(): boolean
67		{
68		return $this->getStatus() === UserEntityInterface::STATUS_ACTIVE;
69		}
70
71		public function getEmail(): string
72		{
73		return $this->email;
74		}
75
76		public function setEmail(string $email): UserEntityInterface
77		{
78		$this->email = $email;
79		return $this;
80		}
81
82		public function getPendingEmail(): string
83		{
84		return $this->pendingEmail;
85		}
86
87		public function setPendingEmail(string $pendingEmail): UserEntityInterface
88		{
89		$this->pendingEmail = $pendingEmail;
90		return $this;
91		}
92
93		public function isEmailConfirmed(): boolean
94		{
95		return $this->isEmailConfirmed;
96		}
97
98		public function setIsEmailConfirmed(boolean $isEmailConfirmed): UserEntityInterface
99		{
100		$this->isEmailConfirmed = $isEmailConfirmed;
		0 ignored issues – show Documentation Bug introduced 2016-06-29 03:50 UTC by Report Bug Copy Issue Report It seems like `$isEmailConfirmed` of type `object<Sinergi\Users\User\boolean>` is incompatible with the declared type `boolean` of property `$isEmailConfirmed`. 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...
101		return $this;
102		}
103
104		public function getEmailConfirmationToken(): string
105		{
106		return $this->emailConfirmationToken;
107		}
108
109		public function setEmailConfirmationToken(string $emailConfirmationToken): UserEntityInterface
110		{
111		$this->emailConfirmationToken = $emailConfirmationToken;
112		return $this;
113		}
114
115		public function getEmailConfirmationTokenExpirationDatetime(): DateTime
116		{
117		return $this->emailConfirmationTokenExpirationDatetime;
118		}
119
120		public function setEmailConfirmationTokenExpirationDatetime(
121		DateTime $emailConfirmationTokenExpirationDatetime
122		): UserEntityInterface {
123		$this->emailConfirmationTokenExpirationDatetime = $emailConfirmationTokenExpirationDatetime;
124		return $this;
125		}
126
127		public function getLastEmailTokenGeneratedDatetime(): DateTime
128		{
129		return $this->lastEmailTokenGeneratedDatetime;
130		}
131
132		public function setLastEmailTokenGeneratedDatetime(
133		DateTime $lastEmailTokenGeneratedDatetime
134		): UserEntityInterface {
135		$this->lastEmailTokenGeneratedDatetime = $lastEmailTokenGeneratedDatetime;
136		return $this;
137		}
138
139	View Code Duplication	public function canGenerateNewEmailConfirmationToken(): boolean
		0 ignored issues – show Duplication introduced 2016-06-29 03:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
140		{
141		$lastGenerated = $this->getLastEmailTokenGeneratedDatetime();
142		return (
143		empty($lastGenerated) \|\|
144		(new DateTime())->getTimestamp() - $lastGenerated->getTimestamp() > UserEntityInterface::EMAIL_COOLDOWN
145		);
146		}
147
148		public function generateEmailConfirmationToken(): UserEntityInterface
149		{
150		if ($this->canGenerateNewEmailConfirmationToken()) {
151		$this->setEmailConfirmationToken(Token::generate(40));
152		$this->setLastEmailTokenGeneratedDatetime(new DateTime());
153		}
154		return $this;
155		}
156
157		public function getDeletedEmail(): string
158		{
159		return $this->deletedEmail;
160		}
161
162		public function setDeletedEmail(string $deletedEmail): UserEntityInterface
163		{
164		$this->deletedEmail = $deletedEmail;
165		return $this;
166		}
167
168		public function getPassword(): string
169		{
170		return $this->password;
171		}
172
173		public function setPassword(string $password): UserEntityInterface
174		{
175		$this->password = $password;
176		$this->hashPassword();
177		return $this;
178		}
179
180		public function getPasswordResetToken(): string
181		{
182		return $this->passwordResetToken;
183		}
184
185		public function setPasswordResetToken(string $passwordResetToken): UserEntityInterface
186		{
187		$this->passwordResetToken = $passwordResetToken;
188		return $this;
189		}
190
191		public function getPasswordResetTokenExpirationDatetime(): DateTime
192		{
193		return $this->passwordResetTokenExpirationDatetime;
194		}
195
196		public function setPasswordResetTokenExpirationDatetime(
197		DateTime $passwordResetTokenExpirationDatetime
198		): UserEntityInterface {
199		$this->passwordResetTokenExpirationDatetime = $passwordResetTokenExpirationDatetime;
200		return $this;
201		}
202
203		public function getLastPasswordResetTokenGeneratedDatetime(): DateTime
204		{
205		return $this->lastPasswordResetTokenGeneratedDatetime;
206		}
207
208		public function setLastPasswordResetTokenGeneratedDatetime(
209		DateTime $lastPasswordResetTokenGeneratedDatetime
210		): UserEntityInterface {
211		$this->lastPasswordResetTokenGeneratedDatetime = $lastPasswordResetTokenGeneratedDatetime;
212		return $this;
213		}
214
215	View Code Duplication	public function canGenerateNewResetPasswordToken(): boolean
		0 ignored issues – show Duplication introduced 2016-06-29 03:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
216		{
217		$lastGenerated = $this->getLastPasswordResetTokenGeneratedDatetime();
218		return (
219		empty($lastGenerated) \|\|
220		(new DateTime())->getTimestamp() - $lastGenerated->getTimestamp() > UserEntityInterface::EMAIL_COOLDOWN
221		);
222		}
223
224		public function generatePasswordResetToken(): UserEntityInterface
225		{
226		if ($this->canGenerateNewResetPasswordToken()) {
227		$this->setPasswordResetToken(Token::generate(40));
228		$this->setLastPasswordResetTokenGeneratedDatetime(new DateTime());
229		}
230		return $this;
231		}
232
233		protected function hashPassword(): UserEntityInterface
234		{
235		$this->password = password_hash(
236		(string) $this->password,
237		PASSWORD_DEFAULT
238		);
239		return $this;
240		}
241
242		public function testPassword(string $password): boolean
243		{
244		return password_verify($password, $this->password);
245		}
246
247		public function getCreationDatetime(): DateTime
248		{
249		return $this->creationDatetime;
250		}
251
252		public function setCreationDatetime(DateTime $creationDatetime): UserEntityInterface
253		{
254		$this->creationDatetime = $creationDatetime;
255		return $this;
256		}
257
258		public function getModificationDatetime(): DateTime
259		{
260		return $this->modificationDatetime;
261		}
262
263		public function setModificationDatetime(DateTime $modificationDatetime): UserEntityInterface
264		{
265		$this->modificationDatetime = $modificationDatetime;
266		return $this;
267		}
268
269		public function toArray(): array
270		{
271		return [
272		'id' => $this->getId(),
273		'status' => $this->getStatus(),
274		'email' => $this->getEmail(),
275		'pendingEmail' => $this->getPendingEmail(),
276		'deletedEmail' => $this->getDeletedEmail(),
277		'isEmailConfirmed' => $this->isEmailConfirmed(),
278		'emailConfirmationToken' => $this->getEmailConfirmationToken(),
279		'emailConfirmationTokenExpirationDatetime' => $this->getEmailConfirmationTokenExpirationDatetime()
280		->format('Y-m-d H:i:s'),
281		'lastEmailTokenGeneratedDatetime' => $this->getEmailConfirmationTokenExpirationDatetime()
282		->format('Y-m-d H:i:s'),
283		'password' => $this->getPassword(),
284		'passwordResetToken' => $this->getPasswordResetToken(),
285		'passwordResetTokenExpirationDatetime' => $this->getPasswordResetTokenExpirationDatetime()
286		->format('Y-m-d H:i:s'),
287		'lastPasswordResetTokenGeneratedDatetime' => $this->getLastPasswordResetTokenGeneratedDatetime()
288		->format('Y-m-d H:i:s'),
289		'isAdmin' => $this->isAdmin(),
290		'creationDatetime' => $this->getCreationDatetime()->format('Y-m-d H:i:s'),
291		'modificationDatetime' => $this->getModificationDatetime()->format('Y-m-d H:i:s'),
292		];
293		}
294
295		public function jsonSerialize(): array
296		{
297		return $this->toArray();
298		}
299		}
300

sinergi / users