AppBundle\Entity\User

Complexity

Total Complexity

55

Size/Duplication

Total Lines	650
Duplicated Lines	0 %

Coupling/Cohesion

Components	6
Dependencies	8

Importance

Changes	10
Bugs	0	Features	0

41 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getFullDisplayName()	0	10	2
A	getFullPersonDisplayName()	0	10	2
A	getLoginUsername()	0	4	1
A	setLoginUsername()	0	6	1
A	getPassword()	0	4	1
A	setPassword()	0	6	1
A	getToken()	0	4	1
A	setToken()	0	6	1
A	getTokenValidity()	0	4	1
A	setTokenValidity()	0	6	1
A	isEnabled()	0	4	1
A	isGlobalAdministrator()	0	4	1
A	setGlobalAdministrator()	0	6	1
A	serialize()	0	9	1
A	unserialize()	0	9	1
A	isEqualTo()	0	4	1
A	getSalt()	0	4	1
A	eraseCredentials()	0	3	1
B	getRoles()	0	19	6
A	setLastLogin()	0	6	1
A	getLastLogin()	0	4	1
A	setStudentGroup()	0	6	1
A	getStudentGroup()	0	4	1
A	addTutorizedGroup()	0	9	2
A	removeTutorizedGroup()	0	7	2
A	getTutorizedGroups()	0	4	1
A	addDirect()	0	6	1
A	removeDirect()	0	4	1
A	getDirects()	0	4	1
A	validate()	0	12	3
A	getUsername()	0	4	2
A	addStudentAgreement()	0	6	1
A	removeStudentAgreement()	0	4	1
A	getStudentAgreements()	0	4	1
A	addEducationalTutorAgreement()	0	6	1
A	removeEducationalTutorAgreement()	0	4	1
A	getEducationalTutorAgreements()	0	4	1
A	addWorkTutorAgreement()	0	6	1
A	removeWorkTutorAgreement()	0	4	1
A	getWorkTutorAgreements()	0	4	1

<?php
/*
  ÁTICA - Aplicación web para la gestión documental de centros educativos

  Copyright (C) 2015-2016: Luis Ramón López López

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License
  along with this program.  If not, see [http://www.gnu.org/licenses/].
*/

namespace AppBundle\Entity;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\User\EquatableInterface;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

/**
 * @ORM\Entity(repositoryClass="UserRepository")
 * @UniqueEntity("loginUsername")
 */
class User extends Person implements UserInterface, \Serializable, EquatableInterface
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue
     * @var int
     */
    protected $id;

    /**
     * @ORM\Column(type="string", nullable=true)
     * @Assert\Regex(pattern="/[@ ]{1,}/", match=false, message="login_username.invalid_chars", htmlPattern=false)
     * @Assert\Length(min=5)
     * @var string
     */
    protected $loginUsername;

    /**
     * @ORM\Column(type="string", nullable=true)
     * @Assert\Length(min=7)
     * @var string
     */
    protected $password;

    /**
     * @ORM\Column(type="string", nullable=true)
     * @var string
     */
    protected $token;

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

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

    /**
     * @ORM\Column(type="boolean")
     * @var bool
     */
    protected $globalAdministrator;

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

    /**
     * @ORM\ManyToOne(targetEntity="Group", inversedBy="students")
     *
     * @var Group
     */
    protected $studentGroup;

    /**
     * @ORM\ManyToMany(targetEntity="Group", mappedBy="tutors")
     * @ORM\JoinTable(name="tutorized_groups")
     *
     * @var Collection
     */
    protected $tutorizedGroups;

    /**
     * @ORM\OneToMany(targetEntity="Department", mappedBy="head")
     *
     * @var Collection
     */
    protected $directs;

    /**
     * @ORM\OneToMany(targetEntity="Agreement", mappedBy="student")
     * @ORM\OrderBy({"fromDate": "ASC"})
     *
     * @var Collection
     */
    protected $studentAgreements;
    
    /**
     * @ORM\OneToMany(targetEntity="Agreement", mappedBy="educationalTutor")
     * @ORM\OrderBy({"fromDate": "ASC"})
     *
     * @var Collection
     */
    protected $educationalTutorAgreements;

    /**
     * @ORM\OneToMany(targetEntity="Agreement", mappedBy="workTutor")
     * @ORM\OrderBy({"fromDate": "ASC"})
     *
     * @var Collection
     */
    protected $workTutorAgreements;

    /**
     * Constructor
     */
    public function __construct()
    {
        parent::__construct();

        $this->tutorizedGroups = new \Doctrine\Common\Collections\ArrayCollection();
        $this->directs = new \Doctrine\Common\Collections\ArrayCollection();
        $this->studentAgreements = new \Doctrine\Common\Collections\ArrayCollection();
    }

    /**
     * Returns the person's display name
     *
     * @return string
     */
    public function getFullDisplayName()
    {
        $displayName = (string) $this;

        if (null !== $this->getStudentGroup()) {
            $displayName .= ' (' . (string) $this->getStudentGroup() . ')';
        }

        return $displayName;
    }

    /**
     * Returns the person's display name
     *
     * @return string
     */
    public function getFullPersonDisplayName()
    {
        $displayName = (string) $this;

        if (null !== $this->getReference()) {
            $displayName .= ' (' . $this->getReference() . ')';
        }

        return $displayName;
    }

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

    /**
     * Get login username
     *
     * @return string
     */
    public function getLoginUsername()
    {
        return $this->loginUsername;
    }

    /**
     * Set login username
     *
     * @param string $loginUsername
     *
     * @return User
     */
    public function setLoginUsername($loginUsername)
    {
        $this->loginUsername = $loginUsername;

        return $this;
    }

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

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

        return $this;
    }

    /**
     * Get token
     *
     * @return string
     */
    public function getToken()
    {
        return $this->token;
    }

    /**
     * Set token
     *
     * @param string $token
     *
     * @return User
     */
    public function setToken($token)
    {
        $this->token = $token;

        return $this;
    }

    /**
     * Get tokenValidity
     *
     * @return \DateTime
     */
    public function getTokenValidity()
    {
        return $this->tokenValidity;
    }

    /**
     * Set tokenValidity
     *
     * @param \DateTime $tokenValidity
     *
     * @return User
     */
    public function setTokenValidity($tokenValidity)
    {
        $this->tokenValidity = $tokenValidity;

        return $this;
    }

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

    /**
     * Set enabled
     *
     * @param boolean $enabled
     *
     * @return User
     */
    public function setEnabled($enabled)
    {
        $this->enabled = $enabled;

        return $this;
    }

    /**
     * Get globalAdministrator
     *
     * @return boolean
     */
    public function isGlobalAdministrator()
    {
        return $this->globalAdministrator;
    }

    /**
     * Set globalAdministrator
     *
     * @param boolean $globalAdministrator
     *
     * @return User
     */
    public function setGlobalAdministrator($globalAdministrator)
    {
        $this->globalAdministrator = $globalAdministrator;

        return $this;
    }

    /**
     * String representation of object
     * @link http://php.net/manual/en/serializable.serialize.php
     * @return string the string representation of the object or null
     * @since 5.1.0
     */
    public function serialize()
    {
        return serialize(array(
            $this->id,
            $this->email,
            $this->loginUsername,
            $this->password
        ));
    }

    /**
     * Constructs the object
     * @link http://php.net/manual/en/serializable.unserialize.php
     * @param string $serialized <p>
     * The string representation of the object.
     * </p>
     * @return void
     * @since 5.1.0
     */
    public function unserialize($serialized)
    {
        list (
            $this->id,
            $this->email,
            $this->loginUsername,
            $this->password
        ) = unserialize($serialized);
    }

    /**
     * The equality comparison should neither be done by referential equality
     * nor by comparing identities (i.e. getId() === getId()).
     *
     * However, you do not need to compare every attribute, but only those that
     * are relevant for assessing whether re-authentication is required.
     *
     * Also implementation should consider that $user instance may implement
     * the extended user interface `AdvancedUserInterface`.
     *
     * @param UserInterface $user
     *
     * @return bool
     */
    public function isEqualTo(UserInterface $user)
    {
        return ($this->getRoles() === $user->getRoles());
    }

    /**
     * Returns the salt that was originally used to encode the password.
     *
     * This can return null if the password was not encoded using a salt.
     *
     * @return string|null The salt
     */
    public function getSalt()
    {
        return null;
    }

    /**
     * Removes sensitive data from the user.
     *
     * This is important if, at any given point, sensitive information like
     * the plain-text password is stored on this object.
     */
    public function eraseCredentials()
    {
    }

    /**
     * Returns the roles granted to the user.
     *
     * @return Role[] The user roles
     */
    public function getRoles()
    {
        // Always return ROLE_USER
        $roles = [new Role('ROLE_USER')];

        if ($this->isGlobalAdministrator()) {
            $roles[] = new Role('ROLE_ADMIN');
        }

        if ($this->tutorizedGroups && $this->tutorizedGroups->count()) {
            $roles[] = new Role('ROLE_GROUP_TUTOR');
        }

        if ($this->directs && $this->directs->count()) {
            $roles[] = new Role('ROLE_DEPARTMENT_HEAD');
        }

        return $roles;
    }

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

        return $this;
    }

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

    /**
     * Set group
     *
     * @param Group $group
     *
     * @return User
     */
    public function setStudentGroup(Group $group = null)
    {
        $this->studentGroup = $group;

        return $this;
    }

    /**
     * Get group
     *
     * @return Group
     */
    public function getStudentGroup()
    {
        return $this->studentGroup;
    }

    /**
     * Add tutorizedGroup
     *
     * @param Group $tutorizedGroup
     *
     * @return User
     */
    public function addTutorizedGroup(Group $tutorizedGroup)

This method seems to be duplicated in your project.

    {
        if (false === $this->tutorizedGroups->contains($tutorizedGroup)) {
            $this->tutorizedGroups[] = $tutorizedGroup;
            $tutorizedGroup->addTutor($this);
        }

        return $this;
    }

    /**
     * Remove tutorizedGroup
     *
     * @param Group $tutorizedGroup
     */
    public function removeTutorizedGroup(Group $tutorizedGroup)

This method seems to be duplicated in your project.

    {
        if (true === $this->tutorizedGroups->contains($tutorizedGroup)) {
            $this->tutorizedGroups->removeElement($tutorizedGroup);
            $tutorizedGroup->removeTutor($this);
        }
    }

    /**
     * Get tutorizedGroups
     *
     * @return Collection
     */
    public function getTutorizedGroups()
    {
        return $this->tutorizedGroups;
    }

    /**
     * Add direct
     *
     * @param Department $direct
     *
     * @return User
     */
    public function addDirect(Department $direct)
    {
        $this->directs[] = $direct;

        return $this;
    }

    /**
     * Remove direct
     *
     * @param Department $direct
     */
    public function removeDirect(Department $direct)
    {
        $this->directs->removeElement($direct);
    }

    /**
     * Get directs
     *
     * @return Collection
     */
    public function getDirects()
    {
        return $this->directs;
    }

    /**
     * @Assert\Callback
     */
    public function validate(ExecutionContextInterface $context)
    {
        // comprobar si se ha especificado al menos el nombre de usuario o el correo electrónico
        if (!$this->getLoginUsername() && !$this->getEmail()) {
            $context->buildViolation('user.id.not_found')
                ->atPath('loginUsername')
                ->addViolation();
            $context->buildViolation('user.id.not_found')
                ->atPath('email')
                ->addViolation();
        }
    }

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

    /**
     * Add studentAgreement
     *
     * @param Agreement $studentAgreement
     *
     * @return User
     */
    public function addStudentAgreement(Agreement $studentAgreement)
    {
        $this->studentAgreements[] = $studentAgreement;

        return $this;
    }

    /**
     * Remove studentAgreement
     *
     * @param Agreement $studentAgreement
     */
    public function removeStudentAgreement(Agreement $studentAgreement)
    {
        $this->studentAgreements->removeElement($studentAgreement);
    }

    /**
     * Get studentAgreements
     *
     * @return Collection
     */
    public function getStudentAgreements()
    {
        return $this->studentAgreements;
    }

    /**
     * Add educationalTutorAgreement
     *
     * @param \AppBundle\Entity\Agreement $educationalTutorAgreement
     *
     * @return User
     */
    public function addEducationalTutorAgreement(\AppBundle\Entity\Agreement $educationalTutorAgreement)
    {
        $this->educationalTutorAgreements[] = $educationalTutorAgreement;

        return $this;
    }

    /**
     * Remove educationalTutorAgreement
     *
     * @param \AppBundle\Entity\Agreement $educationalTutorAgreement
     */
    public function removeEducationalTutorAgreement(\AppBundle\Entity\Agreement $educationalTutorAgreement)
    {
        $this->educationalTutorAgreements->removeElement($educationalTutorAgreement);
    }

    /**
     * Get educationalTutorAgreements
     *
     * @return \Doctrine\Common\Collections\Collection
     */
    public function getEducationalTutorAgreements()
    {
        return $this->educationalTutorAgreements;
    }

    /**
     * Add workTutorAgreement
     *
     * @param \AppBundle\Entity\Agreement $workTutorAgreement
     *
     * @return User
     */
    public function addWorkTutorAgreement(\AppBundle\Entity\Agreement $workTutorAgreement)
    {
        $this->workTutorAgreements[] = $workTutorAgreement;

        return $this;
    }

    /**
     * Remove workTutorAgreement
     *
     * @param \AppBundle\Entity\Agreement $workTutorAgreement
     */
    public function removeWorkTutorAgreement(\AppBundle\Entity\Agreement $workTutorAgreement)
    {
        $this->workTutorAgreements->removeElement($workTutorAgreement);
    }

    /**
     * Get workTutorAgreements
     *
     * @return \Doctrine\Common\Collections\Collection
     */
    public function getWorkTutorAgreements()
    {
        return $this->workTutorAgreements;
    }
}