Application\Entity\UserEntity

Complexity

Total Complexity

75

Size/Duplication

Total Lines	916
Duplicated Lines	0 %

Coupling/Cohesion

Components	7
Dependencies	5

Importance

Changes	19
Bugs	9	Features	2

66 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	21	1
A	getId()	0	4	1
A	setId()	0	6	1
A	getLocale()	0	4	1
A	setLocale()	0	6	1
A	getUsername()	0	4	1
A	setUsername()	0	6	1
A	getEmail()	0	4	1
A	setEmail()	0	6	1
A	getNewEmail()	0	4	1
A	setNewEmail()	0	6	1
A	getPassword()	0	4	1
A	setPassword()	0	8	2
A	getPlainPassword()	0	4	1
A	setPlainPassword()	0	17	2
A	getOldPassword()	0	4	1
A	setOldPassword()	0	6	1
A	getSalt()	0	4	1
A	setSalt()	0	6	1
A	getEnabled()	0	4	1
A	isEnabled()	0	4	1
A	setEnabled()	0	6	1
A	enable()	0	6	1
A	disable()	0	6	1
A	getLocked()	0	4	1
A	isLocked()	0	4	1
A	setLocked()	0	6	1
A	lock()	0	6	1
A	isAccountNonLocked()	0	4	1
A	getResetPasswordCode()	0	4	1
A	setResetPasswordCode()	0	6	1
A	getActivationCode()	0	4	1
A	setActivationCode()	0	6	1
A	getNewEmailCode()	0	4	1
A	setNewEmailCode()	0	6	1
A	getTimeLastActive()	0	4	1
A	setTimeLastActive()	0	6	1
A	getTimeResetPasswordCodeExpires()	0	4	1
A	setTimeResetPasswordCodeExpires()	0	6	1
A	getTimeCreated()	0	4	1
A	setTimeCreated()	0	6	1
A	getTimeUpdated()	0	4	1
A	setTimeUpdated()	0	6	1
A	getExpired()	0	4	1
A	isExpired()	0	4	1
A	isAccountNonExpired()	0	4	1
A	getCredentialsExpired()	0	4	1
A	isCredentialsExpired()	0	4	1
A	isCredentialsNonExpired()	0	4	1
A	getRoles()	0	10	2
A	setRoles()	0	6	1
A	hasRole()	0	7	1
A	getProfile()	0	4	1
A	setProfile()	0	8	1
A	getPosts()	0	4	1
A	setPosts()	0	6	1
A	getUserActions()	0	4	1
A	setUserActions()	0	6	1
B	isEqualTo()	0	24	6
A	eraseCredentials()	0	4	1
A	serialize()	0	10	1
A	unserialize()	0	9	1
A	__toString()	0	4	1
B	toArray()	0	24	2
A	preUpdate()	0	4	1
A	prePersist()	0	5	1

<?php

namespace Application\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Symfony\Component\Security\Core\User\AdvancedUserInterface;
use Symfony\Component\Security\Core\Encoder\EncoderFactory;

/**
 * User Entity.
 *
 * @ORM\Table(name="users")
 * @ORM\Entity(repositoryClass="Application\Repository\UserRepository")
 * @ORM\HasLifecycleCallbacks()
 *
 * @author Borut Balažek <bobalazek124@gmail.com>
 */
class UserEntity implements AdvancedUserInterface, \Serializable
{
    /**
     * @var int
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     */
    protected $id;

    /**
     * What is the locale for this user?
     *
     * @var string
     *
     * @ORM\Column(name="locale", type="string", length=8, nullable=true)
     */
    protected $locale = 'en_US';

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

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

    /**
     * We must confirm the new password, so temporary save it inside this field.
     *
     * @var string
     *
     * @ORM\Column(name="new_email", type="string", length=64, nullable=true)
     */
    protected $newEmail;

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

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

    /**
     * Used only when saving the user.
     *
     * @var string
     */
    protected $plainPassword;

    /**
     * Used only when saving a new password.
     *
     * @var string
     */
    protected $oldPassword;

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

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

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

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

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

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

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

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

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="time_created", type="datetime")
     */
    protected $timeCreated;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="time_updated", type="datetime")
     */
    protected $timeUpdated;

    /**
     * @ORM\OneToOne(targetEntity="Application\Entity\ProfileEntity", mappedBy="user", cascade={"all"})
     **/
    protected $profile;

    /**
     * @var ArrayCollection
     *
     * @ORM\OneToMany(targetEntity="Application\Entity\PostEntity", mappedBy="user", cascade={"all"})
     */
    protected $posts;

    /**
     * @var ArrayCollection
     *
     * @ORM\OneToMany(targetEntity="Application\Entity\UserActionEntity", mappedBy="user", cascade={"all"})
     */
    protected $userActions;

    /**
     * Otherwise known as: userExpired / accountExpired.
     *
     * @var bool
     */
    protected $expired = false;

    /**
     * @var bool
     */
    protected $credentialsExpired = false;

    /**
     * The constructor.
     */
    public function __construct()
    {
        $this->setSalt(
            md5(uniqid(null, true))
        );

        $this->setActivationCode(
            md5(uniqid(null, true))
        );

        $this->setResetPasswordCode(
            md5(uniqid(null, true))
        );

        $this->setNewEmailCode(
            md5(uniqid(null, true))
        );

        $this->posts = new ArrayCollection();
        $this->userActions = new ArrayCollection();
    }

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

    /**
     * @param int $id
     *
     * @return UserEntity
     */
    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * @param string $newEmail
     *
     * @return UserEntity
     */
    public function setNewEmail($newEmail)
    {
        $this->newEmail = $newEmail;

        return $this;
    }

    /*** Password ***/
    /**
     * @return string
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * @param string $password
     *
     * @return UserEntity
     */
    public function setPassword($password)
    {
        if ($password) {
            $this->password = $password;
        }

        return $this;
    }

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

    /**
     * @param string         $plainPassword
     * @param EncoderFactory $encoderFactory
     *
     * @return UserEntity
     */
    public function setPlainPassword($plainPassword, EncoderFactory $encoderFactory = null)
    {
        $this->plainPassword = $plainPassword;

        if ($encoderFactory) {
            $encoder = $encoderFactory->getEncoder($this);

            $password = $encoder->encodePassword(
                $this->getPlainPassword(),
                $this->getSalt()
            );

            $this->setPassword($password);
        }

        return $this;
    }

    /*** Old password ***/
    /**
     * @return string
     */
    public function getOldPassword()
    {
        return $this->oldPassword;
    }

    /**
     * @param string $oldPassword
     *
     * @return UserEntity
     */
    public function setOldPassword($oldPassword)
    {
        $this->oldPassword = $oldPassword;

        return $this;
    }

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

    /**
     * @param string $salt
     *
     * @return UserEntity
     */
    public function setSalt($salt)
    {
        $this->salt = $salt;

        return $this;
    }

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

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

    /**
     * @param bool $enabled
     */
    public function setEnabled($enabled)
    {
        $this->enabled = $enabled;

        return $this;
    }

    /**
     * @return UserEntity
     */
    public function enable()
    {
        $this->setEnabled(true);

        return $this;
    }

    /**
     * @return UserEntity
     */
    public function disable()
    {
        $this->setEnabled(false);

        return $this;
    }

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

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

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

        return $this;
    }

    /**
     * @return UserEntity
     */
    public function lock()
    {
        $this->setLocked(true);

        return $this;
    }

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

    /*** Reset password code ***/
    /**
     * @return string
     */
    public function getResetPasswordCode()
    {
        return $this->resetPasswordCode;
    }

    /**
     * @param string $resetPasswordCode
     *
     * @return UserEntity
     */
    public function setResetPasswordCode($resetPasswordCode)
    {
        $this->resetPasswordCode = $resetPasswordCode;

        return $this;
    }

    /*** Activation code ***/
    /**
     * @return string
     */
    public function getActivationCode()
    {
        return $this->activationCode;
    }

    /**
     * @param string $activationCode
     *
     * @return UserEntity
     */
    public function setActivationCode($activationCode)
    {
        $this->activationCode = $activationCode;

        return $this;
    }

    /*** New email code ***/
    /**
     * @return string
     */
    public function getNewEmailCode()
    {
        return $this->newEmailCode;
    }

    /**
     * @param string $newEmailCode
     *
     * @return UserEntity
     */
    public function setNewEmailCode($newEmailCode)
    {
        $this->newEmailCode = $newEmailCode;

        return $this;
    }

    /*** Time last active ***/
    /**
     * @return \DateTime
     */
    public function getTimeLastActive()
    {
        return $this->timeLastActive;
    }

    /**
     * @param $timeLastActive
     *
     * @return UserEntity
     */
    public function setTimeLastActive(\Datetime $timeLastActive = null)
    {
        $this->timeLastActive = $timeLastActive;

        return $this;
    }

    /*** Time reset password code expires ***/
    /**
     * @return \DateTime
     */
    public function getTimeResetPasswordCodeExpires()
    {
        return $this->timeResetPasswordCodeExpires;
    }

    /**
     * @param $timeResetPasswordCodeExpires
     *
     * @return UserEntity
     */
    public function setTimeResetPasswordCodeExpires(\Datetime $timeResetPasswordCodeExpires = null)
    {
        $this->timeResetPasswordCodeExpires = $timeResetPasswordCodeExpires;

        return $this;
    }

    /*** Time created ***/
    /**
     * @return \DateTime
     */
    public function getTimeCreated()
    {
        return $this->timeCreated;
    }

    /**
     * @param \DateTime $timeCreated
     *
     * @return UserEntity
     */
    public function setTimeCreated(\Datetime $timeCreated)
    {
        $this->timeCreated = $timeCreated;

        return $this;
    }

    /*** Time updated ***/
    /**
     * @return \DateTime
     */
    public function getTimeUpdated()
    {
        return $this->timeUpdated;
    }

    /**
     * @param \DateTime $timeUpdated
     *
     * @return UserEntity
     */
    public function setTimeUpdated(\DateTime $timeUpdated)
    {
        $this->timeUpdated = $timeUpdated;

        return $this;
    }

    /*** Expired ***/
    /**
     * @return bool
     */
    public function getExpired()
    {
        return $this->expired;
    }

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

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

    /*** Credentials expired ***/
    /**
     * @return bool
     */
    public function getCredentialsExpired()
    {
        return $this->credentialsExpired;
    }

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

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

    /*** Roles ***/
    /**
     * @return array
     */
    public function getRoles()
    {
        $roles = is_array($this->roles)
            ? $this->roles
            : array()
        ;
        $roles[] = 'ROLE_USER';

        return (array) array_unique($roles, SORT_REGULAR);
    }

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

        return $this;
    }

    /**
     * @param string $role
     *
     * @return bool
     */
    public function hasRole($role)
    {
        return in_array(
            $role,
            $this->getRoles()
        );
    }

    /*** Profile ***/
    /**
     * @return ProfileEntity
     */
    public function getProfile()
    {
        return $this->profile;
    }

    /**
     * @param ProfileEntity $profile
     *
     * @return UserEntity
     */
    public function setProfile(ProfileEntity $profile)
    {
        $this->profile = $profile;

        $this->getProfile()->setUser($this);

        return $this;
    }

    /*** Posts ***/
    /**
     * @return array
     */
    public function getPosts()
    {
        return $this->posts->toArray();
    }

    /**
     * @param ArrayCollection $posts
     *
     * @return UserEntity
     */
    public function setPosts($posts)
    {
        $this->posts = $posts;

        return $this;
    }

    /*** User actions ***/
    /**
     * @return array
     */
    public function getUserActions()
    {
        return $this->userActions->toArray();
    }

    /**
     * @param $userActions
     *
     * @return UserEntity
     */
    public function setUserActions($userActions)
    {
        $this->userActions = $userActions;

        return $this;
    }

    /**
     * @param AdvancedUserInterface $user
     *
     * @return bool
     */
    public function isEqualTo(AdvancedUserInterface $user)
    {
        if (!($user instanceof AdvancedUserInterface)) {
            return false;
        }

        if ($this->getPassword() !== $user->getPassword()) {
            return false;
        }

        if ($this->getSalt() !== $user->getSalt()) {
            return false;
        }

        if ($this->getUsername() !== $user->getUsername()) {
            return false;
        }

        if (serialize($this->getRoles()) !== serialize($user->getRoles())) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function eraseCredentials()
    {
        $this->setPlainPassword(null);
    }

    /**
     * @return string
     */
    public function serialize()
    {
        return serialize(array(
            $this->id,
            $this->username,
            $this->email,
            $this->password,
            $this->salt,
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function unserialize($serialized)
    {
        list(
            $this->id,
            $this->username,
            $this->email,
            $this->password,
            $this->salt) = unserialize($serialized);
    }

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

    /**
     * @param $allData Show all the data for this user.
     *
     * @return array
     */
    public function toArray($allData = true)
    {
        $data = array(
            'username' => $this->getUsername(),
            'email' => $this->getEmail(),
            'title' => $this->getProfile()->getTitle(),
            'first_name' => $this->getProfile()->getFirstName(),
            'middle_name' => $this->getProfile()->getMiddleName(),
            'last_name' => $this->getProfile()->getLastName(),
            'full_name' => $this->getProfile()->getFullName(),
            'gender' => $this->getProfile()->getGender(),
            'birthdate' => $this->getProfile()->getBirthdate()->format('Y-m-d'),
            'image_url' => $this->getProfile()->getImageUrl(),
        );

        if ($allData) {
            $data = array_merge($data, array(
                'id' => $this->getId(),
                'time_created' => $this->getTimeCreated()->format(DATE_ATOM),
            ));
        }

        return $data;
    }

    /**
     * @ORM\PreUpdate
     */
    public function preUpdate()
    {
        $this->setTimeUpdated(new \DateTime('now'));
    }

    /**
     * @ORM\PrePersist
     */
    public function prePersist()
    {
        $this->setTimeUpdated(new \DateTime('now'));
        $this->setTimeCreated(new \DateTime('now'));
    }
}