Webcook\Cms\SecurityBundle\Entity\User

Complexity

Total Complexity

27

Size/Duplication

Total Lines	355
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

94.32%

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	26	1
A	getUsername()	0	4	1
A	getSalt()	0	6	1
A	getPassword()	0	4	1
A	getRoles()	0	4	1
A	eraseCredentials()	0	3	1
A	serialize()	0	12	1
A	unserialize()	0	13	1
A	getEmail()	0	4	1
A	setEmail()	0	6	1
A	getIsActive()	0	4	1
A	setIsActive()	0	6	1
A	setUsername()	0	6	1
A	setPassword()	0	6	1
A	addRole()	0	6	2
A	removeRole()	0	6	2
A	removeRoles()	0	4	1
A	getSettings()	0	4	1
A	getSettingsByName()	0	8	3
A	getPasswordResetToken()	0	4	1
A	setPasswordResetToken()	0	6	1
A	getPasswordResetExpiration()	0	4	1
A	setPasswordResetExpiration()	0	6	1

<?php

/**
 * This file is part of Webcook security bundle.
 *
 * See LICENSE file in the root of the bundle. Webcook
 */

namespace Webcook\Cms\SecurityBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Webcook\Cms\CoreBundle\Base\BasicEntity;
use Symfony\Component\Security\Core\User\UserInterface;
use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * System user entity.
 *
 * @ApiResource
 * @ORM\Table(name="SecurityUser")
 * @ORM\Entity(repositoryClass="Webcook\Cms\SecurityBundle\Entity\UserRepository")
 */
class User extends BasicEntity implements UserInterface, \Serializable
{
    /**
     * Username of the user.
     *
     * @ORM\Column(type="string", length=64, unique=true)
     * @Assert\NotNull
     * @Assert\NotBlank
     */
    private $username;

    /**
     * Password of the user.
     *
     * @ORM\Column(type="string", length=64, nullable=true)
     */
    private $password;

    /**
     * Password Reset Token of the agent.
     *
     * @ORM\Column(type="string", length=64, nullable=true)
     */
    private $passwordResetToken;

    /**
     * Password Reset Expiration of the agent.
     * @ORM\Column(name="passwordResetExpiration", type="datetime", nullable=true)
     */
    private $passwordResetExpiration;

    /**
     * Email of the user.
     *
     * @ORM\Column(type="string", length=60, unique=true)
     * @Assert\NotNull
     * @Assert\NotBlank
     */
    private $email;

    /**
     * User's roles.
     *
     * @ORM\ManyToMany(targetEntity="Role")
     */
    private $roles;

    /**
     * Tells whether user account is active or not.
     *
     * @ORM\Column(name="is_active", type="boolean", nullable=true)
     */
    private $isActive;

    /**
     * @ORM\OneToMany(targetEntity="Setting", mappedBy="user", cascade={"persist"})
     */
    private $settings;

    /**
     * Class constructor.
     */
    public function __construct()
    {
        $this->roles = new ArrayCollection();
        $this->isActive = true;
        $this->settings = new ArrayCollection();

        $timezone = new Setting();

        $timezone->setName('Timezone');
        $timezone->setKey('timezone');
        $timezone->setValue('GMT');
        $timezone->setSection('general');
        $timezone->setUser($this);

        $this->settings->add($timezone);

        $language = new Setting();

        $language->setName('language');
        $language->setKey('language');
        $language->setValue('en');
        $language->setSection('general');
        $language->setUser($this);

        $this->settings->add($language);
    }

    /**
     * Get username.
     *
     * @inheritDoc
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Get salt.
     *
     * @inheritDoc
     */
    public function getSalt()
    {
        // you *may* need a real salt depending on your encoder
        // see section on salt below
        return null;
    }

    /**
     * Get password.
     *
     * @inheritDoc
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * Get all roles.
     *
     * @inheritDoc
     */
    public function getRoles()
    {
        return $this->roles->toArray();
    }

    /**
     * Not implemented.
     *
     * @inheritDoc
     */
    public function eraseCredentials()
    {
    }

    /**
     * Serialize object into array.
     *
     * @see \Serializable::serialize()
     */
    public function serialize()
    {
        return serialize(array(
            $this->id,
            $this->username,
            $this->password,
            $this->email,
            $this->version,
            // see section on salt below
            // $this->salt,
        ));
    }

    /**
     * Unserialize array into object.
     *
     * @param $serialized
     *
     * @see \Serializable::unserialize()
     */
    public function unserialize($serialized)
    {
        list(
            $this->id,
            $this->username,
            $this->password,
            $this->email,
            $this->version,

            // see section on salt below
            // $this->salt
        ) = unserialize($serialized);
    }

    /**
     * Gets the value of email.
     *
     * @return mixed
     */
    public function getEmail()
    {
        return $this->email;
    }

    /**
     * Sets the value of email.
     *
     * @param string $email the email
     *
     * @return self
     */
    public function setEmail($email)
    {
        $this->email = $email;

        return $this;
    }

    /**
     * Gets the value of isActive.
     *
     * @return mixed
     */
    public function getIsActive()
    {
        return $this->isActive;
    }

    /**
     * Sets the value of isActive.
     *
     * @param mixed $isActive the is active
     *
     * @return self
     */
    public function setIsActive($isActive)
    {
        $this->isActive = $isActive;

        return $this;
    }

    /**
     * Sets the value of username.
     *
     * @param string $username the username
     *
     * @return self
     */
    public function setUsername($username)
    {
        $this->username = $username;

        return $this;
    }

    /**
     * Sets the value of password.
     *
     * @param mixed $password the password
     *
     * @return self
     */
    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    /**
     * Add role to the user.
     *
     * @param Role $role [description]
     */
    public function addRole(Role $role)
    {
        if (!$this->roles->contains($role)) {
            $this->roles->add($role);
        }
    }

    /**
     * Remove role.
     *
     * @param Role $role
     */
    public function removeRole(Role $role)
    {
        if ($this->roles->contains($role)) {
            $this->roles->removeElement($role);
        }
    }

    /**
     * Remove all roles.
     *
     */
    public function removeRoles()
    {
        $this->roles->clear();
    }

    /**
     * Gets the value of settings.
     *
     * @return ArrayCollection
     */
    public function getSettings()
    {
        return $this->settings;
    }

    public function getSettingsByName($name)
    {
        foreach ($this->getSettings() as &$value) {

The expression $this->getSettings() cannot be used as a reference.

            if ($value->getName() == $name) {
                return $value;
            }
        }
    }

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

    /**
     * Sets the value of password reset token.
     *
     * @param null|string $passwordResetToken the passwordResetToken
     *
     * @return self
     */
    public function setPasswordResetToken($passwordResetToken)
    {
        $this->passwordResetToken = $passwordResetToken;

        return $this;
    }

    /**
     * Get passwordResetExpiration.
     *
     * @inheritDoc
     */
    public function getPasswordResetExpiration()
    {
        return $this->passwordResetExpiration;
    }

    /**
     * Sets the value of password reset token.
     *
     * @param null|\DateTime $passwordResetExpiration the passwordResetExpiration
     *
     * @return self
     */
    public function setPasswordResetExpiration($passwordResetExpiration)
    {
        $this->passwordResetExpiration = $passwordResetExpiration;

        return $this;
    }
}