vendor/sonata-project/user-bundle/src/Model/User.php line 21

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\UserBundle\Model;
  16. use FOS\UserBundle\Model\User as AbstractedUser;
  18. /**
  19.  * Represents a User model.
  20.  */
  21. abstract class User extends AbstractedUser implements UserInterface
  22. {
  23.     /**
  24.      * @var \DateTime|null
  25.      */
  26.     protected $createdAt;
  28.     /**
  29.      * @var \DateTime|null
  30.      */
  31.     protected $updatedAt;
  33.     /**
  34.      * @var string
  35.      */
  36.     protected $twoStepVerificationCode;
  38.     /**
  39.      * @var \DateTime|null
  40.      */
  41.     protected $dateOfBirth;
  43.     /**
  44.      * @var string
  45.      */
  46.     protected $firstname;
  48.     /**
  49.      * @var string
  50.      */
  51.     protected $lastname;
  53.     /**
  54.      * @var string
  55.      */
  56.     protected $website;
  58.     /**
  59.      * @var string
  60.      */
  61.     protected $biography;
  63.     /**
  64.      * @var string
  65.      */
  66.     protected $gender = UserInterface::GENDER_UNKNOWN; // set the default to unknown
  68.     /**
  69.      * @var string
  70.      */
  71.     protected $locale;
  73.     /**
  74.      * @var string
  75.      */
  76.     protected $timezone;
  78.     /**
  79.      * @var string
  80.      */
  81.     protected $phone;
  83.     /**
  84.      * @var string
  85.      */
  86.     protected $facebookUid;
  88.     /**
  89.      * @var string
  90.      */
  91.     protected $facebookName;
  93.     /**
  94.      * @var string
  95.      */
  96.     protected $facebookData;
  98.     /**
  99.      * @var string
  100.      */
  101.     protected $twitterUid;
  103.     /**
  104.      * @var string
  105.      */
  106.     protected $twitterName;
  108.     /**
  109.      * @var string
  110.      */
  111.     protected $twitterData;
  113.     /**
  114.      * @var string
  115.      */
  116.     protected $gplusUid;
  118.     /**
  119.      * @var string
  120.      */
  121.     protected $gplusName;
  123.     /**
  124.      * @var string
  125.      */
  126.     protected $gplusData;
  128.     /**
  129.      * @var string
  130.      */
  131.     protected $token;
  133.     /**
  134.      * Returns a string representation.
  135.      *
  136.      * @return string
  137.      */
  138.     public function __toString()
  139.     {
  140.         return $this->getUsername() ?: '-';
  141.     }
  143.     /**
  144.      * {@inheritdoc}
  145.      */
  146.     public function setCreatedAt(\DateTime $createdAt = null)
  147.     {
  148.         $this->createdAt = $createdAt;
  150.         return $this;
  151.     }
  153.     /**
  154.      * {@inheritdoc}
  155.      */
  156.     public function getCreatedAt()
  157.     {
  158.         return $this->createdAt;
  159.     }
  161.     /**
  162.      * {@inheritdoc}
  163.      */
  164.     public function setUpdatedAt(\DateTime $updatedAt = null)
  165.     {
  166.         $this->updatedAt = $updatedAt;
  168.         return $this;
  169.     }
  171.     /**
  172.      * {@inheritdoc}
  173.      */
  174.     public function getUpdatedAt()
  175.     {
  176.         return $this->updatedAt;
  177.     }
  179.     /**
  180.      * {@inheritdoc}
  181.      */
  182.     public function setGroups($groups)
  183.     {
  184.         foreach ($groups as $group) {
  185.             $this->addGroup($group);
  186.         }
  188.         return $this;
  189.     }
  191.     /**
  192.      * {@inheritdoc}
  193.      */
  194.     public function setTwoStepVerificationCode($twoStepVerificationCode)
  195.     {
  196.         $this->twoStepVerificationCode = $twoStepVerificationCode;
  198.         return $this;
  199.     }
  201.     /**
  202.      * {@inheritdoc}
  203.      */
  204.     public function getTwoStepVerificationCode()
  205.     {
  206.         return $this->twoStepVerificationCode;
  207.     }
  209.     /**
  210.      * {@inheritdoc}
  211.      */
  212.     public function setBiography($biography)
  213.     {
  214.         $this->biography = $biography;
  216.         return $this;
  217.     }
  219.     /**
  220.      * {@inheritdoc}
  221.      */
  222.     public function getBiography()
  223.     {
  224.         return $this->biography;
  225.     }
  227.     /**
  228.      * {@inheritdoc}
  229.      */
  230.     public function setDateOfBirth($dateOfBirth)
  231.     {
  232.         $this->dateOfBirth = $dateOfBirth;
  234.         return $this;
  235.     }
  237.     /**
  238.      * {@inheritdoc}
  239.      */
  240.     public function getDateOfBirth()
  241.     {
  242.         return $this->dateOfBirth;
  243.     }
  245.     /**
  246.      * {@inheritdoc}
  247.      */
  248.     public function setFacebookData($facebookData)
  249.     {
  250.         $this->facebookData = $facebookData;
  252.         return $this;
  253.     }
  255.     /**
  256.      * {@inheritdoc}
  257.      */
  258.     public function getFacebookData()
  259.     {
  260.         return $this->facebookData;
  261.     }
  263.     /**
  264.      * {@inheritdoc}
  265.      */
  266.     public function setFacebookName($facebookName)
  267.     {
  268.         $this->facebookName = $facebookName;
  270.         return $this;
  271.     }
  273.     /**
  274.      * {@inheritdoc}
  275.      */
  276.     public function getFacebookName()
  277.     {
  278.         return $this->facebookName;
  279.     }
  281.     /**
  282.      * {@inheritdoc}
  283.      */
  284.     public function setFacebookUid($facebookUid)
  285.     {
  286.         $this->facebookUid = $facebookUid;
  288.         return $this;
  289.     }
  291.     /**
  292.      * {@inheritdoc}
  293.      */
  294.     public function getFacebookUid()
  295.     {
  296.         return $this->facebookUid;
  297.     }
  299.     /**
  300.      * {@inheritdoc}
  301.      */
  302.     public function setFirstname($firstname)
  303.     {
  304.         $this->firstname = $firstname;
  306.         return $this;
  307.     }
  309.     /**
  310.      * {@inheritdoc}
  311.      */
  312.     public function getFirstname()
  313.     {
  314.         return $this->firstname;
  315.     }
  317.     /**
  318.      * {@inheritdoc}
  319.      */
  320.     public function setGender($gender)
  321.     {
  322.         $this->gender = $gender;
  324.         return $this;
  325.     }
  327.     /**
  328.      * {@inheritdoc}
  329.      */
  330.     public function getGender()
  331.     {
  332.         return $this->gender;
  333.     }
  335.     /**
  336.      * {@inheritdoc}
  337.      */
  338.     public function setGplusData($gplusData)
  339.     {
  340.         $this->gplusData = $gplusData;
  342.         return $this;
  343.     }
  345.     /**
  346.      * {@inheritdoc}
  347.      */
  348.     public function getGplusData()
  349.     {
  350.         return $this->gplusData;
  351.     }
  353.     /**
  354.      * {@inheritdoc}
  355.      */
  356.     public function setGplusName($gplusName)
  357.     {
  358.         $this->gplusName = $gplusName;
  360.         return $this;
  361.     }
  363.     /**
  364.      * {@inheritdoc}
  365.      */
  366.     public function getGplusName()
  367.     {
  368.         return $this->gplusName;
  369.     }
  371.     /**
  372.      * {@inheritdoc}
  373.      */
  374.     public function setGplusUid($gplusUid)
  375.     {
  376.         $this->gplusUid = $gplusUid;
  378.         return $this;
  379.     }
  381.     /**
  382.      * {@inheritdoc}
  383.      */
  384.     public function getGplusUid()
  385.     {
  386.         return $this->gplusUid;
  387.     }
  389.     /**
  390.      * {@inheritdoc}
  391.      */
  392.     public function setLastname($lastname)
  393.     {
  394.         $this->lastname = $lastname;
  396.         return $this;
  397.     }
  399.     /**
  400.      * {@inheritdoc}
  401.      */
  402.     public function getLastname()
  403.     {
  404.         return $this->lastname;
  405.     }
  407.     /**
  408.      * {@inheritdoc}
  409.      */
  410.     public function setLocale($locale)
  411.     {
  412.         $this->locale = $locale;
  414.         return $this;
  415.     }
  417.     /**
  418.      * {@inheritdoc}
  419.      */
  420.     public function getLocale()
  421.     {
  422.         return $this->locale;
  423.     }
  425.     /**
  426.      * {@inheritdoc}
  427.      */
  428.     public function setPhone($phone)
  429.     {
  430.         $this->phone = $phone;
  432.         return $this;
  433.     }
  435.     /**
  436.      * {@inheritdoc}
  437.      */
  438.     public function getPhone()
  439.     {
  440.         return $this->phone;
  441.     }
  443.     /**
  444.      * {@inheritdoc}
  445.      */
  446.     public function setTimezone($timezone)
  447.     {
  448.         $this->timezone = $timezone;
  450.         return $this;
  451.     }
  453.     /**
  454.      * {@inheritdoc}
  455.      */
  456.     public function getTimezone()
  457.     {
  458.         return $this->timezone;
  459.     }
  461.     /**
  462.      * {@inheritdoc}
  463.      */
  464.     public function setTwitterData($twitterData)
  465.     {
  466.         $this->twitterData = $twitterData;
  468.         return $this;
  469.     }
  471.     /**
  472.      * {@inheritdoc}
  473.      */
  474.     public function getTwitterData()
  475.     {
  476.         return $this->twitterData;
  477.     }
  479.     /**
  480.      * {@inheritdoc}
  481.      */
  482.     public function setTwitterName($twitterName)
  483.     {
  484.         $this->twitterName = $twitterName;
  486.         return $this;
  487.     }
  489.     /**
  490.      * {@inheritdoc}
  491.      */
  492.     public function getTwitterName()
  493.     {
  494.         return $this->twitterName;
  495.     }
  497.     /**
  498.      * {@inheritdoc}
  499.      */
  500.     public function setTwitterUid($twitterUid)
  501.     {
  502.         $this->twitterUid = $twitterUid;
  504.         return $this;
  505.     }
  507.     /**
  508.      * {@inheritdoc}
  509.      */
  510.     public function getTwitterUid()
  511.     {
  512.         return $this->twitterUid;
  513.     }
  515.     /**
  516.      * {@inheritdoc}
  517.      */
  518.     public function setWebsite($website)
  519.     {
  520.         $this->website = $website;
  522.         return $this;
  523.     }
  525.     /**
  526.      * {@inheritdoc}
  527.      */
  528.     public function getWebsite()
  529.     {
  530.         return $this->website;
  531.     }
  533.     /**
  534.      * {@inheritdoc}
  535.      */
  536.     public function setToken($token)
  537.     {
  538.         $this->token = $token;
  540.         return $this;
  541.     }
  543.     /**
  544.      * {@inheritdoc}
  545.      */
  546.     public function getToken()
  547.     {
  548.         return $this->token;
  549.     }
  551.     /**
  552.      * {@inheritdoc}
  553.      */
  554.     public function getFullname()
  555.     {
  556.         return sprintf('%s %s', $this->getFirstname(), $this->getLastname());
  557.     }
  559.     /**
  560.      * {@inheritdoc}
  561.      */
  562.     public function getRealRoles()
  563.     {
  564.         return $this->roles;
  565.     }
  567.     /**
  568.      * {@inheritdoc}
  569.      */
  570.     public function setRealRoles(array $roles)
  571.     {
  572.         $this->setRoles($roles);
  574.         return $this;
  575.     }
  577.     /**
  578.      * Returns the gender list.
  579.      *
  580.      * @return array
  581.      */
  582.     public static function getGenderList()
  583.     {
  584.         return [
  585.             'gender_unknown' => UserInterface::GENDER_UNKNOWN,
  586.             'gender_female' => UserInterface::GENDER_FEMALE,
  587.             'gender_male' => UserInterface::GENDER_MALE,
  588.         ];
  589.     }
  590. }