vendor/sulu/sulu/src/Sulu/Bundle/SecurityBundle/Entity/User.php line 35

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\SecurityBundle\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection;
  16. use JMS\Serializer\Annotation\ExclusionPolicy;
  17. use JMS\Serializer\Annotation\Expose;
  18. use JMS\Serializer\Annotation\Groups;
  19. use JMS\Serializer\Annotation\SerializedName;
  20. use JMS\Serializer\Annotation\VirtualProperty;
  21. use Sulu\Bundle\ContactBundle\Entity\ContactInterface;
  22. use Sulu\Bundle\CoreBundle\Entity\ApiEntity;
  23. use Sulu\Bundle\SecurityBundle\Entity\TwoFactor\TwoFactorTrait;
  24. use Sulu\Component\Persistence\Model\AuditableInterface;
  25. use Sulu\Component\Persistence\Model\AuditableTrait;
  26. use Sulu\Component\Security\Authentication\UserInterface;
  27. use Symfony\Component\Security\Core\User\EquatableInterface;
  28. use Symfony\Component\Security\Core\User\UserInterface as SymfonyUserInterface;
  30. /**
  31.  * User.
  32.  *
  33.  * @ExclusionPolicy("all")
  34.  */
  35. class User extends ApiEntity implements UserInterface, EquatableInterface, AuditableInterface, PasswordAuthenticatedUserInterface
  36. {
  37.     use AuditableTrait;
  38.     use TwoFactorTrait;
  40.     /**
  41.      * @var int
  42.      *
  43.      * @Expose
  44.      * @Groups({"frontend", "fullUser"})
  45.      */
  46.     protected $id;
  48.     /**
  49.      * @var string
  50.      *
  51.      * @Expose
  52.      * @Groups({"fullUser", "profile"})
  53.      */
  54.     protected $username;
  56.     /**
  57.      * @var string|null
  58.      *
  59.      * @Expose
  60.      * @Groups({"fullUser", "profile"})
  61.      */
  62.     protected $email;
  64.     /**
  65.      * @var string
  66.      */
  67.     protected $password;
  69.     /**
  70.      * @var string
  71.      *
  72.      * @Expose
  73.      * @Groups({"frontend", "fullUser", "profile"})
  74.      */
  75.     protected $locale;
  77.     /**
  78.      * @var string
  79.      */
  80.     protected $salt;
  82.     /**
  83.      * @var string|null
  84.      *
  85.      * @Expose
  86.      */
  87.     protected $privateKey;
  89.     /**
  90.      * @var string|null
  91.      */
  92.     protected $apiKey;
  94.     /**
  95.      * @var bool
  96.      *
  97.      * @Expose
  98.      */
  99.     protected $locked = false;
  101.     /**
  102.      * @var bool
  103.      *
  104.      * @Expose
  105.      */
  106.     protected $enabled = true;
  108.     /**
  109.      * @var \DateTime|null
  110.      */
  111.     protected $lastLogin;
  113.     /**
  114.      * @var string|null
  115.      */
  116.     protected $confirmationKey;
  118.     /**
  119.      * @var string|null
  120.      */
  121.     protected $passwordResetToken;
  123.     /**
  124.      * @var \DateTime|null
  125.      */
  126.     private $passwordResetTokenExpiresAt;
  128.     /**
  129.      * @var int|null
  130.      */
  131.     private $passwordResetTokenEmailsSent;
  133.     /**
  134.      * @var ContactInterface
  135.      *
  136.      * @Expose
  137.      * @Groups({"frontend", "fullUser"})
  138.      */
  139.     protected $contact;
  141.     /**
  142.      * @var Collection|UserRole[]
  143.      *
  144.      * @Expose
  145.      */
  146.     protected $userRoles;
  148.     /**
  149.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  150.      *
  151.      * @var Collection|UserGroup[]
  152.      *
  153.      * @Expose
  154.      */
  155.     protected $userGroups;
  157.     /**
  158.      * @var Collection|UserSetting[]
  159.      */
  160.     protected $userSettings;
  162.     /**
  163.      * Constructor.
  164.      */
  165.     public function __construct()
  166.     {
  167.         $this->apiKey = \md5(\uniqid());
  169.         $this->userRoles = new ArrayCollection();
  170.         $this->userGroups = new ArrayCollection();
  171.         $this->userSettings = new ArrayCollection();
  172.     }
  174.     /**
  175.      * Get id.
  176.      *
  177.      * @return int
  178.      */
  179.     public function getId()
  180.     {
  181.         return $this->id;
  182.     }
  184.     /**
  185.      * Set username.
  186.      *
  187.      * @param string $username
  188.      *
  189.      * @return self
  190.      */
  191.     public function setUsername($username)
  192.     {
  193.         $this->username = $username;
  195.         return $this;
  196.     }
  198.     /**
  199.      * Get username.
  200.      *
  201.      * @SerializedName("username")
  202.      * @Groups({"frontend", "fullUser"})
  203.      *
  204.      * @return string
  205.      */
  206.     public function getUsername()
  207.     {
  208.         return $this->username;
  209.     }
  211.     public function getUserIdentifier(): string
  212.     {
  213.         return $this->username;
  214.     }
  216.     /**
  217.      * Set password.
  218.      *
  219.      * @param string $password
  220.      *
  221.      * @return self
  222.      */
  223.     public function setPassword($password)
  224.     {
  225.         $this->password = $password;
  227.         return $this;
  228.     }
  230.     /**
  231.      * Get password.
  232.      */
  233.     public function getPassword(): ?string
  234.     {
  235.         return $this->password;
  236.     }
  238.     /**
  239.      * Set locale.
  240.      *
  241.      * @param string $locale
  242.      *
  243.      * @return self
  244.      */
  245.     public function setLocale($locale)
  246.     {
  247.         $this->locale = $locale;
  249.         return $this;
  250.     }
  252.     /**
  253.      * Get locale.
  254.      *
  255.      * @return string
  256.      */
  257.     public function getLocale()
  258.     {
  259.         return $this->locale;
  260.     }
  262.     /**
  263.      * Set salt.
  264.      *
  265.      * @param string $salt
  266.      *
  267.      * @return self
  268.      */
  269.     public function setSalt($salt)
  270.     {
  271.         $this->salt = $salt;
  273.         return $this;
  274.     }
  276.     /**
  277.      * Get salt.
  278.      *
  279.      * @deprecated The salt functionality was deprecated in Sulu 2.5 and will be removed in Sulu 3.0
  280.      *             Modern password algorithm do not longer require a salt.
  281.      *
  282.      * @return string
  283.      */
  284.     public function getSalt()
  285.     {
  286.         return $this->salt;
  287.     }
  289.     /**
  290.      * Set privateKey.
  291.      *
  292.      * @param string|null $privateKey
  293.      *
  294.      * @return self
  295.      */
  296.     public function setPrivateKey($privateKey)
  297.     {
  298.         $this->privateKey = $privateKey;
  300.         return $this;
  301.     }
  303.     /**
  304.      * Get privateKey.
  305.      *
  306.      * @return string|null
  307.      */
  308.     public function getPrivateKey()
  309.     {
  310.         return $this->privateKey;
  311.     }
  313.     /**
  314.      * Removes the password of the user.
  315.      */
  316.     public function eraseCredentials()
  317.     {
  318.     }
  320.     /**
  321.      * Set apiKey.
  322.      *
  323.      * @param string|null $apiKey
  324.      *
  325.      * @return self
  326.      */
  327.     public function setApiKey($apiKey)
  328.     {
  329.         $this->apiKey = $apiKey;
  331.         return $this;
  332.     }
  334.     /**
  335.      * Get apiKey.
  336.      *
  337.      * @return string|null
  338.      */
  339.     public function getApiKey()
  340.     {
  341.         return $this->apiKey;
  342.     }
  344.     /**
  345.      * Set locked.
  346.      *
  347.      * @param bool $locked
  348.      *
  349.      * @return self
  350.      */
  351.     public function setLocked($locked)
  352.     {
  353.         $this->locked = $locked;
  355.         return $this;
  356.     }
  358.     public function getLocked()
  359.     {
  360.         return $this->locked;
  361.     }
  363.     /**
  364.      * Set enabled.
  365.      *
  366.      * @param bool $enabled
  367.      *
  368.      * @return self
  369.      */
  370.     public function setEnabled($enabled)
  371.     {
  372.         $this->enabled = $enabled;
  374.         return $this;
  375.     }
  377.     public function getEnabled()
  378.     {
  379.         return $this->enabled;
  380.     }
  382.     /**
  383.      * Set lastLogin.
  384.      *
  385.      * @param \DateTime|null $lastLogin
  386.      *
  387.      * @return self
  388.      */
  389.     public function setLastLogin($lastLogin)
  390.     {
  391.         $this->lastLogin = $lastLogin;
  393.         return $this;
  394.     }
  396.     /**
  397.      * Get lastLogin.
  398.      *
  399.      * @return \DateTime|null
  400.      */
  401.     public function getLastLogin()
  402.     {
  403.         return $this->lastLogin;
  404.     }
  406.     /**
  407.      * Set confirmationKey.
  408.      *
  409.      * @param string|null $confirmationKey
  410.      *
  411.      * @return self
  412.      */
  413.     public function setConfirmationKey($confirmationKey)
  414.     {
  415.         $this->confirmationKey = $confirmationKey;
  417.         return $this;
  418.     }
  420.     /**
  421.      * Get confirmationKey.
  422.      *
  423.      * @return string|null
  424.      */
  425.     public function getConfirmationKey()
  426.     {
  427.         return $this->confirmationKey;
  428.     }
  430.     /**
  431.      * Set passwordResetToken.
  432.      *
  433.      * @param string|null $passwordResetToken
  434.      *
  435.      * @return self
  436.      */
  437.     public function setPasswordResetToken($passwordResetToken)
  438.     {
  439.         $this->passwordResetToken = $passwordResetToken;
  441.         return $this;
  442.     }
  444.     /**
  445.      * Get passwordResetToken.
  446.      *
  447.      * @return string|null
  448.      */
  449.     public function getPasswordResetToken()
  450.     {
  451.         return $this->passwordResetToken;
  452.     }
  454.     /**
  455.      * Set email.
  456.      *
  457.      * @param string|null $email
  458.      *
  459.      * @return self
  460.      */
  461.     public function setEmail($email)
  462.     {
  463.         $this->email = $email;
  465.         return $this;
  466.     }
  468.     /**
  469.      * Get email.
  470.      *
  471.      * @return string|null
  472.      */
  473.     public function getEmail()
  474.     {
  475.         return $this->email;
  476.     }
  478.     /**
  479.      * Set tokenExpiresAt.
  480.      *
  481.      * @param \DateTime|null $passwordResetTokenExpiresAt
  482.      *
  483.      * @return self
  484.      */
  485.     public function setPasswordResetTokenExpiresAt($passwordResetTokenExpiresAt)
  486.     {
  487.         $this->passwordResetTokenExpiresAt = $passwordResetTokenExpiresAt;
  489.         return $this;
  490.     }
  492.     /**
  493.      * Get passwordResetTokenExpiresAt.
  494.      *
  495.      * @return \DateTime|null
  496.      */
  497.     public function getPasswordResetTokenExpiresAt()
  498.     {
  499.         return $this->passwordResetTokenExpiresAt;
  500.     }
  502.     /**
  503.      * Set passwordResetTokenEmailsSent.
  504.      *
  505.      * @param int|null $passwordResetTokenEmailsSent
  506.      *
  507.      * @return self
  508.      */
  509.     public function setPasswordResetTokenEmailsSent($passwordResetTokenEmailsSent)
  510.     {
  511.         $this->passwordResetTokenEmailsSent = $passwordResetTokenEmailsSent;
  513.         return $this;
  514.     }
  516.     /**
  517.      * Get passwordResetTokenEmailsSent.
  518.      *
  519.      * @return int|null
  520.      */
  521.     public function getPasswordResetTokenEmailsSent()
  522.     {
  523.         return $this->passwordResetTokenEmailsSent;
  524.     }
  526.     public function isEqualTo(SymfonyUserInterface $user): bool
  527.     {
  528.         if (!$user instanceof self) {
  529.             return false;
  530.         }
  532.         return $this->id === $user->getId()
  533.             && $this->password === $user->getPassword()
  534.             && $this->salt === $user->getSalt()
  535.             && $this->username === $user->getUsername()
  536.             && $this->locked === $user->getLocked()
  537.             && $this->enabled === $user->getEnabled();
  538.     }
  540.     /**
  541.      * Add userRoles.
  542.      *
  543.      * @return self
  544.      */
  545.     public function addUserRole(UserRole $userRoles)
  546.     {
  547.         $this->userRoles[] = $userRoles;
  549.         return $this;
  550.     }
  552.     /**
  553.      * Remove userRoles.
  554.      */
  555.     public function removeUserRole(UserRole $userRoles)
  556.     {
  557.         $this->userRoles->removeElement($userRoles);
  558.     }
  560.     /**
  561.      * Get userRoles.
  562.      *
  563.      * @return ArrayCollection
  564.      */
  565.     public function getUserRoles()
  566.     {
  567.         return $this->userRoles;
  568.     }
  570.     /**
  571.      * @VirtualProperty
  572.      * @Groups({"frontend"})
  573.      */
  574.     public function getRoles(): array
  575.     {
  576.         $roles = ['ROLE_USER'];
  578.         foreach ($this->getUserRoles() as $userRole) {
  579.             /* @var UserRole $userRole */
  580.             $roles[] = $userRole->getRole()->getIdentifier();
  581.         }
  583.         return $roles;
  584.     }
  586.     public function getRoleObjects()
  587.     {
  588.         $roles = [];
  589.         foreach ($this->getUserRoles() as $userRole) {
  590.             $roles[] = $userRole->getRole();
  591.         }
  593.         return $roles;
  594.     }
  596.     /**
  597.      * Add userGroups.
  598.      *
  599.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  600.      *
  601.      * @return self
  602.      */
  603.     public function addUserGroup(UserGroup $userGroups)
  604.     {
  605.         $this->userGroups[] = $userGroups;
  607.         return $this;
  608.     }
  610.     /**
  611.      * Remove userGroups.
  612.      *
  613.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  614.      */
  615.     public function removeUserGroup(UserGroup $userGroups)
  616.     {
  617.         $this->userGroups->removeElement($userGroups);
  618.     }
  620.     /**
  621.      * Get userGroups.
  622.      *
  623.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  624.      *
  625.      * @return ArrayCollection
  626.      */
  627.     public function getUserGroups()
  628.     {
  629.         return $this->userGroups;
  630.     }
  632.     /**
  633.      * Add userSettings.
  634.      *
  635.      * @return self
  636.      */
  637.     public function addUserSetting(UserSetting $userSettings)
  638.     {
  639.         $this->userSettings[] = $userSettings;
  641.         return $this;
  642.     }
  644.     /**
  645.      * Remove userSettings.
  646.      */
  647.     public function removeUserSetting(UserSetting $userSettings)
  648.     {
  649.         $this->userSettings->removeElement($userSettings);
  650.     }
  652.     /**
  653.      * Get userSettings.
  654.      *
  655.      * @return Collection|UserSetting[]
  656.      */
  657.     public function getUserSettings()
  658.     {
  659.         return $this->userSettings;
  660.     }
  662.     /**
  663.      * @VirtualProperty
  664.      * @Groups({"frontend"})
  665.      */
  666.     public function getSettings()
  667.     {
  668.         $userSettingValues = [];
  669.         foreach ($this->userSettings as $userSetting) {
  670.             $userSettingValues[$userSetting->getKey()] = \json_decode($userSetting->getValue(), true);
  671.         }
  673.         return $userSettingValues;
  674.     }
  676.     /**
  677.      * Set contact.
  678.      *
  679.      * @return self
  680.      */
  681.     public function setContact(?ContactInterface $contact = null)
  682.     {
  683.         $this->contact = $contact;
  685.         return $this;
  686.     }
  688.     /**
  689.      * Get contact.
  690.      *
  691.      * @return ContactInterface
  692.      */
  693.     public function getContact()
  694.     {
  695.         return $this->contact;
  696.     }
  698.     /**
  699.      * @VirtualProperty
  700.      * @SerializedName("fullName")
  701.      * @Groups({"frontend", "fullUser"})
  702.      *
  703.      * @return string
  704.      */
  705.     public function getFullName()
  706.     {
  707.         return null !== $this->getContact() ?
  708.             $this->getContact()->getFullName() : $this->getUsername();
  709.     }
  711.     /**
  712.      * @VirtualProperty
  713.      * @Groups({"profile"})
  714.      *
  715.      * @return string
  716.      */
  717.     public function getFirstName()
  718.     {
  719.         return $this->contact->getFirstName();
  720.     }
  722.     /**
  723.      * Set firstName.
  724.      *
  725.      * @return $this
  726.      */
  727.     public function setFirstName($firstName)
  728.     {
  729.         $this->contact->setFirstName($firstName);
  731.         return $this;
  732.     }
  734.     /**
  735.      * @VirtualProperty
  736.      * @Groups({"profile"})
  737.      *
  738.      * @return string
  739.      */
  740.     public function getLastName()
  741.     {
  742.         return $this->contact->getLastName();
  743.     }
  745.     /**
  746.      * Set lastName.
  747.      *
  748.      * @return $this
  749.      */
  750.     public function setLastName($lastName)
  751.     {
  752.         $this->contact->setLastName($lastName);
  754.         return $this;
  755.     }
  756. }