BWC\Share\Symfony\Security\User\AdvancedUserAccount

Complexity

Total Complexity

61

Size/Duplication

Total Lines	603
Duplicated Lines	0 %

Coupling/Cohesion

Components	8
Dependencies	1

Importance

Changes

0

48 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	setName()	0	6	1
A	getName()	0	4	1
A	addRole()	0	13	3
A	serialize()	0	16	1
A	unserialize()	0	19	1
A	eraseCredentials()	0	4	1
A	getId()	0	4	1
A	getSalt()	0	4	1
A	getEmail()	0	4	1
A	setUsername()	0	6	1
A	getUsername()	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	9	1
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	isAccount()	0	4	2
A	removeRole()	0	9	2
A	setCredentialsExpireAt()	0	6	1
A	setCredentialsExpired()	0	6	1
A	setEmail()	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	getLocale()	0	4	1
A	setLocale()	0	6	1
A	__toString()	0	4	1
A	canonicalize()	0	4	1

<?php

namespace BWC\Share\Symfony\Security\User;

use Symfony\Component\Security\Core\Role\Role;

class AdvancedUserAccount implements AdvancedUserAccountInterface
{
    /** @var int */
    protected $id;

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

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

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

    /** @var boolean */
    protected $enabled;

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

    /**
     * Encrypted password. Must be persisted.
     * @var string
     */
    protected $password;

    /**
     * Plain password. Used for model validation. Must not be persisted.
     * @var string
     */
    protected $plainPassword;

    /** @var \DateTime */
    protected $lastLogin;

    /**
     * Random string sent to the user email address in order to verify it
     *
     * @var string
     */
    protected $confirmationToken;

    /** @var \DateTime */
    protected $passwordRequestedAt;

    /** @var boolean */
    protected $locked;

    /** @var boolean */
    protected $expired;

    /** @var \DateTime */
    protected $expiresAt;

    /** @var array */
    protected $roles;

    /** @var boolean */
    protected $credentialsExpired;

    /** @var \DateTime */
    protected $credentialsExpireAt;

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





    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;
    }



    /**
     * @param string $name
     * @return AdvancedUserAccountInterface|$this
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

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

    /**
     * @param string|Role $role
     * @return $this|AdvancedUserAccountInterface
     */
    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->id,
                $this->password,
                $this->salt,
                $this->name,
                $this->expired,
                $this->locked,
                $this->credentialsExpired,
                $this->enabled,
                $this->locale,
            )
        );
    }

    /**
     * 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->id,
            $this->password,
            $this->salt,
            $this->name,
            $this->expired,
            $this->locked,
            $this->credentialsExpired,
            $this->enabled,
            $this->locale
            ) = $data;
    }

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

    /**
     * @return mixed
     */
    public function getId()
    {
        return $this->id;
    }

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

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

    /**
     * @param string $username
     * @return AdvancedUserAccountInterface
     */
    public function setUsername($username)
    {
        $this->username = $username;

        return $this;
    }

    /**
     * Returns the username used to authenticate the user.
     *
     * @return string The username
     */
    public function getUsername()
    {
        return $this->username;
    }


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

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

    /**
     * @return \DateTime
     */
    public function getLastLogin()
    {
        return $this->lastLogin;
    }

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

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

        // 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);
    }

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

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

        return true;
    }

    /**
     * @return bool
     */
    public function isAccountNonLocked()
    {
        return !$this->locked;
    }

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

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

        return true;
    }

    /**
     * @return bool
     */
    public function isCredentialsExpired()
    {
        return !$this->isCredentialsNonExpired();
    }

    /**
     * @return bool
     */
    public function isEnabled()
    {
        return $this->enabled;
    }

    /**
     * @return bool
     */
    public function isExpired()
    {
        return !$this->isAccountNonExpired();
    }

    /**
     * @return bool
     */
    public function isLocked()
    {
        return !$this->isAccountNonLocked();
    }

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

    /**
     * @param AdvancedUserAccountInterface $account
     * @return bool
     */
    public function isAccount(AdvancedUserAccountInterface $account = null)
    {
        return null !== $account && $this->getId() === $account->getId();
    }

    /**
     * @param string $role
     * @return $this|AdvancedUserAccountInterface
     */
    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;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @param string $email
     * @return $this|AdvancedUserAccountInterface
     */
    public function setEmail($email)
    {
        $this->email = $this->canonicalize($email);

        return $this;
    }

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

        return $this;
    }

    /**
     * @param Boolean $boolean
     * @return $this|AdvancedUserAccountInterface
     */
    public function setExpired($boolean)
    {
        $this->expired = (Boolean) $boolean;

        return $this;
    }

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

        return $this;
    }

    /**
     * @param string $password
     * @return $this|AdvancedUserAccountInterface
     */
    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    /**
     * @param bool $boolean
     * @return $this|AdvancedUserAccountInterface
     */
    public function setSuperAdmin($boolean)
    {
        if (true === $boolean) {
            $this->addRole(static::ROLE_SUPER_ADMIN);
        } else {
            $this->removeRole(static::ROLE_SUPER_ADMIN);
        }

        return $this;
    }

    /**
     * @param string $password
     * @return $this|AdvancedUserAccountInterface
     */
    public function setPlainPassword($password)
    {
        $this->plainPassword = $password;

        return $this;
    }

    /**
     * @param \DateTime $time
     * @return $this|AdvancedUserAccountInterface
     */
    public function setLastLogin(\DateTime $time)
    {
        $this->lastLogin = $time;

        return $this;
    }

    /**
     * @param bool $boolean
     * @return $this|AdvancedUserAccountInterface
     */
    public function setLocked($boolean)
    {
        $this->locked = $boolean;

        return $this;
    }

    /**
     * @param string $confirmationToken
     * @return $this|AdvancedUserAccountInterface
     */
    public function setConfirmationToken($confirmationToken)
    {
        $this->confirmationToken = $confirmationToken;

        return $this;
    }

    /**
     * @param \DateTime $date
     * @return $this|AdvancedUserAccountInterface
     */
    public function setPasswordRequestedAt(\DateTime $date = null)
    {
        $this->passwordRequestedAt = $date;

        return $this;
    }

    /**
     * @return null|\DateTime
     */
    public function getPasswordRequestedAt()
    {
        return $this->passwordRequestedAt;
    }

    /**
     * @param int $ttl
     * @return bool
     */
    public function isPasswordRequestNonExpired($ttl)
    {
        return $this->getPasswordRequestedAt() instanceof \DateTime &&
        $this->getPasswordRequestedAt()->getTimestamp() + $ttl > time();
    }

    /**
     * @param array $roles
     * @return $this|AdvancedUserAccountInterface
     */
    public function setRoles(array $roles)
    {
        $this->roles = array();

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

        return $this;
    }

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

    /**
     * @param string $locale
     * @return AdvancedUserAccountInterface|$this
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;

        return $this;
    }



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


    /**
     * @param $string
     * @return string
     */
    protected function canonicalize($string)
    {
        return mb_convert_case($string, MB_CASE_LOWER, mb_detect_encoding($string));
    }
}