558 lines
9.9 KiB
PHP
558 lines
9.9 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the FOSUserBundle package.
|
|
*
|
|
* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace FOS\UserBundle\Model;
|
|
|
|
use Doctrine\Common\Collections\ArrayCollection;
|
|
use Doctrine\Common\Collections\Collection;
|
|
|
|
/**
|
|
* Storage agnostic user object.
|
|
*
|
|
* @author Thibault Duplessis <thibault.duplessis@gmail.com>
|
|
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
|
|
*/
|
|
abstract class User implements UserInterface, GroupableInterface
|
|
{
|
|
/**
|
|
* @var mixed
|
|
*/
|
|
protected $id;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $username;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $usernameCanonical;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $email;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $emailCanonical;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $enabled;
|
|
|
|
/**
|
|
* The salt to use for hashing.
|
|
*
|
|
* @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|null
|
|
*/
|
|
protected $lastLogin;
|
|
|
|
/**
|
|
* Random string sent to the user email address in order to verify it.
|
|
*
|
|
* @var string|null
|
|
*/
|
|
protected $confirmationToken;
|
|
|
|
/**
|
|
* @var \DateTime|null
|
|
*/
|
|
protected $passwordRequestedAt;
|
|
|
|
/**
|
|
* @var GroupInterface[]|Collection
|
|
*/
|
|
protected $groups;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $roles;
|
|
|
|
/**
|
|
* User constructor.
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->enabled = false;
|
|
$this->roles = array();
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return (string) $this->getUsername();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function serialize()
|
|
{
|
|
return serialize(array(
|
|
$this->password,
|
|
$this->salt,
|
|
$this->usernameCanonical,
|
|
$this->username,
|
|
$this->enabled,
|
|
$this->id,
|
|
$this->email,
|
|
$this->emailCanonical,
|
|
));
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function unserialize($serialized)
|
|
{
|
|
$data = unserialize($serialized);
|
|
|
|
if (13 === count($data)) {
|
|
// Unserializing a User object from 1.3.x
|
|
unset($data[4], $data[5], $data[6], $data[9], $data[10]);
|
|
$data = array_values($data);
|
|
} elseif (11 === count($data)) {
|
|
// Unserializing a User from a dev version somewhere between 2.0-alpha3 and 2.0-beta1
|
|
unset($data[4], $data[7], $data[8]);
|
|
$data = array_values($data);
|
|
}
|
|
|
|
list(
|
|
$this->password,
|
|
$this->salt,
|
|
$this->usernameCanonical,
|
|
$this->username,
|
|
$this->enabled,
|
|
$this->id,
|
|
$this->email,
|
|
$this->emailCanonical
|
|
) = $data;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function eraseCredentials()
|
|
{
|
|
$this->plainPassword = null;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getId()
|
|
{
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getUsername()
|
|
{
|
|
return $this->username;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getUsernameCanonical()
|
|
{
|
|
return $this->usernameCanonical;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getSalt()
|
|
{
|
|
return $this->salt;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getEmail()
|
|
{
|
|
return $this->email;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getEmailCanonical()
|
|
{
|
|
return $this->emailCanonical;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getPassword()
|
|
{
|
|
return $this->password;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getPlainPassword()
|
|
{
|
|
return $this->plainPassword;
|
|
}
|
|
|
|
/**
|
|
* Gets the last login time.
|
|
*
|
|
* @return \DateTime|null
|
|
*/
|
|
public function getLastLogin()
|
|
{
|
|
return $this->lastLogin;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getConfirmationToken()
|
|
{
|
|
return $this->confirmationToken;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getRoles()
|
|
{
|
|
$roles = $this->roles;
|
|
|
|
foreach ($this->getGroups() as $group) {
|
|
$roles = array_merge($roles, $group->getRoles());
|
|
}
|
|
|
|
// we need to make sure to have at least one role
|
|
$roles[] = static::ROLE_DEFAULT;
|
|
|
|
return array_unique($roles);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function hasRole($role)
|
|
{
|
|
return in_array(strtoupper($role), $this->getRoles(), true);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isAccountNonExpired()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isAccountNonLocked()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isCredentialsNonExpired()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
public function isEnabled()
|
|
{
|
|
return $this->enabled;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isSuperAdmin()
|
|
{
|
|
return $this->hasRole(static::ROLE_SUPER_ADMIN);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setUsername($username)
|
|
{
|
|
$this->username = $username;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setUsernameCanonical($usernameCanonical)
|
|
{
|
|
$this->usernameCanonical = $usernameCanonical;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setSalt($salt)
|
|
{
|
|
$this->salt = $salt;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setEmail($email)
|
|
{
|
|
$this->email = $email;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setEmailCanonical($emailCanonical)
|
|
{
|
|
$this->emailCanonical = $emailCanonical;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setEnabled($boolean)
|
|
{
|
|
$this->enabled = (bool) $boolean;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setPassword($password)
|
|
{
|
|
$this->password = $password;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setSuperAdmin($boolean)
|
|
{
|
|
if (true === $boolean) {
|
|
$this->addRole(static::ROLE_SUPER_ADMIN);
|
|
} else {
|
|
$this->removeRole(static::ROLE_SUPER_ADMIN);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setPlainPassword($password)
|
|
{
|
|
$this->plainPassword = $password;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setLastLogin(\DateTime $time = null)
|
|
{
|
|
$this->lastLogin = $time;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setConfirmationToken($confirmationToken)
|
|
{
|
|
$this->confirmationToken = $confirmationToken;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isPasswordRequestNonExpired($ttl)
|
|
{
|
|
return $this->getPasswordRequestedAt() instanceof \DateTime &&
|
|
$this->getPasswordRequestedAt()->getTimestamp() + $ttl > time();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setRoles(array $roles)
|
|
{
|
|
$this->roles = array();
|
|
|
|
foreach ($roles as $role) {
|
|
$this->addRole($role);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getGroups()
|
|
{
|
|
return $this->groups ?: $this->groups = new ArrayCollection();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getGroupNames()
|
|
{
|
|
$names = array();
|
|
foreach ($this->getGroups() as $group) {
|
|
$names[] = $group->getName();
|
|
}
|
|
|
|
return $names;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function hasGroup($name)
|
|
{
|
|
return in_array($name, $this->getGroupNames());
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function addGroup(GroupInterface $group)
|
|
{
|
|
if (!$this->getGroups()->contains($group)) {
|
|
$this->getGroups()->add($group);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function removeGroup(GroupInterface $group)
|
|
{
|
|
if ($this->getGroups()->contains($group)) {
|
|
$this->getGroups()->removeElement($group);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
}
|