vendor/sulu/sulu/src/Sulu/Bundle/ContactBundle/Entity/Contact.php line 29

  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\ContactBundle\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection;
  16. use JMS\Serializer\Annotation\Accessor;
  17. use JMS\Serializer\Annotation\Exclude;
  18. use JMS\Serializer\Annotation\Expose;
  19. use JMS\Serializer\Annotation\Groups;
  20. use JMS\Serializer\Annotation\SerializedName;
  21. use JMS\Serializer\Annotation\Type;
  22. use JMS\Serializer\Annotation\VirtualProperty;
  23. use Sulu\Bundle\CategoryBundle\Entity\CategoryInterface;
  24. use Sulu\Bundle\CoreBundle\Entity\ApiEntity;
  25. use Sulu\Bundle\MediaBundle\Entity\MediaInterface;
  26. use Sulu\Bundle\TagBundle\Tag\TagInterface;
  27. use Sulu\Component\Security\Authentication\UserInterface;
  29. class Contact extends ApiEntity implements ContactInterface
  30. {
  31.     /**
  32.      * @var int
  33.      *
  34.      * @Expose
  35.      * @Groups({"frontend", "partialContact", "fullContact"})
  36.      */
  37.     protected $id;
  39.     /**
  40.      * @var string
  41.      */
  42.     protected $firstName;
  44.     /**
  45.      * @var string|null
  46.      */
  47.     protected $middleName;
  49.     /**
  50.      * @var string
  51.      */
  52.     protected $lastName;
  54.     /**
  55.      * @var ContactTitle|null
  56.      */
  57.     protected $title;
  59.     /**
  60.      * @var \DateTime|null
  61.      */
  62.     protected $birthday;
  64.     /**
  65.      * @var \DateTime
  66.      */
  67.     protected $created;
  69.     /**
  70.      * @var \DateTime
  71.      */
  72.     protected $changed;
  74.     /**
  75.      * @var Collection<int, ContactLocale>
  76.      */
  77.     protected $locales;
  79.     /**
  80.      * @var UserInterface|null
  81.      *
  82.      * @Groups({"fullContact"})
  83.      */
  84.     protected $changer;
  86.     /**
  87.      * @var UserInterface|null
  88.      *
  89.      * @Groups({"fullContact"})
  90.      */
  91.     protected $creator;
  93.     /**
  94.      * @var string|null
  95.      */
  96.     protected $note;
  98.     /**
  99.      * @var Collection<int, Note>
  100.      *
  101.      * @Groups({"fullContact"})
  102.      *
  103.      * @deprecated
  104.      */
  105.     protected $notes;
  107.     /**
  108.      * @var Collection<int, Email>
  109.      *
  110.      * @Groups({"fullContact", "partialContact"})
  111.      */
  112.     protected $emails;
  114.     /**
  115.      * @var Collection<int, Phone>
  116.      *
  117.      * @Groups({"fullContact"})
  118.      */
  119.     protected $phones;
  121.     /**
  122.      * @var Collection<int, Fax>
  123.      *
  124.      * @Groups({"fullContact"})
  125.      */
  126.     protected $faxes;
  128.     /**
  129.      * @var Collection<int, SocialMediaProfile>
  130.      *
  131.      * @Groups({"fullContact"})
  132.      */
  133.     protected $socialMediaProfiles;
  135.     /**
  136.      * @var int|null
  137.      */
  138.     protected $formOfAddress;
  140.     /**
  141.      * @var string|null
  142.      */
  143.     protected $salutation;
  145.     /**
  146.      * @var Collection<int, TagInterface>
  147.      *
  148.      * @Accessor(getter="getTagNameArray")
  149.      * @Groups({"fullContact"})
  150.      * @Type("array")
  151.      */
  152.     protected $tags;
  154.     /**
  155.      * main account.
  156.      *
  157.      * @var string
  158.      *
  159.      * @Accessor(getter="getMainAccount")
  160.      * @Groups({"fullContact"})
  161.      */
  162.     protected $account;
  164.     /**
  165.      * main account.
  166.      *
  167.      * @var string
  168.      *
  169.      * @Accessor(getter="getAddresses")
  170.      * @Groups({"fullContact"})
  171.      */
  172.     protected $addresses;
  174.     /**
  175.      * @var Collection<int, AccountContact>
  176.      *
  177.      * @Exclude
  178.      */
  179.     protected $accountContacts;
  181.     /**
  182.      * @var bool|null
  183.      */
  184.     protected $newsletter;
  186.     /**
  187.      * @var string|null
  188.      */
  189.     protected $gender;
  191.     /**
  192.      * @var string|null
  193.      */
  194.     protected $mainEmail;
  196.     /**
  197.      * @var string|null
  198.      */
  199.     protected $mainPhone;
  201.     /**
  202.      * @var string|null
  203.      */
  204.     protected $mainFax;
  206.     /**
  207.      * @var string|null
  208.      */
  209.     protected $mainUrl;
  211.     /**
  212.      * @var Collection<int, ContactAddress>
  213.      *
  214.      * @Exclude
  215.      */
  216.     protected $contactAddresses;
  218.     /**
  219.      * @var Collection<int, MediaInterface>
  220.      *
  221.      * @Groups({"fullContact"})
  222.      */
  223.     protected $medias;
  225.     /**
  226.      * @var Collection<int, CategoryInterface>
  227.      *
  228.      * @Groups({"fullContact"})
  229.      */
  230.     protected $categories;
  232.     /**
  233.      * @var Collection<int, Url>
  234.      *
  235.      * @Groups({"fullContact"})
  236.      */
  237.     protected $urls;
  239.     /**
  240.      * @var Collection<int, BankAccount>
  241.      *
  242.      * @Groups({"fullContact"})
  243.      */
  244.     protected $bankAccounts;
  246.     /**
  247.      * @var MediaInterface|null
  248.      */
  249.     protected $avatar;
  251.     /**
  252.      * Constructor.
  253.      */
  254.     public function __construct()
  255.     {
  256.         $this->locales = new ArrayCollection();
  257.         $this->notes = new ArrayCollection();
  258.         $this->emails = new ArrayCollection();
  259.         $this->urls = new ArrayCollection();
  260.         $this->addresses = new ArrayCollection();
  261.         $this->phones = new ArrayCollection();
  262.         $this->faxes = new ArrayCollection();
  263.         $this->socialMediaProfiles = new ArrayCollection();
  264.         $this->tags = new ArrayCollection();
  265.         $this->categories = new ArrayCollection();
  266.         $this->accountContacts = new ArrayCollection();
  267.         $this->contactAddresses = new ArrayCollection();
  268.         $this->bankAccounts = new ArrayCollection();
  269.         $this->medias = new ArrayCollection();
  270.     }
  272.     public function getId()
  273.     {
  274.         return $this->id;
  275.     }
  277.     public function setFirstName($firstName)
  278.     {
  279.         $this->firstName = $firstName;
  281.         return $this;
  282.     }
  284.     public function getFirstName()
  285.     {
  286.         return $this->firstName;
  287.     }
  289.     public function setMiddleName($middleName)
  290.     {
  291.         $this->middleName = $middleName;
  293.         return $this;
  294.     }
  296.     /**
  297.      * @return string|null
  298.      */
  299.     public function getMiddleName()
  300.     {
  301.         return $this->middleName;
  302.     }
  304.     public function setLastName($lastName)
  305.     {
  306.         $this->lastName = $lastName;
  308.         return $this;
  309.     }
  311.     public function setAvatar($avatar)
  312.     {
  313.         $this->avatar = $avatar;
  314.     }
  316.     public function getLastName()
  317.     {
  318.         return $this->lastName;
  319.     }
  321.     /**
  322.      * @VirtualProperty
  323.      * @SerializedName("fullName")
  324.      *
  325.      * @return string
  326.      */
  327.     public function getFullName()
  328.     {
  329.         return $this->firstName . ' ' . $this->lastName;
  330.     }
  332.     public function setTitle($title)
  333.     {
  334.         $this->title = $title;
  336.         return $this;
  337.     }
  339.     public function getTitle()
  340.     {
  341.         return $this->title;
  342.     }
  344.     public function setPosition($position)
  345.     {
  346.         $mainAccountContact = $this->getMainAccountContact();
  347.         if ($mainAccountContact) {
  348.             $mainAccountContact->setPosition($position);
  349.         }
  351.         return $this;
  352.     }
  354.     /**
  355.      * @VirtualProperty
  356.      * @Groups({"fullContact"})
  357.      */
  358.     public function getPosition()
  359.     {
  360.         $mainAccountContact = $this->getMainAccountContact();
  361.         if ($mainAccountContact) {
  362.             return $mainAccountContact->getPosition();
  363.         }
  365.         return null;
  366.     }
  368.     public function setBirthday($birthday)
  369.     {
  370.         $this->birthday = $birthday;
  372.         return $this;
  373.     }
  375.     public function getBirthday()
  376.     {
  377.         return $this->birthday;
  378.     }
  380.     public function getCreated()
  381.     {
  382.         return $this->created;
  383.     }
  385.     public function getChanged()
  386.     {
  387.         return $this->changed;
  388.     }
  390.     public function addLocale(ContactLocale $locale)
  391.     {
  392.         $this->locales[] = $locale;
  394.         return $this;
  395.     }
  397.     public function removeLocale(ContactLocale $locale)
  398.     {
  399.         $this->locales->removeElement($locale);
  400.     }
  402.     public function getLocales()
  403.     {
  404.         return $this->locales;
  405.     }
  407.     /**
  408.      * Set changer.
  409.      *
  410.      * @param UserInterface $changer
  411.      *
  412.      * @return Contact
  413.      */
  414.     public function setChanger(UserInterface $changer = null)
  415.     {
  416.         $this->changer = $changer;
  418.         return $this;
  419.     }
  421.     public function getChanger()
  422.     {
  423.         return $this->changer;
  424.     }
  426.     /**
  427.      * Set creator.
  428.      *
  429.      * @param UserInterface $creator
  430.      *
  431.      * @return Contact
  432.      */
  433.     public function setCreator(UserInterface $creator = null)
  434.     {
  435.         $this->creator = $creator;
  437.         return $this;
  438.     }
  440.     public function getCreator()
  441.     {
  442.         return $this->creator;
  443.     }
  445.     public function setNote(?string $note): ContactInterface
  446.     {
  447.         $this->note = $note;
  449.         return $this;
  450.     }
  452.     public function getNote(): ?string
  453.     {
  454.         return $this->note;
  455.     }
  457.     public function addNote(Note $note)
  458.     {
  459.         $this->notes[] = $note;
  461.         return $this;
  462.     }
  464.     public function removeNote(Note $note)
  465.     {
  466.         $this->notes->removeElement($note);
  467.     }
  469.     public function getNotes()
  470.     {
  471.         return $this->notes;
  472.     }
  474.     public function addEmail(Email $email)
  475.     {
  476.         $this->emails[] = $email;
  478.         return $this;
  479.     }
  481.     public function removeEmail(Email $email)
  482.     {
  483.         $this->emails->removeElement($email);
  484.     }
  486.     public function getEmails()
  487.     {
  488.         return $this->emails;
  489.     }
  491.     public function addPhone(Phone $phone)
  492.     {
  493.         $this->phones[] = $phone;
  495.         return $this;
  496.     }
  498.     public function removePhone(Phone $phone)
  499.     {
  500.         $this->phones->removeElement($phone);
  501.     }
  503.     public function getPhones()
  504.     {
  505.         return $this->phones;
  506.     }
  508.     public function addFax(Fax $fax)
  509.     {
  510.         $this->faxes[] = $fax;
  512.         return $this;
  513.     }
  515.     public function removeFax(Fax $fax)
  516.     {
  517.         $this->faxes->removeElement($fax);
  518.     }
  520.     public function getFaxes()
  521.     {
  522.         return $this->faxes;
  523.     }
  525.     public function addSocialMediaProfile(SocialMediaProfile $socialMediaProfile)
  526.     {
  527.         $this->socialMediaProfiles[] = $socialMediaProfile;
  529.         return $this;
  530.     }
  532.     public function removeSocialMediaProfile(SocialMediaProfile $socialMediaProfile)
  533.     {
  534.         $this->socialMediaProfiles->removeElement($socialMediaProfile);
  535.     }
  537.     public function getSocialMediaProfiles()
  538.     {
  539.         return $this->socialMediaProfiles;
  540.     }
  542.     public function addUrl(Url $url)
  543.     {
  544.         $this->urls[] = $url;
  546.         return $this;
  547.     }
  549.     public function removeUrl(Url $url)
  550.     {
  551.         $this->urls->removeElement($url);
  552.     }
  554.     public function getUrls()
  555.     {
  556.         return $this->urls;
  557.     }
  559.     public function setFormOfAddress($formOfAddress)
  560.     {
  561.         $this->formOfAddress = $formOfAddress;
  563.         return $this;
  564.     }
  566.     public function getFormOfAddress()
  567.     {
  568.         return $this->formOfAddress;
  569.     }
  571.     public function setSalutation($salutation)
  572.     {
  573.         $this->salutation = $salutation;
  575.         return $this;
  576.     }
  578.     public function getSalutation()
  579.     {
  580.         return $this->salutation;
  581.     }
  583.     public function addTag(TagInterface $tag)
  584.     {
  585.         $this->tags[] = $tag;
  587.         return $this;
  588.     }
  590.     public function removeTag(TagInterface $tag)
  591.     {
  592.         $this->tags->removeElement($tag);
  593.     }
  595.     public function getTags()
  596.     {
  597.         return $this->tags;
  598.     }
  600.     public function getTagNameArray()
  601.     {
  602.         $tags = [];
  604.         foreach ($this->getTags() as $tag) {
  605.             $tags[] = $tag->getName();
  606.         }
  608.         return $tags;
  609.     }
  611.     public function addAccountContact(AccountContact $accountContact)
  612.     {
  613.         $this->accountContacts[] = $accountContact;
  615.         return $this;
  616.     }
  618.     public function removeAccountContact(AccountContact $accountContact)
  619.     {
  620.         $this->accountContacts->removeElement($accountContact);
  621.     }
  623.     public function getAccountContacts()
  624.     {
  625.         return $this->accountContacts;
  626.     }
  628.     public function setNewsletter($newsletter)
  629.     {
  630.         $this->newsletter = $newsletter;
  632.         return $this;
  633.     }
  635.     /**
  636.      * @return bool|null
  637.      */
  638.     public function getNewsletter()
  639.     {
  640.         return $this->newsletter;
  641.     }
  643.     public function setGender($gender)
  644.     {
  645.         $this->gender = $gender;
  647.         return $this;
  648.     }
  650.     public function getGender()
  651.     {
  652.         return $this->gender;
  653.     }
  655.     public function getMainAccount()
  656.     {
  657.         $mainAccountContact = $this->getMainAccountContact();
  658.         if (!\is_null($mainAccountContact)) {
  659.             return $mainAccountContact->getAccount();
  660.         }
  662.         return null;
  663.     }
  665.     /**
  666.      * Returns main account contact.
  667.      */
  668.     protected function getMainAccountContact()
  669.     {
  670.         $accountContacts = $this->getAccountContacts();
  672.         /** @var AccountContact $accountContact */
  673.         foreach ($accountContacts as $accountContact) {
  674.             if ($accountContact->getMain()) {
  675.                 return $accountContact;
  676.             }
  677.         }
  679.         return null;
  680.     }
  682.     public function getAddresses()
  683.     {
  684.         $contactAddresses = $this->getContactAddresses();
  685.         $addresses = [];
  687.         /** @var ContactAddress $contactAddress */
  688.         foreach ($contactAddresses as $contactAddress) {
  689.             $address = $contactAddress->getAddress();
  690.             $address->setPrimaryAddress($contactAddress->getMain());
  691.             $addresses[] = $address;
  692.         }
  694.         return $addresses;
  695.     }
  697.     public function setMainEmail($mainEmail)
  698.     {
  699.         $this->mainEmail = $mainEmail;
  701.         return $this;
  702.     }
  704.     public function getMainEmail()
  705.     {
  706.         return $this->mainEmail;
  707.     }
  709.     public function setMainPhone($mainPhone)
  710.     {
  711.         $this->mainPhone = $mainPhone;
  713.         return $this;
  714.     }
  716.     public function getMainPhone()
  717.     {
  718.         return $this->mainPhone;
  719.     }
  721.     public function setMainFax($mainFax)
  722.     {
  723.         $this->mainFax = $mainFax;
  725.         return $this;
  726.     }
  728.     public function getMainFax()
  729.     {
  730.         return $this->mainFax;
  731.     }
  733.     public function setMainUrl($mainUrl)
  734.     {
  735.         $this->mainUrl = $mainUrl;
  737.         return $this;
  738.     }
  740.     public function getMainUrl()
  741.     {
  742.         return $this->mainUrl;
  743.     }
  745.     public function addContactAddress(ContactAddress $contactAddress)
  746.     {
  747.         $this->contactAddresses[] = $contactAddress;
  749.         return $this;
  750.     }
  752.     public function removeContactAddress(ContactAddress $contactAddress)
  753.     {
  754.         $this->contactAddresses->removeElement($contactAddress);
  755.     }
  757.     public function getContactAddresses()
  758.     {
  759.         return $this->contactAddresses;
  760.     }
  762.     public function getMainAddress()
  763.     {
  764.         $contactAddresses = $this->getContactAddresses();
  766.         /** @var ContactAddress $contactAddress */
  767.         foreach ($contactAddresses as $contactAddress) {
  768.             if ($contactAddress->getMain()) {
  769.                 return $contactAddress->getAddress();
  770.             }
  771.         }
  773.         return null;
  774.     }
  776.     public function addMedia(MediaInterface $media)
  777.     {
  778.         $this->medias[] = $media;
  780.         return $this;
  781.     }
  783.     public function removeMedia(MediaInterface $media)
  784.     {
  785.         $this->medias->removeElement($media);
  786.     }
  788.     public function getMedias()
  789.     {
  790.         return $this->medias;
  791.     }
  793.     public function getAvatar()
  794.     {
  795.         return $this->avatar;
  796.     }
  798.     public function addCategory(CategoryInterface $category)
  799.     {
  800.         $this->categories[] = $category;
  802.         return $this;
  803.     }
  805.     public function removeCategory(CategoryInterface $category)
  806.     {
  807.         $this->categories->removeElement($category);
  808.     }
  810.     public function getCategories()
  811.     {
  812.         return $this->categories;
  813.     }
  815.     public function addBankAccount(BankAccount $bankAccount)
  816.     {
  817.         $this->bankAccounts[] = $bankAccount;
  819.         return $this;
  820.     }
  822.     public function removeBankAccount(BankAccount $bankAccounts)
  823.     {
  824.         $this->bankAccounts->removeElement($bankAccounts);
  825.     }
  827.     public function getBankAccounts()
  828.     {
  829.         return $this->bankAccounts;
  830.     }
  832.     /**
  833.      * @return $this
  834.      */
  835.     public function setCreated(\DateTime $created)
  836.     {
  837.         $this->created = $created;
  839.         return $this;
  840.     }
  842.     /**
  843.      * @return $this
  844.      */
  845.     public function setChanged(\DateTime $changed)
  846.     {
  847.         $this->changed = $changed;
  849.         return $this;
  850.     }
  852.     /**
  853.      * @return mixed[]
  854.      */
  855.     public function toArray()
  856.     {
  857.         return [
  858.             'id' => $this->getId(),
  859.             'firstName' => $this->getFirstName(),
  860.             'middleName' => $this->getMiddleName(),
  861.             'lastName' => $this->getLastName(),
  862.             'title' => $this->getTitle(),
  863.             'position' => $this->getPosition(),
  864.             'birthday' => $this->getBirthday(),
  865.             'created' => $this->getCreated(),
  866.             'changed' => $this->getChanged(),
  867.         ];
  868.     }
  869. }