vendor/roothirsch/core-bundle/Entity/User.php line 52

Open in your IDE?
  1. <?php
  3. namespace Roothirsch\CoreBundle\Entity;
  5. use ApiPlatform\Core\Annotation\ApiFilter;
  6. use ApiPlatform\Core\Annotation\ApiResource;
  7. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\BooleanFilter;
  8. use Roothirsch\CoreBundle\Entity\Traits\TimetrackedTrait;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\ORM\Mapping as ORM;
  11. use Roothirsch\CoreBundle\API\Filter\OrSearchFilter;
  12. use Symfony\Component\Security\Core\User\UserInterface;
  13. use Symfony\Component\Serializer\Annotation\Groups;
  14. use Symfony\Component\Serializer\Annotation\MaxDepth;
  15. use Symfony\Component\Validator\Constraints as Assert;
  17. /**
  18. * @ORM\Entity(repositoryClass="Roothirsch\CoreBundle\Repository\UserRepository")
  19. * @ORM\Table(name="user")
  20. * @ApiResource(
  21. * collectionOperations={
  22. * "get"={
  23. * "normalization_context"={"groups"={"list"}}
  24. * },
  25. * "post"
  26. * },
  27. * itemOperations={
  28. * "register"={"method"="PUT", "path"="/users/{id}/register", "requirements"={"id"=".+"}},
  29. * "reset-password"={"method"="PUT", "path"="/users/{id}/reset-password", "requirements"={"id"=".+"}},
  30. * "change-password"={"method"="PUT", "path"="/users/{id}/change-password", "requirements"={"id"=".+"}},
  31. * "get"={"method"="GET", "path"="/users/{id}"},
  32. * "current"={"method"="GET", "path"="/users/current", "normalization_context"={"groups"={"list"}}},
  33. * "put",
  34. * "delete"
  35. * },
  36. * attributes={
  37. * "normalization_context"={"groups"={"read"}, "enable_max_depth"=true},
  38. * "denormalization_context"={"groups"={"write"}},
  39. * "order"={"lastName": "ASC"}
  40. * }
  41. * )
  42. * @ApiResource
  43. * @ApiFilter(BooleanFilter::class, properties={"active"})
  44. * @ApiFilter(OrSearchFilter::class, properties={
  45. * "username": "partial",
  46. * "email": "partial",
  47. * "firstName": "partial",
  48. * "lastName": "partial",
  49. * "company.name": "partial"
  50. * })
  51. */
  52. class User implements UserInterface
  53. {
  54. use TimetrackedTrait;
  56. /**
  57. * @ORM\Id
  58. * @ORM\GeneratedValue
  59. * @ORM\Column(type="integer")
  60. * @Groups({"list", "read"})
  61. */
  62. private $id;
  64. /**
  65. * @ORM\Column(type="string", unique=true)
  66. * @Groups({"list", "read", "write", "company_read", "js_minimal_read"})
  67. */
  68. private $username;
  70. /**
  71. * @ORM\Column(type="string", unique=true)
  72. * @Assert\NotBlank()
  73. * @Assert\Email(message="email")
  74. * @Groups({"list", "read", "write", "company_read", "js_minimal_read"})
  75. */
  76. private $email;
  78. /**
  79. * @ORM\Column(type="string", nullable=true)
  80. * @Groups({"write"})
  81. */
  82. private $password;
  84. /**
  85. * @Groups({"write"})
  86. */
  87. private $plaintextPassword;
  89. /**
  90. * @ORM\Column(type="string", nullable=true)
  91. * @Assert\NotBlank(message="blank")
  92. * @Groups({"list", "read", "write", "company_read", "js_minimal_read"})
  93. */
  94. private $firstName;
  96. /**
  97. * @ORM\Column(type="string", nullable=true)
  98. * @Assert\NotBlank(message="blank")
  99. * @Groups({"list", "read", "write", "company_read", "js_minimal_read"})
  100. */
  101. private $lastName;
  103. /**
  104. * @ORM\Column(type="string", unique=true, nullable=true)
  105. */
  106. private $registrationToken;
  108. /**
  109. * Random token to verify the e-mail and password-reset.
  110. *
  111. * @var string
  112. * @ORM\Column(type="string", unique=true, nullable=true)
  113. */
  114. protected $securityToken;
  116. /**
  117. * @var bool
  118. * @ORM\Column(type="boolean")
  119. * @Groups({"list", "read", "write", "company_read"})
  120. */
  121. private $active = true;
  123. /**
  124. * @var bool
  125. * @ORM\Column(type="boolean")
  126. * @Groups({"list", "read", "write"})
  127. */
  128. private $admin = true;
  130. /**
  131. * @var string
  132. * @Orm\Column(type="string", nullable=true)
  133. * @Groups({"list", "read", "write", "company_read"})
  134. */
  135. private $phone;
  137. /**
  138. * @var string
  139. * @Orm\Column(type="string", nullable=true)
  140. * @Groups({"list", "read", "write", "company_read"})
  141. */
  142. private $fax;
  144. /**
  145. * @var string
  146. * @Orm\Column(type="string", nullable=true)
  147. * @Groups({"list", "read", "write", "company_read"})
  148. */
  149. private $mobile;
  151. /**
  152. * @ORM\ManyToOne(targetEntity="Company", inversedBy="employees", cascade={"persist"}, fetch="EAGER")
  153. * @ORM\JoinColumn(name="employee_of", referencedColumnName="id", onDelete="SET NULL")
  154. * @Groups({"list", "read", "write"})
  155. * @MaxDepth(1)
  156. */
  157. private $company;
  159. /**
  160. * @var ContactValidation
  161. * @ORM\OneToOne(targetEntity="ContactValidation",cascade={"persist","remove"}, mappedBy="user")
  162. * @Groups({"read", "write"})
  163. */
  164. private $contactValidation;
  166. /**
  167. * @ORM\ManyToOne(targetEntity="ContactPerson", inversedBy="users", cascade={"persist"}, fetch="EAGER")
  168. * @ORM\JoinColumn(name="contact_through", referencedColumnName="id")
  169. * @Groups({"read", "write", "list"})
  170. * @MaxDepth(1)
  171. */
  172. private $contact;
  174. /**
  175. * @Orm\Column(type="string", nullable=true)
  176. * @Groups({"list", "read", "write"})
  177. */
  178. private $erpReference;
  180. /**
  181. * @ORM\Column(type="integer", nullable=true)
  182. */
  183. private $newsReadOn;
  185. /**
  186. * @var array
  187. * @Groups({"read"})
  188. */
  189. private $features = [];
  191. /**
  192. * @ORM\ManyToMany(targetEntity=Group::class, inversedBy="users")
  193. */
  194. private $groups;
  196. /**
  197. * @Groups({"list", "read", "write", "js_minimal_read"})
  198. */
  199. private $roles = [];
  201. public function __toString()
  202. {
  203. return $this->getFullName();
  204. }
  206. public function getFullName()
  207. {
  208. return $this->getFirstName() . ' ' . $this->getLastName();
  209. }
  211. public function getGravatar()
  212. {
  213. return 'https://www.gravatar.com/avatar/' . md5(strtolower(trim($this->getEmail())));
  214. }
  216. /**
  217. * @return mixed
  218. */
  219. public function getId()
  220. {
  221. return $this->id;
  222. }
  224. /**
  225. * @param mixed $id
  226. */
  227. public function setId($id)
  228. {
  229. $this->id = $id;
  230. }
  232. /**
  233. * @return string
  234. */
  235. public function getFirstName()
  236. {
  237. return $this->firstName;
  238. }
  240. /**
  241. * @param string $firstName
  242. */
  243. public function setFirstName($firstName)
  244. {
  245. $this->firstName = $firstName;
  246. }
  248. /**
  249. * @return string
  250. */
  251. public function getLastName()
  252. {
  253. return $this->lastName;
  254. }
  256. /**
  257. * @param string $lastName
  258. */
  259. public function setLastName($lastName)
  260. {
  261. $this->lastName = $lastName;
  262. }
  264. /**
  265. * {@inheritdoc}
  266. */
  267. public function getUsername()
  268. {
  269. return $this->username;
  270. }
  272. /**
  273. * {@inheritdoc}
  274. */
  275. public function getPassword()
  276. {
  277. return $this->password;
  278. }
  280. /**
  281. * {@inheritdoc}
  282. */
  283. public function getRegistrationToken()
  284. {
  285. return $this->registrationToken;
  286. }
  288. /**
  289. * {@inheritdoc}
  290. */
  291. public function getRoles()
  292. {
  293. $roles = [];
  294. foreach ($this->groups as $group) {
  295. $roles[] = $group->getName();
  296. }
  298. if ($this->company instanceof Company) {
  299. foreach ($this->company->getGroups() as $group) {
  300. $roles[] = $group->getName();
  301. }
  302. }
  303. // guarantees that a user always has at least one role for security
  304. if (empty($roles) || !array_search('ROLE_USER', $roles)) {
  305. $roles[] = 'ROLE_USER';
  306. }
  308. return $roles;
  309. }
  311. /**
  312. * {@inheritdoc}
  313. */
  314. public function getSalt()
  315. {
  316. }
  318. /**
  319. * {@inheritdoc}
  320. */
  321. public function eraseCredentials()
  322. {
  323. }
  325. /**
  326. * @return mixed
  327. */
  328. public function getEmail()
  329. {
  330. return $this->email;
  331. }
  333. /**
  334. * @param mixed $email
  335. */
  336. public function setEmail($email)
  337. {
  338. $this->email = $email;
  339. $this->username = $email;
  340. }
  342. /**
  343. * @return string
  344. */
  345. public function getSecurityToken()
  346. {
  347. return $this->securityToken;
  348. }
  350. /**
  351. * @param string $securityToken
  352. */
  353. public function setSecurityToken($securityToken)
  354. {
  355. $this->securityToken = $securityToken;
  356. }
  358. /**
  359. * @return mixed
  360. */
  361. public function getActive()
  362. {
  363. return $this->active;
  364. }
  366. /**
  367. * @param mixed $active
  368. */
  369. public function setActive($active)
  370. {
  371. $this->active = $active;
  372. }
  374. /**
  375. * @return mixed
  376. */
  377. public function getAdmin()
  378. {
  379. return $this->admin;
  380. }
  382. /**
  383. * @param mixed $admin
  384. */
  385. public function setAdmin($admin)
  386. {
  387. $this->admin = $admin;
  388. }
  390. /**
  391. * @param mixed $username
  392. */
  393. public function setUsername($username)
  394. {
  395. $this->username = $username;
  396. }
  398. /**
  399. * @param mixed $password
  400. */
  401. public function setPassword($password)
  402. {
  403. $this->password = $password;
  404. }
  406. /**
  407. * @param string $registrationToken
  408. */
  409. public function setRegistrationToken($registrationToken)
  410. {
  411. $this->registrationToken = $registrationToken;
  412. if (empty($this->registrationToken)) {
  413. $this->registrationToken = null;
  414. }
  415. }
  417. /**
  418. * @return Company
  419. */
  420. public function getCompany()
  421. {
  422. return $this->company;
  423. }
  425. public function getCompanyName()
  426. {
  427. if ($this->company) {
  428. return $this->company->getName();
  429. }
  430. }
  432. /**
  433. * @param Company $company
  434. */
  435. public function setCompany($company)
  436. {
  437. $this->company = $company;
  438. }
  440. /**
  441. * @return string
  442. */
  443. public function getPhone(): string
  444. {
  445. return is_null($this->phone) ? '' : $this->phone;
  446. }
  448. /**
  449. * @param string $phone
  450. */
  451. public function setPhone($phone)
  452. {
  453. $this->phone = $phone;
  454. }
  456. /**
  457. * @return string
  458. */
  459. public function getFax(): string
  460. {
  461. return is_null($this->fax) ? '' : $this->fax;
  462. }
  464. /**
  465. * @param string $fax
  466. */
  467. public function setFax($fax)
  468. {
  469. $this->fax = $fax;
  470. }
  472. /**
  473. * @return string
  474. */
  475. public function getMobile(): string
  476. {
  477. return is_null($this->mobile) ? '' : $this->mobile;
  478. }
  480. /**
  481. * @param string $mobile
  482. */
  483. public function setMobile($mobile)
  484. {
  485. $this->mobile = $mobile;
  486. }
  488. /**
  489. * @return ContactValidation
  490. */
  491. public function getContactValidation()
  492. {
  493. return $this->contactValidation;
  494. }
  496. /**
  497. * @param ContactValidation $contactValidation
  498. */
  499. public function setContactValidation($contactValidation)
  500. {
  501. $this->contactValidation = $contactValidation;
  502. }
  504. /**
  505. * @return mixed
  506. */
  507. public function getContact(): ?ContactPerson
  508. {
  509. return $this->contact;
  510. }
  512. /**
  513. * @param mixed $contact
  514. */
  515. public function setContact($contact)
  516. {
  517. $this->contact = $contact;
  518. }
  520. /**
  521. * @return mixed
  522. */
  523. public function getPlaintextPassword()
  524. {
  525. return $this->plaintextPassword;
  526. }
  528. /**
  529. * @param mixed $plaintextPassword
  530. */
  531. public function setPlaintextPassword($plaintextPassword)
  532. {
  533. $this->updatedAt = new \DateTime();
  534. $this->plaintextPassword = $plaintextPassword;
  535. }
  537. /**
  538. * @return mixed
  539. */
  540. public function getErpReference()
  541. {
  542. return $this->erpReference;
  543. }
  545. /**
  546. * @param mixed $erpReference
  547. */
  548. public function setErpReference($erpReference)
  549. {
  550. $this->erpReference = $erpReference;
  551. }
  553. /**
  554. * @return mixed
  555. */
  556. public function getNewsReadOn()
  557. {
  558. return $this->newsReadOn;
  559. }
  561. /**
  562. * @param mixed $newsReadOn
  563. */
  564. public function setNewsReadOn($newsReadOn)
  565. {
  566. $this->newsReadOn = $newsReadOn;
  567. }
  569. /**
  570. * @return array
  571. */
  572. public function getFeatures()
  573. {
  574. return $this->features;
  575. }
  577. /**
  578. * @param array $features
  579. */
  580. public function setFeatures($features)
  581. {
  582. $this->features = $features;
  583. }
  585. /**
  586. * @return ArrayCollection
  587. */
  588. public function getGroups($includeCompanyGroups = false)
  589. {
  590. if ($includeCompanyGroups === false || ! $this->company instanceof Company) {
  591. return $this->groups;
  592. }
  593. return array_merge($this->groups->toArray(), $this->company->getGroups()->toArray());
  594. }
  596. public function hasGroup($groupName, $includeCompanyGroups = false)
  597. {
  598. $groups = $this->getGroups($includeCompanyGroups);
  599. foreach ($groups as $group) {
  600. /** @var Group $group */
  601. if ($group->getName() === $groupName) {
  602. return true;
  603. }
  604. }
  605. return false;
  606. }
  608. public function hasRole($groupName)
  609. {
  610. $groups = [];
  611. foreach($this->getGroups() as $group) {
  612. $groups[] = $group->getName();
  613. }
  614. return array_search($groupName, $groups) !== false;
  615. }
  617. public function __construct()
  618. {
  619. $this->groups = new ArrayCollection();
  620. }
  622. public function addGroup(Group $group): self
  623. {
  624. if (!$this->groups->contains($group)) {
  625. $this->groups[] = $group;
  626. }
  628. return $this;
  629. }
  631. public function removeGroup(Group $group): self
  632. {
  633. $this->groups->removeElement($group);
  635. return $this;
  636. }
  638. public function getDiscount() {
  639. if (is_object($this->company)) {
  640. return $this->company->getDiscount();
  641. }
  642. return 0;
  643. }
  644. }