src/Entity/Account.php line 93

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity;
  5. use ApiPlatform\Core\Annotation\ApiResource;
  6. use DH\Auditor\Provider\Doctrine\Auditing\Annotation as Audit;
  7. use Doctrine\Common\Collections\ArrayCollection;
  8. use Doctrine\Common\Collections\Collection;
  9. use Doctrine\Common\Collections\Criteria;
  10. use Doctrine\ORM\Mapping as ORM;
  11. use Gedmo\Mapping\Annotation as Gedmo;
  12. use MedBrief\MSR\Controller\Account\Managers;
  13. use MedBrief\MSR\Controller\Account\UserRestrictedAccounts;
  14. use MedBrief\MSR\Entity\MatterRequest\MatterRequestDefaults;
  15. use MedBrief\MSR\Repository\AccountRepository;
  16. use MedBrief\MSR\Service\MatterTypeAwareInterface;
  17. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
  18. use Symfony\Component\Serializer\Annotation\Groups;
  19. use Symfony\Component\Validator\Constraints as Assert;
  21. /**
  22. * @ApiResource(
  23. * collectionOperations={
  24. * "get"={
  25. * "access_control"="is_granted('CREATE_MATTER_REQUEST')",
  26. * "method"="GET",
  27. * "path"="/accounts",
  28. * "controller"=UserRestrictedAccounts::class,
  29. * "defaults"={"_api_receive"=false},
  30. * "openapi_context"={
  31. * "summary"="Retrieves all Account (Client Area) resources available.",
  32. * "description"="Retrieves all Account (Client Area) resources available. To be used in the 'clientAreaId' field when creating a Matter Request.",
  33. * }
  34. * },
  35. * "client_areas"={
  36. * "access_control"="is_granted('CREATE_MATTER_REQUEST')",
  37. * "method"="GET",
  38. * "path"="/client-areas",
  39. * "controller"=UserRestrictedAccounts::class,
  40. * "defaults"={"_api_receive"=false},
  41. * "normalization_context"={"groups"={"client_area:read"}},
  42. * "openapi_context"={
  43. * "summary"="Retrieves all Account (Client Area) resources available.",
  44. * "description"="Retrieves all Account (Client Area) resources available. See [Client Areas](/docs/api/detail#client-areas)",
  45. * }
  46. * }
  47. * },
  48. * itemOperations={
  49. * "get"={"access_control"="is_granted('READ', object)"},
  50. * "managers_get"={
  51. * "access_control"="is_granted('CREATE_MATTER_REQUEST')",
  52. * "method"="GET",
  53. * "path"="/accounts/{id}/managers",
  54. * "controller"=Managers::class,
  55. * "openapi_context"={
  56. * "summary"="Retrieves all User resources that can be assigned as Matter Manager.",
  57. * "description"="Retrieves a list of User resources specific to the specified Account (Client Area) that can be assigned as a Matter Manager on a Matter Request. To be used in the 'manager' field when creating a Matter Request.",
  58. * "responses"={
  59. * "200"={
  60. * "description"="A collection of User resources",
  61. * "content"={
  62. * "application/ld+json"={
  63. * "schema"={
  64. * "$ref"="#/components/schemas/User.jsonld-user.read"
  65. * }
  66. * },
  67. * "application/json"={
  68. * "schema"={
  69. * "$ref"="#/components/schemas/User-user.read"
  70. * }
  71. * }
  72. * }
  73. * }
  74. * }
  75. * }
  76. * },
  77. * },
  78. * attributes={
  79. * "normalization_context"={"groups"={"account:read"}},
  80. * }
  81. * )
  82. *
  83. * @ORM\Table(name="account")
  84. *
  85. * @ORM\Entity(repositoryClass=AccountRepository::class)
  86. *
  87. * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
  88. *
  89. * @Audit\Auditable
  90. *
  91. * @Audit\Security(view={"ROLE_ALLOWED_TO_AUDIT"})
  92. */
  93. class Account implements MatterTypeAwareInterface
  94. {
  95. use FilterableClassConstantsTrait;
  97. public const INVOICE_BILLING_FREQUENCY_MONTHLY = 1;
  98. public const INVOICE_BILLING_FREQUENCY_QUARTERLY = 2;
  99. public const INVOICE_BILLING_FREQUENCY_START_OF_MATTER = 3;
  101. public const INVOICE_TYPE_INDIVIDUAL_MATTER = 1;
  102. public const INVOICE_TYPE_CONSOLIDATED = 2;
  104. // Default role options
  105. public const DEFAULT_ROLE_ADMINISTRATOR = 'ADMINISTRATOR';
  106. public const DEFAULT_ROLE_SUPERADMINISTRATOR = 'SUPERADMINISTRATOR';
  107. public const DEFAULT_ROLE_PROJECTMANAGER = 'PROJECTMANAGER';
  108. public const DEFAULT_ROLE_SORTER = 'SORTER';
  110. // Only has access to the old matter creation form
  111. public const MATTER_CREATION_PROCESS_CLASSIC = 'classic';
  112. public const MATTER_CREATION_PROCESS_CLASSIC__LABEL = 'Classic';
  114. // Only has access to the new matter creation form
  115. public const MATTER_CREATION_PROCESS_STANDARD = 'standard';
  116. public const MATTER_CREATION_PROCESS_STANDARD__LABEL = 'Standard';
  118. // Has access to both the old and new matter creation form
  119. public const MATTER_CREATION_PROCESS_ALL = 'all';
  120. public const MATTER_CREATION_PROCESS_ALL__LABEL = 'Standard & Classic';
  122. // Country of Registration options
  123. public const COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES = 'england_and_wales';
  124. public const COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES__LABEL = 'England and Wales';
  125. public const COUNTRY_OF_REGISTRATION_SCOTLAND = 'scotland';
  126. public const COUNTRY_OF_REGISTRATION_SCOTLAND__LABEL = 'Scotland';
  127. public const COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND = 'northern_ireland';
  128. public const COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND__LABEL = 'Northern Ireland';
  130. /**
  131. * @var ContactableAddress
  132. *
  133. * This field is unmapped, and is purely here for the API.
  134. *
  135. * @Groups({"account:read", "matter_request:read"})
  136. */
  137. protected $returnDetailsAddress;
  139. /**
  140. * @var string
  141. *
  142. * @ORM\Column(name="matterCreationProcess", type="string", nullable=true)
  143. */
  144. protected $matterCreationProcess = self::MATTER_CREATION_PROCESS_CLASSIC;
  146. /**
  147. * @var string|null
  148. *
  149. * @ORM\Column(name="custom_index_header", type="text", nullable=true)
  150. */
  151. protected $custom_index_header;
  153. /**
  154. * @var string|null
  155. *
  156. * @ORM\Column(name="standardIndexHeader", type="text", nullable=true)
  157. */
  158. protected $standardIndexHeader;
  160. /**
  161. * Indicates if the MedBrief logo should be hidden from the index produced.
  162. * The scenario for this is where clients sort their own records, or a sorting standard that
  163. * deviates from our standard sorting product.
  164. *
  165. * @var bool
  166. *
  167. * @ORM\Column(type="boolean", options={"default"=false})
  168. */
  169. protected $hideLogoFromIndex = false;
  171. /**
  172. * @Groups({"client_area:read"})
  173. *
  174. * @ORM\Column(name="id", type="bigint", nullable=false)
  175. *
  176. * @ORM\Id
  177. *
  178. * @ORM\GeneratedValue(strategy="IDENTITY")
  179. */
  180. private ?int $id;
  182. /**
  183. * @Groups({"account:read", "matter_request:read", "client_area:read"})
  184. *
  185. * @ORM\Column(name="name", type="string", length=155, nullable=false)
  186. */
  187. private ?string $name;
  189. /**
  190. * @var Collection
  191. *
  192. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Domain", mappedBy="account", cascade={"all"})
  193. */
  194. private $domains;
  196. /**
  197. * @var array|null
  198. *
  199. * @ORM\Column(name="allowed_license_levels", type="array", nullable=true)
  200. */
  201. private $allowed_license_levels;
  203. /**
  204. * @var string|null
  205. *
  206. * @ORM\Column(name="prefix", type="string", length=25, nullable=true)
  207. */
  208. private $prefix;
  210. /**
  211. * @var string|null
  212. *
  213. * @ORM\Column(name="legal_entity_name", type="text", nullable=true)
  214. */
  215. private $legal_entity_name;
  217. /**
  218. * Sets all service requests for this client not to come up for invoicing.
  219. *
  220. * @var bool
  221. *
  222. * @ORM\Column(name="hide_from_invoicing", type="boolean", options={"default"=false})
  223. */
  224. private $hide_from_invoicing;
  226. /**
  227. * @var string|null
  228. *
  229. * @ORM\Column(name="default_role", type="string", nullable=true)
  230. */
  231. private $default_role;
  233. /**
  234. * Holds the Account's payment terms value (in days) for adjusting
  235. * the due date on invoices automagically.
  236. *
  237. * @var int
  238. *
  239. * @ORM\Column(name="invoice_payment_terms", type="integer", nullable=true)
  240. */
  241. private $invoice_payment_terms;
  243. /**
  244. * @var int|null
  245. *
  246. * @ORM\Column(name="invoice_billing_frequency", type="integer", nullable=true)
  247. */
  248. private $invoice_billing_frequency;
  250. /**
  251. * @var int|null
  252. *
  253. * @ORM\Column(name="invoice_type", type="integer", nullable=true)
  254. */
  255. private $invoice_type;
  257. /**
  258. * The different UserNotifications disabled for this Client
  259. *
  260. * @var array
  261. *
  262. * @ORM\Column(name="disabled_notifications", type="array", nullable=true)
  263. */
  264. private $disabled_notifications = [];
  266. /**
  267. * A default sorting instruction for all the Account's sorting sessions.
  268. * This is visible to the sorter.
  269. *
  270. * @var SortingInstruction
  271. *
  272. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\SortingInstruction", inversedBy="account", cascade={"persist","remove"}, orphanRemoval=true)
  273. *
  274. * @ORM\JoinColumns({
  275. *
  276. * @ORM\JoinColumn(name="defaultSortingInstruction_id", referencedColumnName="id", unique=true)
  277. * })
  278. */
  279. private $defaultSortingInstruction;
  281. /**
  282. * Determines if a draft memo will be exported for the client on Sorting Session completions.
  283. *
  284. * @var bool
  285. *
  286. * @ORM\Column(name="requireMemo", type="boolean", options={"default"=false})
  287. */
  288. private $requireMemo = false;
  290. /**
  291. * Whether to require the user to enter a password on downloading a document or folder
  292. *
  293. * @var bool
  294. *
  295. * @ORM\Column(name="require_password_on_download", type="boolean", options={"default"=false})
  296. */
  297. private $require_password_on_download;
  299. /**
  300. * @var ArrayCollection
  301. *
  302. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\AccountSortingMemoPhrase", mappedBy="account", cascade={"all"})
  303. */
  304. private $accountSortingMemoPhrases;
  306. /**
  307. * @var MatterRequestDefaults
  308. *
  309. * @Groups({"account:read", "matter_request:read"})
  310. *
  311. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\MatterRequestDefaults", mappedBy="account")
  312. */
  313. private $matterRequestDefaults;
  315. /**
  316. * @var ContactableAddress
  317. *
  318. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ContactableAddress", cascade={"all"})
  319. *
  320. * @ORM\JoinColumns({
  321. *
  322. * @ORM\JoinColumn(name="billingAddress_id", referencedColumnName="id", unique=true)
  323. * })
  324. */
  325. private $billingAddress;
  327. /**
  328. * @var ContactableAddress
  329. */
  330. private $accountsAddress;
  332. /**
  333. * @var ContactableAddress
  334. *
  335. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ContactableAddress", cascade={"all"})
  336. *
  337. * @ORM\JoinColumns({
  338. *
  339. * @ORM\JoinColumn(name="physicalAddress_id", referencedColumnName="id", unique=true)
  340. * })
  341. */
  342. private $physicalAddress;
  344. /**
  345. * @var Collection
  346. *
  347. * @ORM\ManyToMany(targetEntity="MedBrief\MSR\Entity\ContactableAddress", inversedBy="accounts", cascade={"persist"})
  348. *
  349. * @ORM\JoinTable(name="account_contactableaddress",
  350. * joinColumns={
  351. *
  352. * @ORM\JoinColumn(name="account_id", referencedColumnName="id", onDelete="CASCADE")
  353. * },
  354. * inverseJoinColumns={
  355. * @ORM\JoinColumn(name="contactableaddress_id", referencedColumnName="id", onDelete="CASCADE")
  356. * }
  357. * )
  358. */
  359. private $offices;
  361. /**
  362. * @var string
  363. *
  364. * @ORM\Column(name="slug", type="string")
  365. *
  366. * @Gedmo\Slug(fields={"name"}, updatable=false, separator="_")
  367. */
  368. private $slug;
  370. /**
  371. * @var \DateTime
  372. *
  373. * @ORM\Column(name="created", type="datetime")
  374. *
  375. * @Gedmo\Timestampable(on="create")
  376. */
  377. private $created;
  379. /**
  380. * @var \DateTime
  381. *
  382. * @ORM\Column(name="updated", type="datetime")
  383. *
  384. * @Gedmo\Timestampable(on="update")
  385. */
  386. private $updated;
  388. /**
  389. * @var Collection
  390. *
  391. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Project", mappedBy="account", cascade={"all"})
  392. */
  393. private $projects;
  395. /**
  396. * @var Collection
  397. */
  398. private $addresses;
  400. /**
  401. * @var \DateTime
  402. *
  403. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
  404. */
  405. private $deletedAt;
  407. /**
  408. * @var string
  409. */
  410. private $image;
  412. /**
  413. * @var string
  414. *
  415. * @ORM\Column(name="image_name", type="string", length=255, nullable=true)
  416. */
  417. private $image_name;
  419. /**
  420. * Determines if an account can create/update batch requests and sort sessions.
  421. *
  422. * @var bool
  423. *
  424. * @ORM\Column(name="canCreateBatchAndSort", type="boolean", options={"default"=false})
  425. */
  426. private $canCreateBatchAndSort = false;
  428. /**
  429. * Determines if an account can is able to use match.
  430. *
  431. * @var bool
  432. *
  433. * @ORM\Column(name="matchOptIn", type="boolean", options={"default"=false})
  434. */
  435. private bool $matchOptIn = false;
  437. /**
  438. * Determines the default value of the same field on a Project/Matter, when a new Project is created.
  439. *
  440. * @var bool
  441. *
  442. * @ORM\Column(name="allowExpertViewUnsortedRecords", type="boolean", options={"default"=false})
  443. */
  444. private $allowExpertViewUnsortedRecords = false;
  446. /**
  447. * Determines if the questions presented during the Matter Closure Wizard are optional.
  448. *
  449. * @var bool
  450. *
  451. * @ORM\Column(name="matterClosureQuestionsOptional", type="boolean", options={"default"=false})
  452. */
  453. private $matterClosureQuestionsOptional = false;
  455. /**
  456. * @var bool
  457. *
  458. * @ORM\Column(name="useParentClinicalSectionsOnly", type="boolean")
  459. */
  460. private $useParentClinicalSectionsOnly = false;
  462. /**
  463. * @ORM\ManyToOne(targetEntity=Firm::class, inversedBy="clientAreas")
  464. */
  465. private $firm;
  467. /**
  468. * @Groups({"account:read", "matter_request:read"})
  469. *
  470. * @ORM\Column(name="allowedMatterTypes", type="array", nullable=true)
  471. *
  472. * @Assert\Count(
  473. * min=1,
  474. * minMessage = "Please select an option.",
  475. * groups={"account:read", "matter_request:read"}
  476. * )
  477. */
  478. private array $allowedMatterTypes = [];
  480. /**
  481. * @ORM\OneToMany(targetEntity=LicenceRenewalTerm::class, mappedBy="account", orphanRemoval=true)
  482. *
  483. * @ORM\OrderBy({"effectiveDate" = "ASC"})
  484. *
  485. * When a new period is added, a new related service option for the same period should also be created and mapped.
  486. */
  487. private ?Collection $licenceRenewalTerms;
  489. /**
  490. * Sets whether any client level users, or users invited to the client's
  491. * matters should require 2FA to be enabled.
  492. *
  493. * @ORM\Column(type="boolean", options={"default"=false})
  494. */
  495. private bool $enforceTwoFactorAuth = false;
  497. /**
  498. * If enabled, allows the users that are forced to enabled 2FA via the
  499. * enforceTwoFactorAuth property to skip the requirement for the first
  500. * two (2) logins.
  501. *
  502. * @ORM\Column(type="boolean", options={"default"=false})
  503. */
  504. private bool $allowTwoFactorAuthGracePeriod = false;
  506. /**
  507. * If enabled, the account (client) is not liable for the disclosure fee,
  508. * the Recipient Firm is liable.
  509. *
  510. * @ORM\Column(type="boolean", options={"default"=false})
  511. */
  512. private bool $clientNotLiableForDisclosureFee = false;
  514. /**
  515. * @var string|null
  516. *
  517. * @ORM\Column(name="trading_name", type="text", nullable=true)
  518. *
  519. * @Assert\NotBlank(message="Trading name is required")
  520. */
  521. private $trading_name = null;
  523. /**
  524. * @var string|null
  525. *
  526. * @ORM\Column(name="company_registration_number", type="string", length=255, nullable=true)
  527. *
  528. * @Assert\NotBlank(message="Company registration number is required")
  529. */
  530. private $company_registration_number = null;
  532. /**
  533. * @var string|null
  534. *
  535. * @ORM\Column(name="country_of_registration", type="string", length=255, nullable=true)
  536. *
  537. * @Assert\NotBlank(message="Country of registration is required")
  538. */
  539. private $country_of_registration = null;
  541. /**
  542. * Constructor
  543. */
  544. public function __construct()
  545. {
  546. $this->domains = new ArrayCollection();
  547. $this->allowed_license_levels = [];
  548. $this->hide_from_invoicing = false;
  549. $this->require_password_on_download = false;
  550. $this->accountSortingMemoPhrases = new ArrayCollection();
  551. $this->matterCreationProcess = self::MATTER_CREATION_PROCESS_CLASSIC;
  552. $this->projects = new ArrayCollection();
  553. $this->offices = new ArrayCollection();
  554. $this->licenceRenewalTerms = new ArrayCollection();
  555. }
  557. public function __toString()
  558. {
  559. return $this->getName();
  560. }
  562. /**
  563. * Get id
  564. *
  565. * @return int
  566. */
  567. public function getId()
  568. {
  569. return $this->id;
  570. }
  572. /**
  573. * Set name
  574. *
  575. * @param string $name
  576. *
  577. * @return Account
  578. */
  579. public function setName($name)
  580. {
  581. $this->name = $name;
  583. return $this;
  584. }
  586. /**
  587. * Get name
  588. *
  589. * @return string
  590. */
  591. public function getName()
  592. {
  593. return $this->name;
  594. }
  596. /**
  597. * Add domains
  598. *
  599. * @param Domain $domains
  600. *
  601. * @return Account
  602. */
  603. public function addDomain(Domain $domains)
  604. {
  605. $this->domains[] = $domains;
  607. return $this;
  608. }
  610. /**
  611. * Remove domains
  612. *
  613. * @param Domain $domains
  614. */
  615. public function removeDomain(Domain $domains)
  616. {
  617. $this->domains->removeElement($domains);
  618. }
  620. /**
  621. * Get domains
  622. *
  623. * @return Collection
  624. */
  625. public function getDomains()
  626. {
  627. return $this->domains;
  628. }
  630. /**
  631. * Set slug
  632. *
  633. * @param string $slug
  634. *
  635. * @return Account
  636. */
  637. public function setSlug($slug)
  638. {
  639. $this->slug = $slug;
  641. return $this;
  642. }
  644. /**
  645. * Get slug
  646. *
  647. * @return string
  648. */
  649. public function getSlug()
  650. {
  651. return $this->slug;
  652. }
  654. /**
  655. * Set created
  656. *
  657. * @param \DateTime $created
  658. *
  659. * @return Account
  660. */
  661. public function setCreated($created)
  662. {
  663. $this->created = $created;
  665. return $this;
  666. }
  668. /**
  669. * Get created
  670. *
  671. * @return \DateTime
  672. */
  673. public function getCreated()
  674. {
  675. return $this->created;
  676. }
  678. /**
  679. * Set updated
  680. *
  681. * @param \DateTime $updated
  682. *
  683. * @return Account
  684. */
  685. public function setUpdated($updated)
  686. {
  687. $this->updated = $updated;
  689. return $this;
  690. }
  692. /**
  693. * Get updated
  694. *
  695. * @return \DateTime
  696. */
  697. public function getUpdated()
  698. {
  699. return $this->updated;
  700. }
  702. /**
  703. * Add projects
  704. *
  705. * @param Project $projects
  706. *
  707. * @return Account
  708. */
  709. public function addProject(Project $projects)
  710. {
  711. $this->projects[] = $projects;
  713. return $this;
  714. }
  716. /**
  717. * Remove projects
  718. *
  719. * @param Project $projects
  720. */
  721. public function removeProject(Project $projects)
  722. {
  723. $this->projects->removeElement($projects);
  724. }
  726. /**
  727. * Get projects
  728. *
  729. * @return Collection
  730. */
  731. public function getProjects()
  732. {
  733. return $this->projects;
  734. }
  736. public function getArchivedProjects()
  737. {
  738. $criteria = Criteria::create()
  739. ->where(Criteria::expr()->gt('archive_status', 0))
  740. ->orderBy(['name' => Criteria::ASC])
  741. ;
  743. return $this->getProjects()->matching($criteria);
  744. }
  746. public function getActiveProjects()
  747. {
  748. $criteria = Criteria::create()
  749. ->where(Criteria::expr()->eq('status', Project::STATUS_ACTIVE))
  750. ->orderBy(['name' => Criteria::ASC])
  751. ;
  753. return $this->getProjects()->matching($criteria);
  754. }
  756. public function getInactiveProjects()
  757. {
  758. $criteria = Criteria::create()
  759. ->where(Criteria::expr()->eq('status', Project::STATUS_INACTIVE))
  760. ->orderBy(['name' => Criteria::ASC])
  761. ;
  763. return $this->getProjects()->matching($criteria);
  764. }
  766. /**
  767. * Set invoice_billing_frequency
  768. *
  769. * @param string $invoiceBillingFrequency
  770. *
  771. * @return Account
  772. */
  773. public function setInvoiceBillingFrequency($invoiceBillingFrequency)
  774. {
  775. $this->invoice_billing_frequency = $invoiceBillingFrequency;
  777. return $this;
  778. }
  780. /**
  781. * Get invoice_billing_frequency
  782. *
  783. * @return string
  784. */
  785. public function getInvoiceBillingFrequency()
  786. {
  787. return $this->invoice_billing_frequency;
  788. }
  790. /**
  791. * Set invoice_type
  792. *
  793. * @param string $invoiceType
  794. *
  795. * @return Account
  796. */
  797. public function setInvoiceType($invoiceType)
  798. {
  799. $this->invoice_type = $invoiceType;
  801. return $this;
  802. }
  804. /**
  805. * Get invoice_type
  806. *
  807. * @return string
  808. */
  809. public function getInvoiceType()
  810. {
  811. return $this->invoice_type;
  812. }
  814. /**
  815. * Set billingAddress
  816. *
  817. * @param ContactableAddress $billingAddress
  818. *
  819. * @return Account
  820. */
  821. public function setBillingAddress(?ContactableAddress $billingAddress = null)
  822. {
  823. $this->billingAddress = $billingAddress;
  825. return $this;
  826. }
  828. /**
  829. * Get billingAddress
  830. *
  831. * @return ContactableAddress
  832. */
  833. public function getBillingAddress()
  834. {
  835. return $this->billingAddress;
  836. }
  838. /**
  839. * Set accountsAddress
  840. *
  841. * @param ContactableAddress $accountsAddress
  842. *
  843. * @return Account
  844. */
  845. public function setAccountsAddress(?ContactableAddress $accountsAddress = null)
  846. {
  847. $this->accountsAddress = $accountsAddress;
  849. return $this;
  850. }
  852. /**
  853. * Get accountsAddress
  854. *
  855. * @return ContactableAddress
  856. */
  857. public function getAccountsAddress()
  858. {
  859. return $this->accountsAddress;
  860. }
  862. /**
  863. * Set physicalAddress
  864. *
  865. * @param ContactableAddress $physicalAddress
  866. *
  867. * @return Account
  868. */
  869. public function setPhysicalAddress(?ContactableAddress $physicalAddress = null)
  870. {
  871. $this->physicalAddress = $physicalAddress;
  873. return $this;
  874. }
  876. /**
  877. * Get physicalAddress
  878. *
  879. * @return ContactableAddress
  880. */
  881. public function getPhysicalAddress()
  882. {
  883. return $this->physicalAddress;
  884. }
  886. /**
  887. * Add offices
  888. *
  889. * @param ContactableAddress $offices
  890. *
  891. * @return Account
  892. */
  893. public function addOffice(ContactableAddress $offices)
  894. {
  895. $this->offices[] = $offices;
  897. return $this;
  898. }
  900. /**
  901. * Remove offices
  902. *
  903. * @param ContactableAddress $offices
  904. */
  905. public function removeOffice(ContactableAddress $offices)
  906. {
  907. $this->offices->removeElement($offices);
  908. }
  910. /**
  911. * Get offices
  912. *
  913. * @return Collection
  914. */
  915. public function getOffices()
  916. {
  917. return $this->offices;
  918. }
  920. /**
  921. * Returns an array of permitted values for the invoice billing frequency field and their
  922. * associated labels,
  923. *
  924. * @return array
  925. */
  926. public static function getInvoiceBillingFrequencyOptions()
  927. {
  928. return [
  929. self::INVOICE_BILLING_FREQUENCY_MONTHLY => 'Monthly',
  930. self::INVOICE_BILLING_FREQUENCY_QUARTERLY => 'Quarterly',
  931. self::INVOICE_BILLING_FREQUENCY_START_OF_MATTER => 'At the start of the matter',
  932. ];
  933. }
  935. /**
  936. * Returns a human readable version of the invoice billing frequency
  937. *
  938. * @return string
  939. */
  940. public function getInvoiceBillingFrequencyName()
  941. {
  942. $options = self::getInvoiceBillingFrequencyOptions();
  944. return
  945. $options[$this->getInvoiceBillingFrequency()] ?? $this->getInvoiceBillingFrequency();
  946. }
  948. /**
  949. * Returns an array of permitted values for the invoice billing frequency field and their
  950. * associated labels,
  951. *
  952. * @return array
  953. */
  954. public static function getInvoiceTypeOptions()
  955. {
  956. return [
  957. self::INVOICE_TYPE_CONSOLIDATED => 'Consolidated',
  958. self::INVOICE_TYPE_INDIVIDUAL_MATTER => 'Individual Matter',
  959. ];
  960. }
  962. /**
  963. * Returns a human readable version of the invoice billing frequency
  964. *
  965. * @return string
  966. */
  967. public function getInvoiceTypeName()
  968. {
  969. $options = self::getInvoiceTypeOptions();
  971. return
  972. $options[$this->getInvoiceType()] ?? $this->getInvoiceType();
  973. }
  975. /**
  976. * Set deletedAt
  977. *
  978. * @param \DateTime $deletedAt
  979. *
  980. * @return Account
  981. */
  982. public function setDeletedAt($deletedAt)
  983. {
  984. $this->deletedAt = $deletedAt;
  986. return $this;
  987. }
  989. /**
  990. * Get deletedAt
  991. *
  992. * @return \DateTime
  993. */
  994. public function getDeletedAt()
  995. {
  996. return $this->deletedAt;
  997. }
  999. /**
  1000. * Set image
  1001. *
  1002. * @param string $image
  1003. *
  1004. * @return Account
  1005. */
  1006. public function setImage($image)
  1007. {
  1008. if (null !== $image) {
  1009. // It is required that at least one field changes if you are using doctrine
  1010. // otherwise the event listeners won't be called and the file is lost
  1011. $this->updated = new \DateTimeImmutable();
  1012. }
  1014. $this->image = $image;
  1016. return $this;
  1017. }
  1019. /**
  1020. * Indicates whether or not this user has an image
  1021. *
  1022. * @return bool
  1023. */
  1024. public function hasImage()
  1025. {
  1026. // note that we use the imageName field because the image field will be
  1027. // populated with the gaufrette file location immediately on upload
  1028. // even if the upload fails. So if you call this function on the user
  1029. // before it is peristed it may give you a false positive.
  1030. $image = $this->getImageName();
  1032. return !empty($image);
  1033. }
  1035. /**
  1036. * Get image
  1037. *
  1038. * @return string
  1039. */
  1040. public function getImage()
  1041. {
  1042. return $this->image;
  1043. }
  1045. /**
  1046. * Set image_name
  1047. *
  1048. * @param string $imageName
  1049. *
  1050. * @return Account
  1051. */
  1052. public function setImageName($imageName)
  1053. {
  1054. $this->image_name = $imageName;
  1056. return $this;
  1057. }
  1059. /**
  1060. * Get image_name
  1061. *
  1062. * @return string
  1063. */
  1064. public function getImageName()
  1065. {
  1066. return $this->image_name;
  1067. }
  1069. /**
  1070. * Set allowedLicenseLevels
  1071. *
  1072. * @param array $allowedLicenseLevels
  1073. *
  1074. * @return Account
  1075. */
  1076. public function setAllowedLicenseLevels($allowedLicenseLevels)
  1077. {
  1078. $this->allowed_license_levels = $allowedLicenseLevels;
  1080. return $this;
  1081. }
  1083. /**
  1084. * Get allowedLicenseLevels
  1085. *
  1086. * @return array
  1087. */
  1088. public function getAllowedLicenseLevels()
  1089. {
  1090. if ($this->allowed_license_levels === null) {
  1091. return [];
  1092. }
  1094. return $this->allowed_license_levels;
  1095. }
  1097. /**
  1098. * Set prefix
  1099. *
  1100. * @param string $prefix
  1101. *
  1102. * @return Account
  1103. */
  1104. public function setPrefix($prefix)
  1105. {
  1106. $this->prefix = strtoupper($prefix);
  1108. return $this;
  1109. }
  1111. /**
  1112. * Get prefix
  1113. *
  1114. * @return string
  1115. */
  1116. public function getPrefix()
  1117. {
  1118. return strtoupper($this->prefix);
  1119. }
  1121. /**
  1122. * Set legalEntityName
  1123. *
  1124. * @param string $legalEntityName
  1125. *
  1126. * @return Account
  1127. */
  1128. public function setLegalEntityName($legalEntityName)
  1129. {
  1130. $this->legal_entity_name = $legalEntityName;
  1132. return $this;
  1133. }
  1135. /**
  1136. * Get legalEntityName
  1137. *
  1138. * @return string
  1139. */
  1140. public function getLegalEntityName()
  1141. {
  1142. return $this->legal_entity_name;
  1143. }
  1145. /**
  1146. * Set defaultRole
  1147. *
  1148. * @param string $defaultRole
  1149. *
  1150. * @return Account
  1151. */
  1152. public function setDefaultRole($defaultRole)
  1153. {
  1154. $this->default_role = $defaultRole;
  1156. return $this;
  1157. }
  1159. /**
  1160. * Get defaultRole
  1161. *
  1162. * @return string
  1163. */
  1164. public function getDefaultRole()
  1165. {
  1166. return $this->default_role;
  1167. }
  1169. /**
  1170. * Get defaultRoleOptions
  1171. *
  1172. * @return array
  1173. */
  1174. public static function getDefaultRoleOptions()
  1175. {
  1176. return [
  1177. self::DEFAULT_ROLE_ADMINISTRATOR => 'Client Administrator',
  1178. self::DEFAULT_ROLE_SUPERADMINISTRATOR => 'Client Super Administrator',
  1179. self::DEFAULT_ROLE_PROJECTMANAGER => 'Client Project Manager',
  1180. self::DEFAULT_ROLE_SORTER => 'Sorter',
  1181. ];
  1182. }
  1184. /**
  1185. * Get DefaultRoleLabel
  1186. *
  1187. * @return string
  1188. */
  1189. public function getDefaultRoleLabel()
  1190. {
  1191. $options = self::getDefaultRoleOptions();
  1192. return $options[$this->getDefaultRole()] ?? '';
  1193. }
  1195. /**
  1196. * Get DefaultRoleLabel
  1197. *
  1198. * @return string
  1199. */
  1200. public function getDefaultRoleAsRole()
  1201. {
  1202. if (!$this->getDefaultRole()) {
  1203. return '';
  1204. }
  1206. return 'ROLE_ACCOUNT_' . $this->getId() . '_' . $this->getDefaultRole();
  1207. }
  1209. /**
  1210. * Set hideFromInvoicing
  1211. *
  1212. * @param bool $hideFromInvoicing
  1213. *
  1214. * @return Account
  1215. */
  1216. public function setHideFromInvoicing($hideFromInvoicing)
  1217. {
  1218. $this->hide_from_invoicing = $hideFromInvoicing;
  1220. return $this;
  1221. }
  1223. /**
  1224. * Get hideFromInvoicing
  1225. *
  1226. * @return bool
  1227. */
  1228. public function getHideFromInvoicing()
  1229. {
  1230. return $this->hide_from_invoicing;
  1231. }
  1233. /**
  1234. * Set invoicePaymentTerms
  1235. *
  1236. * @param int $invoicePaymentTerms
  1237. *
  1238. * @return Account
  1239. */
  1240. public function setInvoicePaymentTerms($invoicePaymentTerms)
  1241. {
  1242. $this->invoice_payment_terms = $invoicePaymentTerms;
  1244. return $this;
  1245. }
  1247. /**
  1248. * Get invoicePaymentTerms
  1249. *
  1250. * @return int
  1251. */
  1252. public function getInvoicePaymentTerms()
  1253. {
  1254. return $this->invoice_payment_terms;
  1255. }
  1257. /**
  1258. * Get the disabled UserNotification types
  1259. *
  1260. * @return array
  1261. */
  1262. public function getDisabledNotifications(): array
  1263. {
  1264. return $this->disabled_notifications ?: [];
  1265. }
  1267. /**
  1268. * @param array $disabled_notifications
  1269. *
  1270. * @return Account
  1271. */
  1272. public function setDisabledNotifications(array $disabled_notifications): Account
  1273. {
  1274. $this->disabled_notifications = $disabled_notifications;
  1276. return $this;
  1277. }
  1279. /**
  1280. * Disable a notification
  1281. *
  1282. * @param $notification_type
  1283. *
  1284. * @return Account
  1285. */
  1286. public function disableNotification($notification_type)
  1287. {
  1288. if (!$this->disabled_notifications) {
  1289. $this->disabled_notifications = [];
  1290. }
  1292. array_push($this->disabled_notifications, $notification_type);
  1294. return $this;
  1295. }
  1297. /**
  1298. * Function to determine if the specific UserNotification is disabled for this Entity
  1299. *
  1300. * @param $notification_type
  1301. *
  1302. * @return bool
  1303. */
  1304. public function isNotificationDisabled($notification_type)
  1305. {
  1306. if (!$this->disabled_notifications) {
  1307. $this->disabled_notifications = [];
  1308. return false;
  1309. }
  1310. return in_array($notification_type, $this->disabled_notifications) ? true : false;
  1311. }
  1313. /**
  1314. * Set defaultSortingInstruction.
  1315. *
  1316. * @param SortingInstruction|null $defaultSortingInstruction
  1317. *
  1318. * @return Account
  1319. */
  1320. public function setDefaultSortingInstruction(?SortingInstruction $defaultSortingInstruction = null)
  1321. {
  1322. $this->defaultSortingInstruction = $defaultSortingInstruction;
  1324. return $this;
  1325. }
  1327. /**
  1328. * Get defaultSortingInstruction.
  1329. *
  1330. * @return SortingInstruction|null
  1331. */
  1332. public function getDefaultSortingInstruction()
  1333. {
  1334. return $this->defaultSortingInstruction;
  1335. }
  1337. /**
  1338. * Set requireMemo.
  1339. *
  1340. * @param bool $requireMemo
  1341. *
  1342. * @return Account
  1343. */
  1344. public function setRequireMemo($requireMemo)
  1345. {
  1346. $this->requireMemo = $requireMemo;
  1348. return $this;
  1349. }
  1351. /**
  1352. * Get requireMemo.
  1353. *
  1354. * @return bool
  1355. */
  1356. public function getRequireMemo()
  1357. {
  1358. return $this->requireMemo;
  1359. }
  1361. /**
  1362. * Set requirePasswordOnDownload.
  1363. *
  1364. * @param bool $requirePasswordOnDownload
  1365. *
  1366. * @return Account
  1367. */
  1368. public function setRequirePasswordOnDownload($requirePasswordOnDownload)
  1369. {
  1370. $this->require_password_on_download = $requirePasswordOnDownload;
  1372. return $this;
  1373. }
  1375. /**
  1376. * Get requirePasswordOnDownload.
  1377. *
  1378. * @return bool
  1379. */
  1380. public function getRequirePasswordOnDownload()
  1381. {
  1382. return $this->require_password_on_download;
  1383. }
  1385. /**
  1386. * Add accountSortingMemoPhrase.
  1387. *
  1388. * @param AccountSortingMemoPhrase $accountSortingMemoPhrase
  1389. *
  1390. * @return Account
  1391. */
  1392. public function addAccountSortingMemoPhrase(AccountSortingMemoPhrase $accountSortingMemoPhrase)
  1393. {
  1394. $this->accountSortingMemoPhrases[] = $accountSortingMemoPhrase;
  1396. return $this;
  1397. }
  1399. /**
  1400. * Remove accountSortingMemoPhrase.
  1401. *
  1402. * @param AccountSortingMemoPhrase $accountSortingMemoPhrase
  1403. *
  1404. * @return bool TRUE if this collection contained the specified element, FALSE otherwise.
  1405. */
  1406. public function removeAccountSortingMemoPhrase(AccountSortingMemoPhrase $accountSortingMemoPhrase)
  1407. {
  1408. return $this->accountSortingMemoPhrases->removeElement($accountSortingMemoPhrase);
  1409. }
  1411. /**
  1412. * Get accountSortingMemoPhrases.
  1413. *
  1414. * @return Collection
  1415. */
  1416. public function getAccountSortingMemoPhrases()
  1417. {
  1418. return $this->accountSortingMemoPhrases;
  1419. }
  1421. /**
  1422. * Set matterRequestDefaults.
  1423. *
  1424. * @param MatterRequestDefaults|null $matterRequestDefaults
  1425. *
  1426. * @return Account
  1427. */
  1428. public function setMatterRequestDefaults(?MatterRequestDefaults $matterRequestDefaults = null)
  1429. {
  1430. $this->matterRequestDefaults = $matterRequestDefaults;
  1432. return $this;
  1433. }
  1435. /**
  1436. * Get matterRequestDefaults.
  1437. *
  1438. * @return MatterRequestDefaults|null
  1439. */
  1440. public function getMatterRequestDefaults()
  1441. {
  1442. return $this->matterRequestDefaults;
  1443. }
  1445. /**
  1446. * Returns the return details address.
  1447. *
  1448. * @return ContactableAddress|null
  1449. */
  1450. public function getReturnDetailsAddress(): ?ContactableAddress
  1451. {
  1452. if ($this->getOffices() && $this->getOffices()->first()) {
  1453. return $this->getOffices()->first();
  1454. }
  1455. return null;
  1456. }
  1458. /**
  1459. * Set matterCreationProcess.
  1460. *
  1461. * @param string|null $matterCreationProcess
  1462. *
  1463. * @return Account
  1464. */
  1465. public function setMatterCreationProcess($matterCreationProcess = null): Account
  1466. {
  1467. $this->matterCreationProcess = $matterCreationProcess;
  1469. return $this;
  1470. }
  1472. /**
  1473. * Set customIndexHeader.
  1474. *
  1475. * @param string|null $customIndexHeader
  1476. *
  1477. * @return Account
  1478. */
  1479. public function setCustomIndexHeader($customIndexHeader = null)
  1480. {
  1481. $this->custom_index_header = $customIndexHeader;
  1483. return $this;
  1484. }
  1486. /**
  1487. * Get customIndexHeader.
  1488. *
  1489. * @return string|null
  1490. */
  1491. public function getCustomIndexHeader()
  1492. {
  1493. return $this->custom_index_header;
  1494. }
  1496. /**
  1497. * Get matterCreationProcess.
  1498. *
  1499. * @return string|null
  1500. */
  1501. public function getMatterCreationProcess(): ?string
  1502. {
  1503. return $this->matterCreationProcess;
  1504. }
  1506. /**
  1507. * Returns true if the client has access to classic matter creation.
  1508. *
  1509. * @return bool
  1510. */
  1511. public function hasAccessToClassicMatterCreation(): bool
  1512. {
  1513. return $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_CLASSIC || $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_ALL || $this->matterCreationProcess === null;
  1514. }
  1516. /**
  1517. * Returns true if the client has access to standard matter creation.
  1518. *
  1519. * @return bool
  1520. */
  1521. public function hasAccessToStandardMatterCreation(): bool
  1522. {
  1523. return $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_STANDARD || $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_ALL;
  1524. }
  1526. /**
  1527. * Returns matter creations options as an array, usable as the choices for a form.
  1528. *
  1529. * @return array
  1530. */
  1531. public static function getMatterCreationProcessOptions(): array
  1532. {
  1533. $matterCreationProcessOptions = self::getConstantsWithLabelsAsChoices('MATTER_CREATION_PROCESS');
  1535. return array_flip($matterCreationProcessOptions);
  1536. }
  1538. /**
  1539. * Returns a human readable version of matterCreationProcess.
  1540. *
  1541. * @return string
  1542. */
  1543. public function getMatterCreationProcessName()
  1544. {
  1545. $options = self::getMatterCreationProcessOptions();
  1547. return $options[$this->getMatterCreationProcess()] ?? $this->getMatterCreationProcess();
  1548. }
  1550. /**
  1551. * Get the value of standardIndexHeader
  1552. *
  1553. * @return string|null
  1554. */
  1555. public function getStandardIndexHeader()
  1556. {
  1557. return $this->standardIndexHeader;
  1558. }
  1560. /**
  1561. * Set the value of standardIndexHeader
  1562. *
  1563. * @param string|null $standardIndexHeader
  1564. *
  1565. * @return self
  1566. */
  1567. public function setStandardIndexHeader($standardIndexHeader)
  1568. {
  1569. $this->standardIndexHeader = $standardIndexHeader;
  1571. return $this;
  1572. }
  1574. /**
  1575. * Set canCreateBatchAndSort.
  1576. *
  1577. * @param bool $canCreateBatchAndSort
  1578. *
  1579. * @return Account
  1580. */
  1581. public function setCanCreateBatchAndSort($canCreateBatchAndSort)
  1582. {
  1583. $this->canCreateBatchAndSort = $canCreateBatchAndSort;
  1585. return $this;
  1586. }
  1588. /**
  1589. * Get canCreateBatchAndSort.
  1590. *
  1591. * @return bool
  1592. */
  1593. public function getCanCreateBatchAndSort()
  1594. {
  1595. return $this->canCreateBatchAndSort;
  1596. }
  1598. /**
  1599. * Set matchOptIn.
  1600. *
  1601. * @param bool $matchOptIn
  1602. *
  1603. * @return Account
  1604. */
  1605. public function setMatchOptIn(bool $matchOptIn): self
  1606. {
  1607. $this->matchOptIn = $matchOptIn;
  1609. return $this;
  1610. }
  1612. /**
  1613. * Get matchOptIn.
  1614. *
  1615. * @return bool
  1616. */
  1617. public function getMatchOptIn(): bool
  1618. {
  1619. return $this->matchOptIn;
  1620. }
  1622. /**
  1623. * getAllowExpertViewUnsortedRecords
  1624. *
  1625. * @return bool
  1626. */
  1627. public function getAllowExpertViewUnsortedRecords(): bool
  1628. {
  1629. return $this->allowExpertViewUnsortedRecords;
  1630. }
  1632. /**
  1633. * @param bool $allowExpertViewUnsortedRecords
  1634. *
  1635. * @return self
  1636. */
  1637. public function setAllowExpertViewUnsortedRecords(bool $allowExpertViewUnsortedRecords): self
  1638. {
  1639. $this->allowExpertViewUnsortedRecords = $allowExpertViewUnsortedRecords;
  1641. return $this;
  1642. }
  1644. /**
  1645. * @return bool
  1646. */
  1647. public function getMatterClosureQuestionsOptional(): bool
  1648. {
  1649. return $this->matterClosureQuestionsOptional;
  1650. }
  1652. /**
  1653. * @param bool $matterClosureQuestionsOptional
  1654. *
  1655. * @return Account
  1656. */
  1657. public function setMatterClosureQuestionsOptional(bool $matterClosureQuestionsOptional): self
  1658. {
  1659. $this->matterClosureQuestionsOptional = $matterClosureQuestionsOptional;
  1661. return $this;
  1662. }
  1664. /**
  1665. * @return bool|null
  1666. *
  1667. */
  1668. public function getUseParentClinicalSectionsOnly(): ?bool
  1669. {
  1670. return $this->useParentClinicalSectionsOnly;
  1671. }
  1673. /**
  1674. * @param bool $useParentClinicalSectionsOnly
  1675. *
  1676. * @return self
  1677. *
  1678. */
  1679. public function setUseParentClinicalSectionsOnly(bool $useParentClinicalSectionsOnly): self
  1680. {
  1681. $this->useParentClinicalSectionsOnly = $useParentClinicalSectionsOnly;
  1683. return $this;
  1684. }
  1686. public function getFirm(): ?Firm
  1687. {
  1688. return $this->firm;
  1689. }
  1691. public function setFirm(?Firm $firm): self
  1692. {
  1693. $this->firm = $firm;
  1695. return $this;
  1696. }
  1698. /**
  1699. * @return bool
  1700. */
  1701. public function getHideLogoFromIndex(): bool
  1702. {
  1703. return $this->hideLogoFromIndex;
  1704. }
  1706. /**
  1707. * @param bool $hideLogoFromIndex
  1708. *
  1709. * @return self
  1710. */
  1711. public function setHideLogoFromIndex(bool $hideLogoFromIndex): self
  1712. {
  1713. $this->hideLogoFromIndex = $hideLogoFromIndex;
  1715. return $this;
  1716. }
  1718. /**
  1719. * @return array|null
  1720. *
  1721. */
  1722. public function getAllowedMatterTypes(): ?array
  1723. {
  1724. return $this->allowedMatterTypes;
  1725. }
  1727. /**
  1728. * @param array|null $allowedMatterTypes
  1729. *
  1730. * @return self
  1731. *
  1732. */
  1733. public function setAllowedMatterTypes(?array $allowedMatterTypes): self
  1734. {
  1735. $this->allowedMatterTypes = $allowedMatterTypes;
  1737. return $this;
  1738. }
  1740. /**
  1741. * @return array
  1742. */
  1743. public static function getAllowedMatterTypeOptions(): array
  1744. {
  1745. return self::getConstantsWithLabelsAsChoices('MATTER_TYPE');
  1746. }
  1748. /**
  1749. * @return Collection<int, LicenceRenewalTerm>
  1750. */
  1751. public function getLicenceRenewalTerms(): Collection
  1752. {
  1753. return $this->licenceRenewalTerms;
  1754. }
  1756. /**
  1757. * @return Collection<int, LicenceRenewalTerm>
  1758. */
  1759. public function getZeroPeriodLicenceRenewalTerms(): Collection
  1760. {
  1761. return $this->licenceRenewalTerms->filter(function ($term) {
  1762. return $term->getPeriod() === 0;
  1763. });
  1764. }
  1766. /**
  1767. * @param LicenceRenewalTerm $licenceRenewalTerm
  1768. *
  1769. * @return self
  1770. */
  1771. public function addLicenceRenewalTerm(LicenceRenewalTerm $licenceRenewalTerm): self
  1772. {
  1773. if (!$this->licenceRenewalTerms->contains($licenceRenewalTerm)) {
  1774. $this->licenceRenewalTerms[] = $licenceRenewalTerm;
  1775. $licenceRenewalTerm->setAccount($this);
  1776. }
  1778. return $this;
  1779. }
  1781. /**
  1782. * @param LicenceRenewalTerm $licenceRenewalTerm
  1783. *
  1784. * @return self
  1785. */
  1786. public function removeLicenceRenewalTerm(LicenceRenewalTerm $licenceRenewalTerm): self
  1787. {
  1788. if ($this->licenceRenewalTerms->removeElement($licenceRenewalTerm)) {
  1789. // set the owning side to null (unless already changed)
  1790. if ($licenceRenewalTerm->getAccount() === $this) {
  1791. $licenceRenewalTerm->setAccount(null);
  1792. }
  1793. }
  1795. return $this;
  1796. }
  1798. /**
  1799. * @return bool|null
  1800. */
  1801. public function isEnforceTwoFactorAuth(): ?bool
  1802. {
  1803. return $this->enforceTwoFactorAuth;
  1804. }
  1806. /**
  1807. * @param bool $enforceTwoFactorAuth
  1808. *
  1809. * @return self
  1810. */
  1811. public function setEnforceTwoFactorAuth(bool $enforceTwoFactorAuth): self
  1812. {
  1813. $this->enforceTwoFactorAuth = $enforceTwoFactorAuth;
  1815. return $this;
  1816. }
  1818. /**
  1819. * @return bool|null
  1820. */
  1821. public function isAllowTwoFactorAuthGracePeriod(): ?bool
  1822. {
  1823. return $this->allowTwoFactorAuthGracePeriod;
  1824. }
  1826. /**
  1827. * @param bool $allowTwoFactorAuthGracePeriod
  1828. *
  1829. * @return self
  1830. */
  1831. public function setAllowTwoFactorAuthGracePeriod(bool $allowTwoFactorAuthGracePeriod): self
  1832. {
  1833. $this->allowTwoFactorAuthGracePeriod = $allowTwoFactorAuthGracePeriod;
  1835. return $this;
  1836. }
  1838. /**
  1839. * Checks if the client is not liable for the disclosure fee.
  1840. *
  1841. * @return bool True if the client is not liable, false otherwise.
  1842. */
  1843. public function isClientNotLiableForDisclosureFee(): bool
  1844. {
  1845. return $this->clientNotLiableForDisclosureFee;
  1846. }
  1848. /**
  1849. * Sets whether the client is not liable for the disclosure fee.
  1850. *
  1851. * @param bool $clientNotLiableForDisclosureFee True if the client is not liable, false otherwise.
  1852. *
  1853. * @return self
  1854. */
  1855. public function setClientNotLiableForDisclosureFee(bool $clientNotLiableForDisclosureFee): self
  1856. {
  1857. $this->clientNotLiableForDisclosureFee = $clientNotLiableForDisclosureFee;
  1859. return $this;
  1860. }
  1862. /**
  1863. * Returns an array of permitted values for the country of registration field and their
  1864. * associated labels.
  1865. *
  1866. * @return array
  1867. */
  1868. public static function getCountryOfRegistrationOptions()
  1869. {
  1870. return [
  1871. self::COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES => self::COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES__LABEL,
  1872. self::COUNTRY_OF_REGISTRATION_SCOTLAND => self::COUNTRY_OF_REGISTRATION_SCOTLAND__LABEL,
  1873. self::COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND => self::COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND__LABEL,
  1874. ];
  1875. }
  1877. /**
  1878. * Get trading_name.
  1879. *
  1880. * @return string|null
  1881. */
  1882. public function getTradingName(): ?string
  1883. {
  1884. return $this->trading_name;
  1885. }
  1887. /**
  1888. * Set trading_name.
  1889. *
  1890. * @param string|null $trading_name
  1891. *
  1892. * @return self
  1893. */
  1894. public function setTradingName(?string $trading_name): self
  1895. {
  1896. $this->trading_name = $trading_name;
  1898. return $this;
  1899. }
  1901. /**
  1902. * Get company_registration_number.
  1903. *
  1904. * @return string|null
  1905. */
  1906. public function getCompanyRegistrationNumber(): ?string
  1907. {
  1908. return $this->company_registration_number;
  1909. }
  1911. /**
  1912. * Set company_registration_number.
  1913. *
  1914. * @param string|null $company_registration_number
  1915. *
  1916. * @return self
  1917. */
  1918. public function setCompanyRegistrationNumber(?string $company_registration_number): self
  1919. {
  1920. $this->company_registration_number = $company_registration_number;
  1922. return $this;
  1923. }
  1925. /**
  1926. * Get country_of_registration.
  1927. *
  1928. * @return string|null
  1929. */
  1930. public function getCountryOfRegistration(): ?string
  1931. {
  1932. return $this->country_of_registration;
  1933. }
  1935. /**
  1936. * Set country_of_registration.
  1937. *
  1938. * @param string|null $country_of_registration
  1939. *
  1940. * @return self
  1941. */
  1942. public function setCountryOfRegistration(?string $country_of_registration): self
  1943. {
  1944. $this->country_of_registration = $country_of_registration;
  1946. return $this;
  1947. }
  1949. /**
  1950. * Returns a human-readable version of the country of registration
  1951. *
  1952. * @return string
  1953. */
  1954. public function getCountryOfRegistrationName()
  1955. {
  1956. $options = self::getCountryOfRegistrationOptions();
  1958. return $options[$this->getCountryOfRegistration()] ?? $this->getCountryOfRegistration();
  1959. }
  1960. }