src/Bidcoz/Bundle/CoreBundle/Entity/User.php line 31

Open in your IDE?
  1. <?php
  3. namespace Bidcoz\Bundle\CoreBundle\Entity;
  5. use Bidcoz\Bundle\CoreBundle\Entity\Auction\WatchListItem;
  6. use Bidcoz\Bundle\CoreBundle\Entity\Contact\CompanyMember;
  7. use Bidcoz\Bundle\CoreBundle\Entity\PaymentGateway\PaymentGateway;
  8. use Bidcoz\Bundle\CoreBundle\Entity\Terms\UserTerms;
  9. use Bidcoz\Bundle\CoreBundle\Util\TextManipulator;
  10. use Doctrine\Common\Collections\ArrayCollection;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use FOS\UserBundle\Model\User as BaseUser;
  13. use FOS\UserBundle\Util\Canonicalizer;
  14. use JMS\Serializer\Annotation as Serialize;
  15. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  16. use Symfony\Component\Validator\Constraints as Assert;
  18. /**
  19.  * @ORM\Entity(repositoryClass="UserRepository")
  20.  * @ORM\Table(name="users")
  21.  * @Serialize\ExclusionPolicy("all")
  22.  * @UniqueEntity("email", message="")
  23.  * @ORM\AttributeOverrides({
  24.  *     @ORM\AttributeOverride(name="password",
  25.  *         column=@ORM\Column(
  26.  *             nullable=true
  27.  *         )
  28.  *     ),
  29.  * })
  30.  */
  31. class User extends BaseUser
  32. {
  33.     public const NOTIFICATION_EMAIL = 'email';
  34.     public const NOTIFICATION_SMS   = 'sms';
  35.     public const DEFAULT_TIMEZONE   = 'America/Chicago';
  37.     /**
  38.      * @ORM\Id
  39.      * @ORM\Column(name="id", type="integer")
  40.      * @ORM\GeneratedValue(strategy="AUTO")
  41.      * @Serialize\Expose
  42.      * @Serialize\Groups({"Default", "API"})
  43.      */
  44.     protected $id;
  46.     /**
  47.      * @ORM\Column(name="fname", length=50)
  48.      * @Assert\NotBlank(groups={"Registration", "Profile"})
  49.      * @Assert\Length(min=1, max=50, groups={"Registration", "Profile"})
  50.      * @Serialize\Expose
  51.      * @Serialize\SerializedName("firstName")
  52.      */
  53.     protected $firstName;
  55.     /**
  56.      * @ORM\Column(name="lname", length=50)
  57.      * @Assert\NotBlank(groups={"Registration", "Profile"})
  58.      * @Assert\Length(min=1, max=50)
  59.      * @Serialize\Expose
  60.      * @Serialize\SerializedName("lastName")
  61.      */
  62.     protected $lastName;
  64.     /**
  65.      * @Serialize\Expose
  66.      * @Serialize\SerializedName("email")
  67.      * @Serialize\Groups({"Default", "API"})
  68.      */
  69.     protected $emailCanonical;
  71.     /**
  72.      * @ORM\Embedded(class= "Address", columnPrefix=false)
  73.      * @Assert\Valid
  74.      */
  75.     protected $address;
  77.     /**
  78.      * @ORM\Column(name="phone", length=42, nullable=true)
  79.      * @Assert\Expression(
  80.      *     "this.isPhoneValidForSMS() or !this.getSMSOptIn()",
  81.      *     message="Please provide a valid mobile phone number!",
  82.      *     groups={"Registration", "Profile"}
  83.      * )
  84.      */
  85.     protected $phone;
  87.     /**
  88.      * @ORM\Column(name="skip_mobile", type="boolean")
  89.      * @Assert\NotNull(groups={"Registration", "Profile"})
  90.      */
  91.     protected $skipMobile = false;
  93.     /**
  94.      * @ORM\Column(name="sms_opt_in", type="boolean")
  95.      * @Assert\NotNull(groups={"Registration", "Profile"})
  96.      */
  97.     protected bool $smsOptIn = true;
  99.     /**
  100.      * @ORM\Column(name="timezone", length=50)
  101.      * @Assert\NotBlank(groups={"Registration", "Profile"}, message="Please choose your timezone")
  102.      */
  103.     protected $timezone = self::DEFAULT_TIMEZONE;
  105.     /**
  106.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Auction\WatchListItem", mappedBy="user")
  107.      */
  108.     protected $watchList;
  110.     /**
  111.      * @ORM\OneToMany(targetEntity="OrganizationAdmin", mappedBy="user")
  112.      */
  113.     protected $orgAdmins;
  115.     /**
  116.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Ticket\Ticket", mappedBy="user")
  117.      */
  118.     protected $tickets;
  120.     /**
  121.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\CreditCard", mappedBy="user")
  122.      */
  123.     protected $creditCards;
  125.     /**
  126.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Ticket\TicketGroup", mappedBy="owner")
  127.      */
  128.     protected $ticketGroups;
  130.     /**
  131.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Purchase\Purchase", mappedBy="user")
  132.      */
  133.     protected $purchases;
  135.     /**
  136.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Transaction\Transaction", mappedBy="user")
  137.      */
  138.     protected $transactions;
  140.     /**
  141.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Donation\CashDonation", mappedBy="user")
  142.      */
  143.     protected $donations;
  145.     /**
  146.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Email\Email", mappedBy="user", fetch="EXTRA_LAZY")
  147.      */
  148.     protected $emails;
  150.     /**
  151.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Auction\Bid", mappedBy="user")
  152.      */
  153.     protected $bids;
  155.     /**
  156.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Auction\BidNumber", mappedBy="user")
  157.      */
  158.     protected $bidNumbers;
  160.     /**
  161.      * @ORM\Column(name="user_allow_admin_update", type="boolean")
  162.      */
  163.     protected $allowAdminUpdate = true;
  165.     /**
  166.      * @ORM\ManyToOne(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Terms\UserTerms")
  167.      */
  168.     protected $userTerms;
  170.     /**
  171.      * @ORM\Column(name="service_fee_type", type="text", length=20);
  172.      */
  173.     protected $feeType = Campaign::FEE_USER;
  175.     /**
  176.      * @ORM\Column(name="notitication_preference", type="string", length=5, options={"fixed" = true});
  177.      */
  178.     protected $notificationPreference = self::NOTIFICATION_SMS;
  180.     /**
  181.      * @ORM\ManyToOne(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\PaymentGateway\PaymentGateway")
  182.      */
  183.     protected $preferredPaymentGateway;
  185.     /**
  186.      * @ORM\Column(name="is_test", type="boolean")
  187.      */
  188.     protected $test = false;
  190.     /**
  191.      * @ORM\Column(name="email_optout", type="boolean")
  192.      */
  193.     protected $emailOptout = false;
  195.     /**
  196.      * @ORM\ManyToOne(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Organization")
  197.      * @ORM\JoinColumn(name="last_visit_organization_id", referencedColumnName="id", onDelete="SET NULL")
  198.      */
  199.     protected ?Organization $lastVisitOrganization = null;
  201.     /**
  202.      * @ORM\ManyToOne(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Campaign")
  203.      * @ORM\JoinColumn(name="last_visit_campaign_id", referencedColumnName="id", onDelete="SET NULL")
  204.      */
  205.     protected ?Campaign $lastVisitCampaign = null;
  207.     /**
  208.      * @ORM\Column(type="datetime")
  209.      */
  210.     protected $createdAt;
  212.     /**
  213.      * @ORM\Column(name="modals", type="simple_array", nullable=true)
  214.      */
  215.     protected $modals = [];
  217.     // Not mapped, a hack around the registration form
  218.     protected $acceptTerms;
  220.     /**
  221.      * @ORM\Column(name="profile_update_dismissed_at", type="datetime", nullable=true)
  222.      */
  223.     protected $profileUpdateDismissedAt;
  225.     /**
  226.      * @ORM\Column(name="has_logged_in", type="boolean")
  227.      * @Serialize\Expose
  228.      */
  229.     protected $loggedIn = false;
  231.     /**
  232.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Contact\Tag", mappedBy="user")
  233.      */
  234.     protected $tags;
  236.     /**
  237.      * @ORM\Column(name="facebook_id", type="string", length=32, nullable=true)
  238.      */
  239.     protected $facebookId;
  241.     /**
  242.      * @ORM\Column(name="facebook_access_token", type="string", length=64, nullable=true)
  243.      */
  244.     protected $facebookAccessToken;
  246.     /**
  247.      * @ORM\Column(name="google_id", type="string", length=32, nullable=true)
  248.      */
  249.     protected $googleId;
  251.     /**
  252.      * @ORM\Column(name="nvidia_id", type="string", length=32, nullable=true)
  253.      */
  254.     protected $nvidiaId;
  256.     /**
  257.      * @ORM\Column(name="chg_id", type="string", length=255, nullable=true)
  258.      */
  259.     protected $chgId;
  261.     /**
  262.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Contact\Contact", mappedBy="user")
  263.      */
  264.     protected $contacts;
  266.     /**
  267.      * @var CompanyMember[]|ArrayCollection
  268.      * @ORM\OneToMany(targetEntity="Bidcoz\Bundle\CoreBundle\Entity\Contact\CompanyMember", mappedBy="user")
  269.      */
  270.     protected $companyMembers;
  272.     /**
  273.      * @ORM\Column(name="use_fast_list", type="boolean")
  274.      */
  275.     protected $useFastList = false;
  277.     public function __construct()
  278.     {
  279.         parent::__construct();
  280.         $this->watchList      = new ArrayCollection();
  281.         $this->tickets        = new ArrayCollection();
  282.         $this->ticketGroups   = new ArrayCollection();
  283.         $this->purchases      = new ArrayCollection();
  284.         $this->transactions   = new ArrayCollection();
  285.         $this->donations      = new ArrayCollection();
  286.         $this->bids           = new ArrayCollection();
  287.         $this->bidNumbers     = new ArrayCollection();
  288.         $this->orgAdmins      = new ArrayCollection();
  289.         $this->tags           = new ArrayCollection();
  290.         $this->createdAt      = new \DateTime();
  291.         $this->companyMembers = new ArrayCollection();
  292.     }
  294.     public function setId($id)
  295.     {
  296.         $this->id = $id;
  298.         return $this;
  299.     }
  301.     public function getWatchList()
  302.     {
  303.         return $this->watchList;
  304.     }
  306.     public function addWatchListItem(WatchListItem $item)
  307.     {
  308.         if (!$this->watchList->contains($item)) {
  309.             $this->watchList->add($item);
  310.         }
  311.     }
  313.     public function removeWatchListItem(WatchListItem $item)
  314.     {
  315.         if ($this->watchList->contains($item)) {
  316.             $this->watchList->removeElement($item);
  317.         }
  318.     }
  320.     public function setFirstName($firstName)
  321.     {
  322.         $this->firstName = $firstName;
  323.     }
  325.     public function getFirstName()
  326.     {
  327.         return $this->firstName;
  328.     }
  330.     public function setLastName($lastName)
  331.     {
  332.         $this->lastName = $lastName;
  333.     }
  335.     public function getLastName()
  336.     {
  337.         return $this->lastName;
  338.     }
  340.     /**
  341.      * @Serialize\VirtualProperty
  342.      * @Serialize\SerializedName("name")
  343.      * @Serialize\Groups({"Default", "API"})
  344.      */
  345.     public function getName()
  346.     {
  347.         $name = $this->firstName;
  349.         if ($this->lastName) {
  350.             $name .= ' '.$this->lastName;
  351.         }
  353.         return $name;
  354.     }
  356.     public function hasName(): bool
  357.     {
  358.         return (bool) $this->firstName && $this->lastName;
  359.     }
  361.     public function setAddress(Address $address)
  362.     {
  363.         $this->address = $address;
  364.     }
  366.     public function getAddress()
  367.     {
  368.         return $this->address;
  369.     }
  371.     public function setPhone($phone)
  372.     {
  373.         $this->phone = TextManipulator::normalizePhoneNumber($phone);
  374.     }
  376.     public function isPhoneValidForSMS(): bool
  377.     {
  378.         // We are going international!  Phone number must start with a '+' (intl code)
  379.         return strlen($this->phone) > 0 && '+' === $this->phone[0];
  380.     }
  382.     public function hasValidPhoneForSmsOrHasOptedOut(): bool
  383.     {
  384.         return !$this->getSMSOptIn() || $this->isPhoneValidForSMS();
  385.     }
  387.     public function hasValidPhoneForSmsAndHasNotOptedOut(): bool
  388.     {
  389.         return $this->getSMSOptIn() && $this->isPhoneValidForSMS();
  390.     }
  392.     public function getPhone()
  393.     {
  394.         return $this->phone;
  395.     }
  397.     public function getSkipMobile(): bool
  398.     {
  399.         return $this->skipMobile;
  400.     }
  402.     public function setSkipMobile($value)
  403.     {
  404.         $this->skipMobile = (bool) $value;
  405.         if ($value) {
  406.             $this->notificationPreference = self::NOTIFICATION_EMAIL;
  407.         } else {
  408.             $this->notificationPreference = self::NOTIFICATION_SMS;
  409.         }
  410.     }
  412.     public function getSMSOptIn(): bool
  413.     {
  414.         return $this->smsOptIn;
  415.     }
  417.     public function setSMSOptIn($value)
  418.     {
  419.         $this->smsOptIn = (bool) $value;
  420.         if ($value) {
  421.             $this->notificationPreference = self::NOTIFICATION_SMS;
  422.         } else {
  423.             $this->notificationPreference = self::NOTIFICATION_EMAIL;
  424.         }
  425.     }
  427.     public function setTimezone($timezone)
  428.     {
  429.         $this->timezone = $timezone ?: self::DEFAULT_TIMEZONE;
  430.     }
  432.     public function getTimezone()
  433.     {
  434.         return $this->timezone;
  435.     }
  437.     public function getTickets()
  438.     {
  439.         return $this->tickets;
  440.     }
  442.     public function getCreditCards()
  443.     {
  444.         return $this->creditCards;
  445.     }
  447.     public function getTags()
  448.     {
  449.         return $this->tags;
  450.     }
  452.     public function getOrgAdmins()
  453.     {
  454.         return $this->orgAdmins;
  455.     }
  457.     public function getPurchases()
  458.     {
  459.         return $this->purchases;
  460.     }
  462.     public function setAllowAdminUpdate($allowAdminUpdate)
  463.     {
  464.         $this->allowAdminUpdate = $allowAdminUpdate;
  465.     }
  467.     public function getAllowAdminUpdate()
  468.     {
  469.         return $this->allowAdminUpdate;
  470.     }
  472.     public function setUserTerms(UserTerms $userTerms)
  473.     {
  474.         $this->userTerms = $userTerms;
  475.     }
  477.     public function getUserTerms()
  478.     {
  479.         return $this->userTerms;
  480.     }
  482.     public function setFeeType(string $feeType)
  483.     {
  484.         if (!array_key_exists($feeType, self::getFeeChoices())) {
  485.             return;
  486.         }
  488.         $this->feeType = $feeType;
  489.     }
  491.     public function getFeeType(): string
  492.     {
  493.         return $this->feeType ?: Campaign::FEE_USER;
  494.     }
  496.     public static function getFeeChoices()
  497.     {
  498.         return [
  499.             Campaign::FEE_USER         => 'Accept',
  500.             Campaign::FEE_ORGANIZATION => 'Decline',
  501.         ];
  502.     }
  504.     public function setNotificationPreference($notificationPreference)
  505.     {
  506.         $this->notificationPreference = $notificationPreference;
  507.     }
  509.     public function getNotificationPreference()
  510.     {
  511.         return $this->notificationPreference;
  512.     }
  514.     public function sendSMSNotifications()
  515.     {
  516.         return
  517.             $this->notificationPreference
  518.             && self::NOTIFICATION_SMS === $this->notificationPreference
  519.             && $this->isPhoneValidForSMS();
  520.     }
  522.     public static function getNotificationChoices()
  523.     {
  524.         return [
  525.             'Email' => self::NOTIFICATION_EMAIL,
  526.             'Text'  => self::NOTIFICATION_SMS,
  527.         ];
  528.     }
  530.     public function setPreferredPaymentGateway(PaymentGateway $preferredPaymentGateway)
  531.     {
  532.         $this->preferredPaymentGateway = $preferredPaymentGateway;
  533.     }
  535.     public function getPreferredPaymentGateway()
  536.     {
  537.         return $this->preferredPaymentGateway;
  538.     }
  540.     public function setTest($test)
  541.     {
  542.         $this->test = $test;
  543.     }
  545.     public function isTest()
  546.     {
  547.         return $this->test;
  548.     }
  550.     public function setEmailOptout($emailOptout)
  551.     {
  552.         $this->emailOptout = $emailOptout;
  553.     }
  555.     public function setEmail($email)
  556.     {
  557.         $email =  Canonicalizer::canonicalize($email);
  559.         $this->email = $email;
  560.         $this->setEmailCanonical($email);
  561.         $this->setUsername($email);
  562.         $this->setUsernameCanonical($email);
  563.     }
  565.     public function isEmailOptout()
  566.     {
  567.         return $this->emailOptout;
  568.     }
  570.     public function setLastVisitOrganization(?Organization $lastVisitOrganization): void
  571.     {
  572.         $this->lastVisitOrganization = $lastVisitOrganization;
  573.     }
  575.     public function getLastVisitOrganization(): ?Organization
  576.     {
  577.         return $this->lastVisitOrganization;
  578.     }
  580.     public function setLastVisitCampaign(?Campaign $campaign): void
  581.     {
  582.         $this->lastVisitCampaign     = $campaign;
  583.         $this->lastVisitOrganization = $campaign ? $campaign->getOrganization() : null;
  584.     }
  586.     public function getLastVisitCampaign(): ?Campaign
  587.     {
  588.         return $this->lastVisitCampaign;
  589.     }
  591.     public function setCreatedAt(\DateTime $date)
  592.     {
  593.         $this->createdAt = $date;
  594.     }
  596.     public function getCreatedAt()
  597.     {
  598.         return $this->createdAt;
  599.     }
  601.     public function setAcceptTerms($acceptTerms)
  602.     {
  603.         $this->acceptTerms = $acceptTerms;
  604.     }
  606.     /**
  607.      * @Assert\IsTrue(groups={"Registration"}, message="You must accept the User Terms of Use")
  608.      */
  609.     public function getAcceptTerms()
  610.     {
  611.         return $this->acceptTerms;
  612.     }
  614.     public function getModals()
  615.     {
  616.         return $this->modals ?: [];
  617.     }
  619.     public function hasViewedModal($modal)
  620.     {
  621.         return in_array($modal, $this->modals);
  622.     }
  624.     public function viewModal($modal)
  625.     {
  626.         if (!$this->hasViewedModal($modal)) {
  627.             $this->modals[] = $modal;
  628.         }
  629.     }
  631.     public function removeModal($modal)
  632.     {
  633.         $idx = array_search($modal, $this->modals);
  634.         if (false !== $idx) {
  635.             unset($this->modals[$idx]);
  636.         }
  637.     }
  639.     public function dismissProfileUpdate()
  640.     {
  641.         $this->profileUpdateDismissedAt = new \DateTime();
  642.     }
  644.     public function showProfileUpdate()
  645.     {
  646.         if (!$this->profileUpdateDismissedAt) {
  647.             return true;
  648.         }
  650.         $then = new \DateTime('-8 hours');
  652.         return $this->profileUpdateDismissedAt < $then;
  653.     }
  655.     public function hasLoggedIn()
  656.     {
  657.         return $this->loggedIn;
  658.     }
  660.     public function setLoggedIn()
  661.     {
  662.         $this->loggedIn = true;
  663.     }
  665.     public function resetLoggedIn()
  666.     {
  667.         $this->loggedIn = false;
  668.     }
  670.     public function setFacebookId(int $facebookId)
  671.     {
  672.         $this->setFacebookId = $facebookId;
  673.     }
  675.     public function setFacebookAccessToken(string $accessToken)
  676.     {
  677.         $this->facebookAccessToken = $accessToken;
  678.     }
  680.     public function getGoogleId()
  681.     {
  682.         return $this->googleId;
  683.     }
  685.     public function setGoogleId(string $googleId)
  686.     {
  687.         $this->googleId = $googleId;
  688.     }
  690.     public function getNvidiaId()
  691.     {
  692.         return $this->nvidiaId;
  693.     }
  695.     public function setNvidiaId(string $nvidiaId)
  696.     {
  697.         $this->nvidiaId = $nvidiaId;
  698.     }
  700.     public function setChgId(string $chgId)
  701.     {
  702.         $this->chgId = $chgId;
  703.     }
  705.     public function getChgId()
  706.     {
  707.         return $this->chgId;
  708.     }
  710.     public function getCompanyMembers()
  711.     {
  712.         return $this->companyMembers;
  713.     }
  715.     public function getEmail()
  716.     {
  717.         return $this->email;
  718.     }
  720.     public function getUseFastList(): bool
  721.     {
  722.         return $this->useFastList;
  723.     }
  724. }