DP\Core\UserBundle\Entity\User

Complexity

Total Complexity

81

Size/Duplication

Total Lines	666
Duplicated Lines	2.7 %

Coupling/Cohesion

Components	7
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

55 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	addRole()	0	13	3
A	serialize()	0	14	1
A	unserialize()	0	19	1
A	eraseCredentials()	0	4	1
A	getId()	0	4	1
A	getUsername()	0	4	1
A	getUsernameCanonical()	0	4	1
A	getSalt()	0	4	1
A	getEmail()	0	4	1
A	getEmailCanonical()	0	4	1
A	getPassword()	0	4	1
A	getPlainPassword()	0	4	1
A	getLastLogin()	0	4	1
A	getConfirmationToken()	0	4	1
A	getRoles()	0	13	2
A	hasRole()	0	4	1
A	isAccountNonExpired()	0	12	4
A	isAccountNonLocked()	0	4	1
A	isCredentialsNonExpired()	0	12	4
A	isCredentialsExpired()	0	4	1
A	isEnabled()	0	4	1
A	isExpired()	0	4	1
A	isLocked()	0	4	1
A	isSuperAdmin()	0	4	1
A	isUser()	0	4	2
A	removeRole()	0	9	2
A	setUsername()	0	6	1
A	setUsernameCanonical()	0	6	1
A	setCredentialsExpireAt()	0	6	1
A	setCredentialsExpired()	0	6	1
A	setEmail()	0	6	1
A	setEmailCanonical()	0	6	1
A	setEnabled()	0	6	1
A	setExpired()	0	6	1
A	setExpiresAt()	0	6	1
A	setPassword()	0	6	1
A	setSuperAdmin()	0	10	2
A	setPlainPassword()	0	6	1
A	setLastLogin()	0	6	1
A	setLocked()	0	6	1
A	setConfirmationToken()	0	6	1
A	setPasswordRequestedAt()	0	6	1
A	getPasswordRequestedAt()	0	4	1
A	isPasswordRequestNonExpired()	0	5	2
A	setRoles()	0	10	2
A	getGroup()	0	4	1
A	setGroup()	0	6	1
A	setCreatedAt()	0	6	1
A	getCreatedAt()	0	4	1
B	setAdmin()	9	9	5
A	isAdmin()	0	4	1
B	setUserAdmin()	9	9	5
B	validateGroup()	0	15	5
A	__toString()	0	4	1

<?php

/**
 * This file is part of Dedipanel project
 *
 * (c) 2010-2015 Dedipanel <http://www.dedicated-panel.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DP\Core\UserBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use FOS\UserBundle\Model\UserInterface;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

/**
 * User
 *
 * @ORM\Table(name="user_table")
 * @ORM\Entity(repositoryClass="DP\Core\UserBundle\Entity\UserRepository")
 * @UniqueEntity(fields="usernameCanonical", errorPath="username", message="fos_user.username.already_used", groups={"Registration", "Profile"})
 * @UniqueEntity(fields="emailCanonical", errorPath="email", message="fos_user.email.already_used", groups={"Registration", "Profile"})
 */
class User implements UserInterface
{
    const ROLE_ADMIN = 'ROLE_ADMIN';

    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @var string
     *
     * @ORM\Column(name="username", type="string", length=255)
     * @Assert\NotBlank(message="user_admin.assert.username.empty", groups={"Profile","Adding","Editing"})
     * @Assert\Length(min=2, minMessage="fos_user.username.short", max=255, maxMessage="fos_user.username.long", groups={"Profile","Adding","Editing"})
     */
    protected $username;

    /**
     * @var string
     *
     * @ORM\Column(name="username_canonical", type="string", length=255, unique=true)
     */
    protected $usernameCanonical;

    /**
     * @var string
     *
     * @ORM\Column(name="email", type="string", length=255)
     * @Assert\NotBlank(message="user_admin.assert.email.empty", groups={"Adding","Editing","Profile"})
     * @Assert\Length(min=2, minMessage="fos_user.email.short", max=255, maxMessage="fos_user.email.long", groups={"Adding","Editing","Profile"})
     * @Assert\Email(message="user_admin.assert.email.valid", groups={"Adding","Editing","Profile"})
     */
    protected $email;

    /**
     * @var string
     *
     * @ORM\Column(name="email_canonical", type="string", length=255, unique=true)
     */
    protected $emailCanonical;

    /**
     * @var boolean
     *
     * @ORM\Column(name="enabled", type="boolean")
     */
    protected $enabled;

    /**
     * The salt to use for hashing
     *
     * @var string
     *
     * @ORM\Column(name="salt", type="string")
     */
    protected $salt;

    /**
     * Encrypted password. Must be persisted.
     *
     * @var string
     *
     * @ORM\Column(name="password", type="string")
     */
    protected $password;

    /**
     * Plain password. Used for model validation. Must not be persisted.
     *
     * @var string
     *
     * @Assert\NotBlank(message="user_admin.assert.password.empty", groups={"Adding"})
     * @Assert\Length(min=2, minMessage="user_admin.assert.password.short", max=4096, groups={"Adding","Profile"})
     */
    protected $plainPassword;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="last_login", type="datetime", nullable=true)
     */
    protected $lastLogin;

    /**
     * Random string sent to the user email address in order to verify it
     *
     * @var string
     *
     * @ORM\Column(name="confirmation_token", type="string", nullable=true)
     */
    protected $confirmationToken;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="password_requested_at", type="datetime", nullable=true)
     */
    protected $passwordRequestedAt;

    /**
     * @var Group
     *
     * @ORM\ManyToOne(targetEntity="DP\Core\UserBundle\Entity\Group", inversedBy="users")
     * @ORM\JoinColumn(name="group_id", referencedColumnName="id")
     */
    protected $group;

    /**
     * @var boolean
     *
     * @ORM\Column(name="locked", type="boolean")
     */
    protected $locked;

    /**
     * @var boolean
     *
     * @ORM\Column(name="expired", type="boolean")
     */
    protected $expired;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="expires_at", type="datetime", nullable=true)
     */
    protected $expiresAt;

    /**
     * @var array
     *
     * @ORM\Column(name="roles", type="array")
     */
    protected $roles;

    /**
     * @var boolean
     *
     * @ORM\Column(name="credentials_expired", type="boolean")
     */
    protected $credentialsExpired;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="credentials_expire_at", type="datetime", nullable=true)
     */
    protected $credentialsExpireAt;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="createdAt", type="datetime", nullable=true)
     */
    protected $createdAt;

    public function __construct()
    {
        $this->salt = base_convert(sha1(uniqid(mt_rand(), true)), 16, 36);
        $this->enabled = false;
        $this->locked = false;
        $this->expired = false;
        $this->roles = array();
        $this->credentialsExpired = false;
    }

    public function addRole($role)
    {
        $role = strtoupper($role);
        if ($role === static::ROLE_DEFAULT) {
            return $this;
        }

        if (!in_array($role, $this->roles, true)) {
            $this->roles[] = $role;
        }

        return $this;
    }

    /**
     * Serializes the user.
     *
     * The serialized data have to contain the fields used by the equals method and the username.
     *
     * @return string
     */
    public function serialize()
    {
        return serialize(array(
            $this->password,
            $this->salt,
            $this->usernameCanonical,
            $this->username,
            $this->expired,
            $this->locked,
            $this->credentialsExpired,
            $this->enabled,
            $this->id,
        ));
    }

    /**
     * Unserializes the user.
     *
     * @param string $serialized
     */
    public function unserialize($serialized)
    {
        $data = unserialize($serialized);
        // add a few extra elements in the array to ensure that we have enough keys when unserializing
        // older data which does not include all properties.
        $data = array_merge($data, array_fill(0, 2, null));

        list(
            $this->password,
            $this->salt,
            $this->usernameCanonical,
            $this->username,
            $this->expired,
            $this->locked,
            $this->credentialsExpired,
            $this->enabled,
            $this->id
            ) = $data;
    }

    /**
     * Removes sensitive data from the user.
     */
    public function eraseCredentials()
    {
        $this->plainPassword = null;
    }

    /**
     * Returns the user unique id.
     *
     * @return mixed
     */
    public function getId()
    {
        return $this->id;
    }

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

    public function getUsernameCanonical()
    {
        return $this->usernameCanonical;
    }

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

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

    public function getEmailCanonical()
    {
        return $this->emailCanonical;
    }

    /**
     * Gets the encrypted password.
     *
     * @return string
     */
    public function getPassword()
    {
        return $this->password;
    }

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

    /**
     * Gets the last login time.
     *
     * @return \DateTime
     */
    public function getLastLogin()
    {
        return $this->lastLogin;
    }

    public function getConfirmationToken()
    {
        return $this->confirmationToken;
    }

    /**
     * Returns the user roles
     *
     * @return array The roles
     */
    public function getRoles()
    {
        $roles = $this->roles;

        if ($this->getGroup() !== null) {
            $roles = array_merge($roles, $this->getGroup()->getRoles());
        }

        // we need to make sure to have at least one role
        $roles[] = static::ROLE_DEFAULT;

        return array_unique($roles);
    }

    /**
     * Never use this to check if this user has access to anything!
     *
     * Use the SecurityContext, or an implementation of AccessDecisionManager
     * instead, e.g.
     *
     *         $securityContext->isGranted('ROLE_USER');
     *
     * @param string $role
     *
     * @return boolean
     */
    public function hasRole($role)
    {
        return in_array(strtoupper($role), $this->getRoles(), true);
    }

    public function isAccountNonExpired()
    {
        if (true === $this->expired) {
            return false;
        }

        if (null !== $this->expiresAt && $this->expiresAt->getTimestamp() < time()) {
            return false;
        }

        return true;
    }

    public function isAccountNonLocked()
    {
        return !$this->locked;
    }

    public function isCredentialsNonExpired()
    {
        if (true === $this->credentialsExpired) {
            return false;
        }

        if (null !== $this->credentialsExpireAt && $this->credentialsExpireAt->getTimestamp() < time()) {
            return false;
        }

        return true;
    }

    public function isCredentialsExpired()
    {
        return !$this->isCredentialsNonExpired();
    }

    public function isEnabled()
    {
        return $this->enabled;
    }

    public function isExpired()
    {
        return !$this->isAccountNonExpired();
    }

    public function isLocked()
    {
        return !$this->isAccountNonLocked();
    }

    public function isSuperAdmin()
    {
        return $this->hasRole(static::ROLE_SUPER_ADMIN);
    }

    public function isUser(UserInterface $user = null)
    {
        return null !== $user && $this->getId() === $user->getId();

It seems like you code against a concrete implementation and not the interface FOS\UserBundle\Model\UserInterface as the method getId() does only exist in the following implementations of said interface: DP\Core\UserBundle\Entity\User, FOS\UserBundle\Document\User, FOS\UserBundle\Entity\User, FOS\UserBundle\Model\User, FOS\UserBundle\Tests\Doctrine\DummyUser, FOS\UserBundle\Tests\TestUser.

    }

    public function removeRole($role)
    {
        if (false !== $key = array_search(strtoupper($role), $this->roles, true)) {
            unset($this->roles[$key]);
            $this->roles = array_values($this->roles);
        }

        return $this;
    }

    public function setUsername($username)
    {
        $this->username = $username;

        return $this;
    }

    public function setUsernameCanonical($usernameCanonical)
    {
        $this->usernameCanonical = $usernameCanonical;

        return $this;
    }

    /**
     * @param \DateTime $date
     *
     * @return User
     */
    public function setCredentialsExpireAt(\DateTime $date)
    {
        $this->credentialsExpireAt = $date;

        return $this;
    }

    /**
     * @param boolean $boolean
     *
     * @return User
     */
    public function setCredentialsExpired($boolean)
    {
        $this->credentialsExpired = $boolean;

        return $this;
    }

    public function setEmail($email)
    {
        $this->email = $email;

        return $this;
    }

    public function setEmailCanonical($emailCanonical)
    {
        $this->emailCanonical = $emailCanonical;

        return $this;
    }

    public function setEnabled($boolean)
    {
        $this->enabled = (Boolean) $boolean;

        return $this;
    }

    /**
     * Sets this user to expired.
     *
     * @param Boolean $boolean
     *
     * @return User
     */
    public function setExpired($boolean)
    {
        $this->expired = (Boolean) $boolean;

        return $this;
    }

    /**
     * @param \DateTime $date
     *
     * @return User
     */
    public function setExpiresAt(\DateTime $date)
    {
        $this->expiresAt = $date;

        return $this;
    }

    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    public function setSuperAdmin($boolean)
    {
        if (true === $boolean) {
            $this->addRole(static::ROLE_SUPER_ADMIN);
        } else {
            $this->removeRole(static::ROLE_SUPER_ADMIN);
        }

        return $this;
    }

    public function setPlainPassword($password)
    {
        $this->plainPassword = $password;

        return $this;
    }

    public function setLastLogin(\DateTime $time)
    {
        $this->lastLogin = $time;

        return $this;
    }

    public function setLocked($boolean)
    {
        $this->locked = $boolean;

        return $this;
    }

    public function setConfirmationToken($confirmationToken)
    {
        $this->confirmationToken = $confirmationToken;

        return $this;
    }

    public function setPasswordRequestedAt(\DateTime $date = null)
    {
        $this->passwordRequestedAt = $date;

        return $this;
    }

    /**
     * Gets the timestamp that the user requested a password reset.
     *
     * @return null|\DateTime
     */
    public function getPasswordRequestedAt()
    {
        return $this->passwordRequestedAt;
    }

    public function isPasswordRequestNonExpired($ttl)
    {
        return $this->getPasswordRequestedAt() instanceof \DateTime &&
        $this->getPasswordRequestedAt()->getTimestamp() + $ttl > time();
    }

    public function setRoles(array $roles)
    {
        $this->roles = array();

        foreach ($roles as $role) {
            $this->addRole($role);
        }

        return $this;
    }

    /**
     * Gets the group assigned to the user.
     *
     * @return Group
     */
    public function getGroup()
    {
        return $this->group;
    }

    public function setGroup(Group $group)
    {
        $this->group = $group;

        return $this;
    }

    public function setCreatedAt(\DateTime $date)
    {
        $this->createdAt = $date;

        return $this;
    }

    public function getCreatedAt()
    {
        return $this->createdAt;
    }

    /**
     * @param bool $admin
     */
    public function setAdmin($admin)

This method seems to be duplicated in your project.

    {
        if ($admin == true && !$this->isAdmin()) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $this->addRole(static::ROLE_ADMIN);
        }
        elseif ($admin == false && $this->isAdmin()) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $this->removeRole(static::ROLE_ADMIN);
        }
    }

    /**
     * Is current user an admin ?
     *
     * @return bool
     */
    public function isAdmin()
    {
        return $this->hasRole(static::ROLE_ADMIN);
    }

    /**
     * @param bool $userAdmin
     */
    public function setUserAdmin($userAdmin)

This method seems to be duplicated in your project.

    {
        if ($userAdmin == true && !$this->isSuperAdmin()) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $this->addRole(static::ROLE_SUPER_ADMIN);
        }
        elseif ($userAdmin == false && $this->isSuperAdmin()) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $this->removeRole(static::ROLE_SUPER_ADMIN);
        }
    }

    /**
     * @Assert\Callback(groups={"Adding","Editing"})
     */
    public function validateGroup(ExecutionContextInterface $context)
    {
        if ($this->isSuperAdmin() && $this->getGroup() !== null) {
            $context->addViolationAt(

The method Symfony\Component\Validator\ExecutionContextInterface::addViolationAt() has been deprecated with message: Deprecated since version 2.5, to be removed in Symfony 3.0. Use {@link Context\ExecutionContextInterface::buildViolation()} instead.

                'group',
                'user_admin.assert.group.super_admin'
            );
        }
        elseif (!$this->isSuperAdmin() && $this->getGroup() === null) {
            $context->addViolationAt(

The method Symfony\Component\Validator\ExecutionContextInterface::addViolationAt() has been deprecated with message: Deprecated since version 2.5, to be removed in Symfony 3.0. Use {@link Context\ExecutionContextInterface::buildViolation()} instead.

                'group',
                'user_admin.assert.group.empty'
            );
        }
    }

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