Sinergi\Users\User\UserEntityTrait

Complexity

Total Complexity

47

Size/Duplication

Total Lines	288
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	1

Importance

Changes

0

42 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	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	2
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()	0	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()	0	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
A	toArray()	0	11	1
A	jsonSerialize()	0	4	1

<?php

namespace Sinergi\Users\User;

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

trait UserEntityTrait
{
    protected $id;
    protected $status;
    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->setStatus(UserEntityInterface::STATUS_ACTIVE);
        $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;
    }

    /** @return string|null */
    public function getStatus()
    {
        return $this->status;
    }

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

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

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

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

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

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

    /** @return string */
    public function getPendingEmail()
    {
        return $this->pendingEmail;
    }

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

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

    public function setIsEmailConfirmed(bool $isEmailConfirmed): UserEntityInterface
    {
        $this->isEmailConfirmed = $isEmailConfirmed;
        return $this;
    }

    /** @return string */
    public function getEmailConfirmationToken()
    {
        return $this->emailConfirmationToken;
    }

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

    /** @return DateTime */
    public function getEmailConfirmationTokenExpirationDatetime()
    {
        return $this->emailConfirmationTokenExpirationDatetime;
    }

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

    /** @return DateTime */
    public function getLastEmailTokenGeneratedDatetime()
    {
        return $this->lastEmailTokenGeneratedDatetime;
    }

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

    public function canGenerateNewEmailConfirmationToken(): bool
    {
        $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;
    }

    /** @return string */
    public function getDeletedEmail()
    {
        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;
    }

    /** @return string */
    public function getPasswordResetToken()
    {
        return $this->passwordResetToken;
    }

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

    /** @return DateTime */
    public function getPasswordResetTokenExpirationDatetime()
    {
        return $this->passwordResetTokenExpirationDatetime;
    }

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

    /** @return DateTime */
    public function getLastPasswordResetTokenGeneratedDatetime()
    {
        return $this->lastPasswordResetTokenGeneratedDatetime;
    }

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

    public function canGenerateNewResetPasswordToken(): bool
    {
        $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): bool
    {
        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(),
            '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()
    {
        return $this->toArray();
    }
}