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.      * @return string
  234.      */
  235.     public function getPassword(): ?string
  236.     {
  237.         return $this->password;
  238.     }
  240.     /**
  241.      * Set locale.
  242.      *
  243.      * @param string $locale
  244.      *
  245.      * @return self
  246.      */
  247.     public function setLocale($locale)
  248.     {
  249.         $this->locale = $locale;
  251.         return $this;
  252.     }
  254.     /**
  255.      * Get locale.
  256.      *
  257.      * @return string
  258.      */
  259.     public function getLocale()
  260.     {
  261.         return $this->locale;
  262.     }
  264.     /**
  265.      * Set salt.
  266.      *
  267.      * @param string $salt
  268.      *
  269.      * @return self
  270.      */
  271.     public function setSalt($salt)
  272.     {
  273.         $this->salt = $salt;
  275.         return $this;
  276.     }
  278.     /**
  279.      * Get salt.
  280.      *
  281.      * @deprecated The salt functionality was deprecated in Sulu 2.5 and will be removed in Sulu 3.0
  282.      *             Modern password algorithm do not longer require a salt.
  283.      *
  284.      * @return string
  285.      */
  286.     public function getSalt()
  287.     {
  288.         return $this->salt;
  289.     }
  291.     /**
  292.      * Set privateKey.
  293.      *
  294.      * @param string|null $privateKey
  295.      *
  296.      * @return self
  297.      */
  298.     public function setPrivateKey($privateKey)
  299.     {
  300.         $this->privateKey = $privateKey;
  302.         return $this;
  303.     }
  305.     /**
  306.      * Get privateKey.
  307.      *
  308.      * @return string|null
  309.      */
  310.     public function getPrivateKey()
  311.     {
  312.         return $this->privateKey;
  313.     }
  315.     /**
  316.      * Removes the password of the user.
  317.      */
  318.     public function eraseCredentials()
  319.     {
  320.     }
  322.     /**
  323.      * Set apiKey.
  324.      *
  325.      * @param string|null $apiKey
  326.      *
  327.      * @return self
  328.      */
  329.     public function setApiKey($apiKey)
  330.     {
  331.         $this->apiKey = $apiKey;
  333.         return $this;
  334.     }
  336.     /**
  337.      * Get apiKey.
  338.      *
  339.      * @return string|null
  340.      */
  341.     public function getApiKey()
  342.     {
  343.         return $this->apiKey;
  344.     }
  346.     /**
  347.      * Set locked.
  348.      *
  349.      * @param bool $locked
  350.      *
  351.      * @return self
  352.      */
  353.     public function setLocked($locked)
  354.     {
  355.         $this->locked = $locked;
  357.         return $this;
  358.     }
  360.     public function getLocked()
  361.     {
  362.         return $this->locked;
  363.     }
  365.     /**
  366.      * Set enabled.
  367.      *
  368.      * @param bool $enabled
  369.      *
  370.      * @return self
  371.      */
  372.     public function setEnabled($enabled)
  373.     {
  374.         $this->enabled = $enabled;
  376.         return $this;
  377.     }
  379.     public function getEnabled()
  380.     {
  381.         return $this->enabled;
  382.     }
  384.     /**
  385.      * Set lastLogin.
  386.      *
  387.      * @param \DateTime|null $lastLogin
  388.      *
  389.      * @return self
  390.      */
  391.     public function setLastLogin($lastLogin)
  392.     {
  393.         $this->lastLogin = $lastLogin;
  395.         return $this;
  396.     }
  398.     /**
  399.      * Get lastLogin.
  400.      *
  401.      * @return \DateTime|null
  402.      */
  403.     public function getLastLogin()
  404.     {
  405.         return $this->lastLogin;
  406.     }
  408.     /**
  409.      * Set confirmationKey.
  410.      *
  411.      * @param string|null $confirmationKey
  412.      *
  413.      * @return self
  414.      */
  415.     public function setConfirmationKey($confirmationKey)
  416.     {
  417.         $this->confirmationKey = $confirmationKey;
  419.         return $this;
  420.     }
  422.     /**
  423.      * Get confirmationKey.
  424.      *
  425.      * @return string|null
  426.      */
  427.     public function getConfirmationKey()
  428.     {
  429.         return $this->confirmationKey;
  430.     }
  432.     /**
  433.      * Set passwordResetToken.
  434.      *
  435.      * @param string|null $passwordResetToken
  436.      *
  437.      * @return self
  438.      */
  439.     public function setPasswordResetToken($passwordResetToken)
  440.     {
  441.         $this->passwordResetToken = $passwordResetToken;
  443.         return $this;
  444.     }
  446.     /**
  447.      * Get passwordResetToken.
  448.      *
  449.      * @return string|null
  450.      */
  451.     public function getPasswordResetToken()
  452.     {
  453.         return $this->passwordResetToken;
  454.     }
  456.     /**
  457.      * Set email.
  458.      *
  459.      * @param string|null $email
  460.      *
  461.      * @return self
  462.      */
  463.     public function setEmail($email)
  464.     {
  465.         $this->email = $email;
  467.         return $this;
  468.     }
  470.     /**
  471.      * Get email.
  472.      *
  473.      * @return string|null
  474.      */
  475.     public function getEmail()
  476.     {
  477.         return $this->email;
  478.     }
  480.     /**
  481.      * Set tokenExpiresAt.
  482.      *
  483.      * @param \DateTime|null $passwordResetTokenExpiresAt
  484.      *
  485.      * @return self
  486.      */
  487.     public function setPasswordResetTokenExpiresAt($passwordResetTokenExpiresAt)
  488.     {
  489.         $this->passwordResetTokenExpiresAt = $passwordResetTokenExpiresAt;
  491.         return $this;
  492.     }
  494.     /**
  495.      * Get passwordResetTokenExpiresAt.
  496.      *
  497.      * @return \DateTime|null
  498.      */
  499.     public function getPasswordResetTokenExpiresAt()
  500.     {
  501.         return $this->passwordResetTokenExpiresAt;
  502.     }
  504.     /**
  505.      * Set passwordResetTokenEmailsSent.
  506.      *
  507.      * @param int|null $passwordResetTokenEmailsSent
  508.      *
  509.      * @return self
  510.      */
  511.     public function setPasswordResetTokenEmailsSent($passwordResetTokenEmailsSent)
  512.     {
  513.         $this->passwordResetTokenEmailsSent = $passwordResetTokenEmailsSent;
  515.         return $this;
  516.     }
  518.     /**
  519.      * Get passwordResetTokenEmailsSent.
  520.      *
  521.      * @return int|null
  522.      */
  523.     public function getPasswordResetTokenEmailsSent()
  524.     {
  525.         return $this->passwordResetTokenEmailsSent;
  526.     }
  528.     public function isEqualTo(SymfonyUserInterface $user): bool
  529.     {
  530.         if (!$user instanceof self) {
  531.             return false;
  532.         }
  534.         return $this->id === $user->getId()
  535.             && $this->password === $user->getPassword()
  536.             && $this->salt === $user->getSalt()
  537.             && $this->username === $user->getUsername()
  538.             && $this->locked === $user->getLocked()
  539.             && $this->enabled === $user->getEnabled();
  540.     }
  542.     /**
  543.      * Add userRoles.
  544.      *
  545.      * @return self
  546.      */
  547.     public function addUserRole(UserRole $userRoles)
  548.     {
  549.         $this->userRoles[] = $userRoles;
  551.         return $this;
  552.     }
  554.     /**
  555.      * Remove userRoles.
  556.      */
  557.     public function removeUserRole(UserRole $userRoles)
  558.     {
  559.         $this->userRoles->removeElement($userRoles);
  560.     }
  562.     /**
  563.      * Get userRoles.
  564.      *
  565.      * @return ArrayCollection
  566.      */
  567.     public function getUserRoles()
  568.     {
  569.         return $this->userRoles;
  570.     }
  572.     /**
  573.      * @VirtualProperty
  574.      * @Groups({"frontend"})
  575.      */
  576.     public function getRoles(): array
  577.     {
  578.         $roles = ['ROLE_USER'];
  580.         foreach ($this->getUserRoles() as $userRole) {
  581.             /* @var UserRole $userRole */
  582.             $roles[] = $userRole->getRole()->getIdentifier();
  583.         }
  585.         return $roles;
  586.     }
  588.     public function getRoleObjects()
  589.     {
  590.         $roles = [];
  591.         foreach ($this->getUserRoles() as $userRole) {
  592.             $roles[] = $userRole->getRole();
  593.         }
  595.         return $roles;
  596.     }
  598.     /**
  599.      * Add userGroups.
  600.      *
  601.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  602.      *
  603.      * @return self
  604.      */
  605.     public function addUserGroup(UserGroup $userGroups)
  606.     {
  607.         $this->userGroups[] = $userGroups;
  609.         return $this;
  610.     }
  612.     /**
  613.      * Remove userGroups.
  614.      *
  615.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  616.      */
  617.     public function removeUserGroup(UserGroup $userGroups)
  618.     {
  619.         $this->userGroups->removeElement($userGroups);
  620.     }
  622.     /**
  623.      * Get userGroups.
  624.      *
  625.      * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  626.      *
  627.      * @return ArrayCollection
  628.      */
  629.     public function getUserGroups()
  630.     {
  631.         return $this->userGroups;
  632.     }
  634.     /**
  635.      * Add userSettings.
  636.      *
  637.      * @return self
  638.      */
  639.     public function addUserSetting(UserSetting $userSettings)
  640.     {
  641.         $this->userSettings[] = $userSettings;
  643.         return $this;
  644.     }
  646.     /**
  647.      * Remove userSettings.
  648.      */
  649.     public function removeUserSetting(UserSetting $userSettings)
  650.     {
  651.         $this->userSettings->removeElement($userSettings);
  652.     }
  654.     /**
  655.      * Get userSettings.
  656.      *
  657.      * @return Collection|UserSetting[]
  658.      */
  659.     public function getUserSettings()
  660.     {
  661.         return $this->userSettings;
  662.     }
  664.     /**
  665.      * @VirtualProperty
  666.      * @Groups({"frontend"})
  667.      */
  668.     public function getSettings()
  669.     {
  670.         $userSettingValues = [];
  671.         foreach ($this->userSettings as $userSetting) {
  672.             $userSettingValues[$userSetting->getKey()] = \json_decode($userSetting->getValue(), true);
  673.         }
  675.         return $userSettingValues;
  676.     }
  678.     /**
  679.      * Set contact.
  680.      *
  681.      * @param ContactInterface $contact
  682.      *
  683.      * @return self
  684.      */
  685.     public function setContact(ContactInterface $contact = null)
  686.     {
  687.         $this->contact = $contact;
  689.         return $this;
  690.     }
  692.     /**
  693.      * Get contact.
  694.      *
  695.      * @return ContactInterface
  696.      */
  697.     public function getContact()
  698.     {
  699.         return $this->contact;
  700.     }
  702.     /**
  703.      * @VirtualProperty
  704.      * @SerializedName("fullName")
  705.      * @Groups({"frontend", "fullUser"})
  706.      *
  707.      * @return string
  708.      */
  709.     public function getFullName()
  710.     {
  711.         return null !== $this->getContact() ?
  712.             $this->getContact()->getFullName() : $this->getUsername();
  713.     }
  715.     /**
  716.      * @VirtualProperty
  717.      * @Groups({"profile"})
  718.      *
  719.      * @return string
  720.      */
  721.     public function getFirstName()
  722.     {
  723.         return $this->contact->getFirstName();
  724.     }
  726.     /**
  727.      * Set firstName.
  728.      *
  729.      * @return $this
  730.      */
  731.     public function setFirstName($firstName)
  732.     {
  733.         $this->contact->setFirstName($firstName);
  735.         return $this;
  736.     }
  738.     /**
  739.      * @VirtualProperty
  740.      * @Groups({"profile"})
  741.      *
  742.      * @return string
  743.      */
  744.     public function getLastName()
  745.     {
  746.         return $this->contact->getLastName();
  747.     }
  749.     /**
  750.      * Set lastName.
  751.      *
  752.      * @return $this
  753.      */
  754.     public function setLastName($lastName)
  755.     {
  756.         $this->contact->setLastName($lastName);
  758.         return $this;
  759.     }
  760. }