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. // Match Opt In options
  131. public const MATCH_OPT_IN_NONE = 'none';
  132. public const MATCH_OPT_IN_NONE__LABEL = 'None';
  133. public const MATCH_OPT_IN_ALL_CLIENT_USERS = 'all_client_users';
  134. public const MATCH_OPT_IN_ALL_CLIENT_USERS__LABEL = 'All Client Users';
  135. public const MATCH_OPT_IN_SPECIFIC_USERS = 'specific_users';
  136. public const MATCH_OPT_IN_SPECIFIC_USERS__LABEL = 'Specific Users';
  138. /**
  139. * @var ContactableAddress
  140. *
  141. * This field is unmapped, and is purely here for the API.
  142. *
  143. * @Groups({"account:read", "matter_request:read"})
  144. */
  145. protected $returnDetailsAddress;
  147. /**
  148. * @var string
  149. *
  150. * @ORM\Column(name="matterCreationProcess", type="string", nullable=true)
  151. */
  152. protected $matterCreationProcess = self::MATTER_CREATION_PROCESS_CLASSIC;
  154. /**
  155. * @var string|null
  156. *
  157. * @ORM\Column(name="custom_index_header", type="text", nullable=true)
  158. */
  159. protected $custom_index_header;
  161. /**
  162. * @var string|null
  163. *
  164. * @ORM\Column(name="standardIndexHeader", type="text", nullable=true)
  165. */
  166. protected $standardIndexHeader;
  168. /**
  169. * Indicates if the MedBrief logo should be hidden from the index produced.
  170. * The scenario for this is where clients sort their own records, or a sorting standard that
  171. * deviates from our standard sorting product.
  172. *
  173. * @var bool
  174. *
  175. * @ORM\Column(type="boolean", options={"default"=false})
  176. */
  177. protected $hideLogoFromIndex = false;
  179. /**
  180. * @Groups({"client_area:read"})
  181. *
  182. * @ORM\Column(name="id", type="bigint", nullable=false)
  183. *
  184. * @ORM\Id
  185. *
  186. * @ORM\GeneratedValue(strategy="IDENTITY")
  187. */
  188. private ?int $id;
  190. /**
  191. * @Groups({"account:read", "matter_request:read", "client_area:read"})
  192. *
  193. * @ORM\Column(name="name", type="string", length=155, nullable=false)
  194. */
  195. private ?string $name;
  197. /**
  198. * @var Collection
  199. *
  200. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Domain", mappedBy="account", cascade={"all"})
  201. */
  202. private $domains;
  204. /**
  205. * @var array|null
  206. *
  207. * @ORM\Column(name="allowed_license_levels", type="array", nullable=true)
  208. */
  209. private $allowed_license_levels;
  211. /**
  212. * @var string|null
  213. *
  214. * @ORM\Column(name="prefix", type="string", length=25, nullable=true)
  215. */
  216. private $prefix;
  218. /**
  219. * @var string|null
  220. *
  221. * @ORM\Column(name="legal_entity_name", type="text", nullable=true)
  222. */
  223. private $legal_entity_name = null;
  225. /**
  226. * Sets all service requests for this client not to come up for invoicing.
  227. *
  228. * @var bool
  229. *
  230. * @ORM\Column(name="hide_from_invoicing", type="boolean", options={"default"=false})
  231. */
  232. private $hide_from_invoicing;
  234. /**
  235. * @var string|null
  236. *
  237. * @ORM\Column(name="default_role", type="string", nullable=true)
  238. */
  239. private $default_role;
  241. /**
  242. * Holds the Account's payment terms value (in days) for adjusting
  243. * the due date on invoices automagically.
  244. *
  245. * @var int
  246. *
  247. * @ORM\Column(name="invoice_payment_terms", type="integer", nullable=true)
  248. */
  249. private $invoice_payment_terms;
  251. /**
  252. * @var int|null
  253. *
  254. * @ORM\Column(name="invoice_billing_frequency", type="integer", nullable=true)
  255. */
  256. private $invoice_billing_frequency;
  258. /**
  259. * @var int|null
  260. *
  261. * @ORM\Column(name="invoice_type", type="integer", nullable=true)
  262. */
  263. private $invoice_type;
  265. /**
  266. * The different UserNotifications disabled for this Client
  267. *
  268. * @var array
  269. *
  270. * @ORM\Column(name="disabled_notifications", type="array", nullable=true)
  271. */
  272. private $disabled_notifications = [];
  274. /**
  275. * A default sorting instruction for all the Account's sorting sessions.
  276. * This is visible to the sorter.
  277. *
  278. * @var SortingInstruction
  279. *
  280. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\SortingInstruction", inversedBy="account", cascade={"persist","remove"}, orphanRemoval=true)
  281. *
  282. * @ORM\JoinColumns({
  283. *
  284. * @ORM\JoinColumn(name="defaultSortingInstruction_id", referencedColumnName="id", unique=true)
  285. * })
  286. */
  287. private $defaultSortingInstruction;
  289. /**
  290. * Determines if a draft memo will be exported for the client on Sorting Session completions.
  291. *
  292. * @var bool
  293. *
  294. * @ORM\Column(name="requireMemo", type="boolean", options={"default"=false})
  295. */
  296. private $requireMemo = false;
  298. /**
  299. * Whether to require the user to enter a password on downloading a document or folder
  300. *
  301. * @var bool
  302. *
  303. * @ORM\Column(name="require_password_on_download", type="boolean", options={"default"=false})
  304. */
  305. private $require_password_on_download;
  307. /**
  308. * @var ArrayCollection
  309. *
  310. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\AccountSortingMemoPhrase", mappedBy="account", cascade={"all"})
  311. */
  312. private $accountSortingMemoPhrases;
  314. /**
  315. * @var MatterRequestDefaults
  316. *
  317. * @Groups({"account:read", "matter_request:read"})
  318. *
  319. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\MatterRequestDefaults", mappedBy="account")
  320. */
  321. private $matterRequestDefaults;
  323. /**
  324. * @var ContactableAddress
  325. *
  326. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ContactableAddress", cascade={"all"})
  327. *
  328. * @ORM\JoinColumns({
  329. *
  330. * @ORM\JoinColumn(name="billingAddress_id", referencedColumnName="id", unique=true)
  331. * })
  332. */
  333. private $billingAddress;
  335. /**
  336. * @var ContactableAddress
  337. */
  338. private $accountsAddress;
  340. /**
  341. * @var ContactableAddress
  342. *
  343. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ContactableAddress", cascade={"all"})
  344. *
  345. * @ORM\JoinColumns({
  346. *
  347. * @ORM\JoinColumn(name="physicalAddress_id", referencedColumnName="id", unique=true)
  348. * })
  349. */
  350. private $physicalAddress;
  352. /**
  353. * @var Collection
  354. *
  355. * @ORM\ManyToMany(targetEntity="MedBrief\MSR\Entity\ContactableAddress", inversedBy="accounts", cascade={"persist"})
  356. *
  357. * @ORM\JoinTable(name="account_contactableaddress",
  358. * joinColumns={
  359. *
  360. * @ORM\JoinColumn(name="account_id", referencedColumnName="id", onDelete="CASCADE")
  361. * },
  362. * inverseJoinColumns={
  363. * @ORM\JoinColumn(name="contactableaddress_id", referencedColumnName="id", onDelete="CASCADE")
  364. * }
  365. * )
  366. */
  367. private $offices;
  369. /**
  370. * @var string
  371. *
  372. * @ORM\Column(name="slug", type="string")
  373. *
  374. * @Gedmo\Slug(fields={"name"}, updatable=false, separator="_")
  375. */
  376. private $slug;
  378. /**
  379. * @var \DateTime
  380. *
  381. * @ORM\Column(name="created", type="datetime")
  382. *
  383. * @Gedmo\Timestampable(on="create")
  384. */
  385. private $created;
  387. /**
  388. * @var \DateTime
  389. *
  390. * @ORM\Column(name="updated", type="datetime")
  391. *
  392. * @Gedmo\Timestampable(on="update")
  393. */
  394. private $updated;
  396. /**
  397. * @var Collection
  398. *
  399. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Project", mappedBy="account", cascade={"all"})
  400. */
  401. private $projects;
  403. /**
  404. * @var Collection
  405. */
  406. private $addresses;
  408. /**
  409. * @var \DateTime
  410. *
  411. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
  412. */
  413. private $deletedAt;
  415. /**
  416. * @var string
  417. */
  418. private $image;
  420. /**
  421. * @var string
  422. *
  423. * @ORM\Column(name="image_name", type="string", length=255, nullable=true)
  424. */
  425. private $image_name;
  427. /**
  428. * @var string|null
  429. */
  430. private $companyThumbnail = null;
  432. /**
  433. * @var string|null
  434. *
  435. * @ORM\Column(name="companyThumbnailName", type="string", length=255, nullable=true)
  436. *
  437. */
  438. private $companyThumbnailName = null;
  440. /**
  441. * @var string|null
  442. */
  443. private $companyLetterheadLogo = null;
  445. /**
  446. * @var string|null
  447. *
  448. * @ORM\Column(name="companyLetterheadLogoName", type="string", length=255, nullable=true)
  449. *
  450. */
  451. private $companyLetterheadLogoName = null;
  453. /**
  454. * Determines if an account can create/update batch requests and sort sessions.
  455. *
  456. * @var bool
  457. *
  458. * @ORM\Column(name="canCreateBatchAndSort", type="boolean", options={"default"=false})
  459. */
  460. private $canCreateBatchAndSort = false;
  462. /**
  463. * Determines if an account is able to use match.
  464. *
  465. * @var string|null
  466. *
  467. * @ORM\Column(name="matchOptIn", type="string", length=50, nullable=true)
  468. */
  469. private ?string $matchOptIn = null;
  471. /**
  472. * Determines the default value of the same field on a Project/Matter, when a new Project is created.
  473. *
  474. * @var bool
  475. *
  476. * @ORM\Column(name="allowExpertViewUnsortedRecords", type="boolean", options={"default"=false})
  477. */
  478. private $allowExpertViewUnsortedRecords = false;
  480. /**
  481. * Determines if the questions presented during the Matter Closure Wizard are optional.
  482. *
  483. * @var bool
  484. *
  485. * @ORM\Column(name="matterClosureQuestionsOptional", type="boolean", options={"default"=false})
  486. */
  487. private $matterClosureQuestionsOptional = false;
  489. /**
  490. * @var bool
  491. *
  492. * @ORM\Column(name="useParentClinicalSectionsOnly", type="boolean")
  493. */
  494. private $useParentClinicalSectionsOnly = false;
  496. /**
  497. * @ORM\ManyToOne(targetEntity=Firm::class, inversedBy="clientAreas")
  498. */
  499. private $firm;
  501. /**
  502. * @Groups({"account:read", "matter_request:read"})
  503. *
  504. * @ORM\Column(name="allowedMatterTypes", type="array", nullable=true)
  505. *
  506. * @Assert\Count(
  507. * min=1,
  508. * minMessage = "Please select an option.",
  509. * groups={"account:read", "matter_request:read"}
  510. * )
  511. */
  512. private array $allowedMatterTypes = [];
  514. /**
  515. * @ORM\OneToMany(targetEntity=LicenceRenewalTerm::class, mappedBy="account", orphanRemoval=true)
  516. *
  517. * @ORM\OrderBy({"effectiveDate" = "ASC"})
  518. *
  519. * When a new period is added, a new related service option for the same period should also be created and mapped.
  520. */
  521. private ?Collection $licenceRenewalTerms;
  523. /**
  524. * Sets whether any client level users, or users invited to the client's
  525. * matters should require 2FA to be enabled.
  526. *
  527. * @ORM\Column(type="boolean", options={"default"=false})
  528. */
  529. private bool $enforceTwoFactorAuth = false;
  531. /**
  532. * If enabled, allows the users that are forced to enabled 2FA via the
  533. * enforceTwoFactorAuth property to skip the requirement for the first
  534. * two (2) logins.
  535. *
  536. * @ORM\Column(type="boolean", options={"default"=false})
  537. */
  538. private bool $allowTwoFactorAuthGracePeriod = false;
  540. /**
  541. * If enabled, the account (client) is not liable for the disclosure fee,
  542. * the Recipient Firm is liable.
  543. *
  544. * @ORM\Column(type="boolean", options={"default"=false})
  545. */
  546. private bool $clientNotLiableForDisclosureFee = false;
  548. /**
  549. * @var string|null
  550. *
  551. * @ORM\Column(name="trading_name", type="text", nullable=true)
  552. */
  553. private $trading_name = null;
  555. /**
  556. * @var string|null
  557. *
  558. * @ORM\Column(name="company_registration_number", type="string", length=255, nullable=true)
  559. */
  560. private $company_registration_number = null;
  562. /**
  563. * @var string|null
  564. *
  565. * @ORM\Column(name="country_of_registration", type="string", length=255, nullable=true)
  566. */
  567. private $country_of_registration = null;
  569. /**
  570. * Constructor
  571. */
  572. public function __construct()
  573. {
  574. $this->domains = new ArrayCollection();
  575. $this->allowed_license_levels = [];
  576. $this->hide_from_invoicing = false;
  577. $this->require_password_on_download = false;
  578. $this->accountSortingMemoPhrases = new ArrayCollection();
  579. $this->matterCreationProcess = self::MATTER_CREATION_PROCESS_CLASSIC;
  580. $this->projects = new ArrayCollection();
  581. $this->offices = new ArrayCollection();
  582. $this->licenceRenewalTerms = new ArrayCollection();
  583. }
  585. public function __toString()
  586. {
  587. return $this->getName();
  588. }
  590. /**
  591. * Get id
  592. *
  593. * @return int
  594. */
  595. public function getId()
  596. {
  597. return $this->id;
  598. }
  600. /**
  601. * Set name
  602. *
  603. * @param string $name
  604. *
  605. * @return Account
  606. */
  607. public function setName($name)
  608. {
  609. $this->name = $name;
  611. return $this;
  612. }
  614. /**
  615. * Get name
  616. *
  617. * @return string
  618. */
  619. public function getName()
  620. {
  621. return $this->name;
  622. }
  624. /**
  625. * Add domains
  626. *
  627. * @param Domain $domains
  628. *
  629. * @return Account
  630. */
  631. public function addDomain(Domain $domains)
  632. {
  633. $this->domains[] = $domains;
  635. return $this;
  636. }
  638. /**
  639. * Remove domains
  640. *
  641. * @param Domain $domains
  642. */
  643. public function removeDomain(Domain $domains)
  644. {
  645. $this->domains->removeElement($domains);
  646. }
  648. /**
  649. * Get domains
  650. *
  651. * @return Collection
  652. */
  653. public function getDomains()
  654. {
  655. return $this->domains;
  656. }
  658. /**
  659. * Set slug
  660. *
  661. * @param string $slug
  662. *
  663. * @return Account
  664. */
  665. public function setSlug($slug)
  666. {
  667. $this->slug = $slug;
  669. return $this;
  670. }
  672. /**
  673. * Get slug
  674. *
  675. * @return string
  676. */
  677. public function getSlug()
  678. {
  679. return $this->slug;
  680. }
  682. /**
  683. * Set created
  684. *
  685. * @param \DateTime $created
  686. *
  687. * @return Account
  688. */
  689. public function setCreated($created)
  690. {
  691. $this->created = $created;
  693. return $this;
  694. }
  696. /**
  697. * Get created
  698. *
  699. * @return \DateTime
  700. */
  701. public function getCreated()
  702. {
  703. return $this->created;
  704. }
  706. /**
  707. * Set updated
  708. *
  709. * @param \DateTime $updated
  710. *
  711. * @return Account
  712. */
  713. public function setUpdated($updated)
  714. {
  715. $this->updated = $updated;
  717. return $this;
  718. }
  720. /**
  721. * Get updated
  722. *
  723. * @return \DateTime
  724. */
  725. public function getUpdated()
  726. {
  727. return $this->updated;
  728. }
  730. /**
  731. * Add projects
  732. *
  733. * @param Project $projects
  734. *
  735. * @return Account
  736. */
  737. public function addProject(Project $projects)
  738. {
  739. $this->projects[] = $projects;
  741. return $this;
  742. }
  744. /**
  745. * Remove projects
  746. *
  747. * @param Project $projects
  748. */
  749. public function removeProject(Project $projects)
  750. {
  751. $this->projects->removeElement($projects);
  752. }
  754. /**
  755. * Get projects
  756. *
  757. * @return Collection
  758. */
  759. public function getProjects()
  760. {
  761. return $this->projects;
  762. }
  764. public function getArchivedProjects()
  765. {
  766. $criteria = Criteria::create()
  767. ->where(Criteria::expr()->gt('archive_status', 0))
  768. ->orderBy(['name' => Criteria::ASC])
  769. ;
  771. return $this->getProjects()->matching($criteria);
  772. }
  774. public function getActiveProjects()
  775. {
  776. $criteria = Criteria::create()
  777. ->where(Criteria::expr()->eq('status', Project::STATUS_ACTIVE))
  778. ->orderBy(['name' => Criteria::ASC])
  779. ;
  781. return $this->getProjects()->matching($criteria);
  782. }
  784. public function getInactiveProjects()
  785. {
  786. $criteria = Criteria::create()
  787. ->where(Criteria::expr()->eq('status', Project::STATUS_INACTIVE))
  788. ->orderBy(['name' => Criteria::ASC])
  789. ;
  791. return $this->getProjects()->matching($criteria);
  792. }
  794. /**
  795. * Set invoice_billing_frequency
  796. *
  797. * @param string $invoiceBillingFrequency
  798. *
  799. * @return Account
  800. */
  801. public function setInvoiceBillingFrequency($invoiceBillingFrequency)
  802. {
  803. $this->invoice_billing_frequency = $invoiceBillingFrequency;
  805. return $this;
  806. }
  808. /**
  809. * Get invoice_billing_frequency
  810. *
  811. * @return string
  812. */
  813. public function getInvoiceBillingFrequency()
  814. {
  815. return $this->invoice_billing_frequency;
  816. }
  818. /**
  819. * Set invoice_type
  820. *
  821. * @param string $invoiceType
  822. *
  823. * @return Account
  824. */
  825. public function setInvoiceType($invoiceType)
  826. {
  827. $this->invoice_type = $invoiceType;
  829. return $this;
  830. }
  832. /**
  833. * Get invoice_type
  834. *
  835. * @return string
  836. */
  837. public function getInvoiceType()
  838. {
  839. return $this->invoice_type;
  840. }
  842. /**
  843. * Set billingAddress
  844. *
  845. * @param ContactableAddress $billingAddress
  846. *
  847. * @return Account
  848. */
  849. public function setBillingAddress(?ContactableAddress $billingAddress = null)
  850. {
  851. $this->billingAddress = $billingAddress;
  853. return $this;
  854. }
  856. /**
  857. * Get billingAddress
  858. *
  859. * @return ContactableAddress
  860. */
  861. public function getBillingAddress()
  862. {
  863. return $this->billingAddress;
  864. }
  866. /**
  867. * Set accountsAddress
  868. *
  869. * @param ContactableAddress $accountsAddress
  870. *
  871. * @return Account
  872. */
  873. public function setAccountsAddress(?ContactableAddress $accountsAddress = null)
  874. {
  875. $this->accountsAddress = $accountsAddress;
  877. return $this;
  878. }
  880. /**
  881. * Get accountsAddress
  882. *
  883. * @return ContactableAddress
  884. */
  885. public function getAccountsAddress()
  886. {
  887. return $this->accountsAddress;
  888. }
  890. /**
  891. * Set physicalAddress
  892. *
  893. * @param ContactableAddress $physicalAddress
  894. *
  895. * @return Account
  896. */
  897. public function setPhysicalAddress(?ContactableAddress $physicalAddress = null)
  898. {
  899. $this->physicalAddress = $physicalAddress;
  901. return $this;
  902. }
  904. /**
  905. * Get physicalAddress
  906. *
  907. * @return ContactableAddress
  908. */
  909. public function getPhysicalAddress()
  910. {
  911. return $this->physicalAddress;
  912. }
  914. /**
  915. * Add offices
  916. *
  917. * @param ContactableAddress $offices
  918. *
  919. * @return Account
  920. */
  921. public function addOffice(ContactableAddress $offices)
  922. {
  923. $this->offices[] = $offices;
  925. return $this;
  926. }
  928. /**
  929. * Remove offices
  930. *
  931. * @param ContactableAddress $offices
  932. */
  933. public function removeOffice(ContactableAddress $offices)
  934. {
  935. $this->offices->removeElement($offices);
  936. }
  938. /**
  939. * Get offices
  940. *
  941. * @return Collection
  942. */
  943. public function getOffices()
  944. {
  945. return $this->offices;
  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 getInvoiceBillingFrequencyOptions()
  955. {
  956. return [
  957. self::INVOICE_BILLING_FREQUENCY_MONTHLY => 'Monthly',
  958. self::INVOICE_BILLING_FREQUENCY_QUARTERLY => 'Quarterly',
  959. self::INVOICE_BILLING_FREQUENCY_START_OF_MATTER => 'At the start of the matter',
  960. ];
  961. }
  963. /**
  964. * Returns a human readable version of the invoice billing frequency
  965. *
  966. * @return string
  967. */
  968. public function getInvoiceBillingFrequencyName()
  969. {
  970. $options = self::getInvoiceBillingFrequencyOptions();
  972. return
  973. $options[$this->getInvoiceBillingFrequency()] ?? $this->getInvoiceBillingFrequency();
  974. }
  976. /**
  977. * Returns an array of permitted values for the invoice billing frequency field and their
  978. * associated labels,
  979. *
  980. * @return array
  981. */
  982. public static function getInvoiceTypeOptions()
  983. {
  984. return [
  985. self::INVOICE_TYPE_CONSOLIDATED => 'Consolidated',
  986. self::INVOICE_TYPE_INDIVIDUAL_MATTER => 'Individual Matter',
  987. ];
  988. }
  990. /**
  991. * Returns a human readable version of the invoice billing frequency
  992. *
  993. * @return string
  994. */
  995. public function getInvoiceTypeName()
  996. {
  997. $options = self::getInvoiceTypeOptions();
  999. return
  1000. $options[$this->getInvoiceType()] ?? $this->getInvoiceType();
  1001. }
  1003. /**
  1004. * Set deletedAt
  1005. *
  1006. * @param \DateTime $deletedAt
  1007. *
  1008. * @return Account
  1009. */
  1010. public function setDeletedAt($deletedAt)
  1011. {
  1012. $this->deletedAt = $deletedAt;
  1014. return $this;
  1015. }
  1017. /**
  1018. * Get deletedAt
  1019. *
  1020. * @return \DateTime
  1021. */
  1022. public function getDeletedAt()
  1023. {
  1024. return $this->deletedAt;
  1025. }
  1027. /**
  1028. * Set image
  1029. *
  1030. * @param string $image
  1031. *
  1032. * @return Account
  1033. */
  1034. public function setImage($image)
  1035. {
  1036. if (null !== $image) {
  1037. // It is required that at least one field changes if you are using doctrine
  1038. // otherwise the event listeners won't be called and the file is lost
  1039. $this->updated = new \DateTimeImmutable();
  1040. }
  1042. $this->image = $image;
  1044. return $this;
  1045. }
  1047. /**
  1048. * Indicates whether or not this user has an image
  1049. *
  1050. * @return bool
  1051. */
  1052. public function hasImage()
  1053. {
  1054. // note that we use the imageName field because the image field will be
  1055. // populated with the gaufrette file location immediately on upload
  1056. // even if the upload fails. So if you call this function on the user
  1057. // before it is peristed it may give you a false positive.
  1058. $image = $this->getImageName();
  1060. return !empty($image);
  1061. }
  1063. /**
  1064. * Get image
  1065. *
  1066. * @return string
  1067. */
  1068. public function getImage()
  1069. {
  1070. return $this->image;
  1071. }
  1073. /**
  1074. * Set image_name
  1075. *
  1076. * @param string $imageName
  1077. *
  1078. * @return Account
  1079. */
  1080. public function setImageName($imageName)
  1081. {
  1082. $this->image_name = $imageName;
  1084. return $this;
  1085. }
  1087. /**
  1088. * Get image_name
  1089. *
  1090. * @return string
  1091. */
  1092. public function getImageName()
  1093. {
  1094. return $this->image_name;
  1095. }
  1097. /**
  1098. * Set companyThumbnail
  1099. *
  1100. * @param string $companyThumbnail
  1101. *
  1102. * @return Account
  1103. */
  1104. public function setCompanyThumbnail($companyThumbnail)
  1105. {
  1107. if (null !== $companyThumbnail) {
  1108. // It is required that at least one field changes if you are using doctrine
  1109. // otherwise the event listeners won't be called and the file is lost
  1110. $this->updated = new \DateTimeImmutable();
  1111. }
  1113. $this->companyThumbnail = $companyThumbnail;
  1115. return $this;
  1116. }
  1118. /**
  1119. * Get companyThumbnail
  1120. *
  1121. * @return string
  1122. */
  1123. public function getCompanyThumbnail()
  1124. {
  1125. return $this->companyThumbnail;
  1126. }
  1128. /**
  1129. * Indicates whether or not this account has a company thumbnail
  1130. *
  1131. * @return bool
  1132. */
  1133. public function hasCompanyThumbnail()
  1134. {
  1135. // note that we use the companyThumbnailName field because the companyThumbnail field will be
  1136. // populated with the gaufrette file location immediately on upload
  1137. // even if the upload fails. So if you call this function on the user
  1138. // before it is persisted it may give you a false positive.
  1139. $companyThumbnail = $this->getCompanyThumbnailName();
  1141. return !empty($companyThumbnail);
  1142. }
  1144. /**
  1145. * Set companyThumbnailName
  1146. *
  1147. * @param string $companyThumbnailName
  1148. *
  1149. * @return Account
  1150. */
  1151. public function setCompanyThumbnailName($companyThumbnailName)
  1152. {
  1153. $this->companyThumbnailName = $companyThumbnailName;
  1155. return $this;
  1156. }
  1158. /**
  1159. * Get companyThumbnailName
  1160. *
  1161. * @return string
  1162. */
  1163. public function getCompanyThumbnailName()
  1164. {
  1165. return $this->companyThumbnailName;
  1166. }
  1169. /**
  1170. * Set companyLetterheadLogo
  1171. *
  1172. * @param string $companyLetterheadLogo
  1173. *
  1174. * @return Account
  1175. */
  1176. public function setCompanyLetterheadLogo($companyLetterheadLogo)
  1177. {
  1179. if (null !== $companyLetterheadLogo) {
  1180. // It is required that at least one field changes if you are using doctrine
  1181. // otherwise the event listeners won't be called and the file is lost
  1182. $this->updated = new \DateTimeImmutable();
  1183. }
  1185. $this->companyLetterheadLogo = $companyLetterheadLogo;
  1187. return $this;
  1188. }
  1190. /**
  1191. * Get companyLetterheadLogo
  1192. *
  1193. * @return string
  1194. */
  1195. public function getCompanyLetterheadLogo()
  1196. {
  1197. return $this->companyLetterheadLogo;
  1198. }
  1200. /**
  1201. * Indicates whether or not this account has a company letterhead logo
  1202. *
  1203. * @return bool
  1204. */
  1205. public function hasCompanyLetterheadLogo()
  1206. {
  1207. // note that we use the companyLetterheadLogoName field because the companyLetterheadLogo field will be
  1208. // populated with the gaufrette file location immediately on upload
  1209. // even if the upload fails. So if you call this function on the user
  1210. // before it is persisted it may give you a false positive.
  1211. $companyLetterheadLogo = $this->getCompanyLetterheadLogoName();
  1213. return !empty($companyLetterheadLogo);
  1214. }
  1216. /**
  1217. * Set companyLetterheadLogoName
  1218. *
  1219. * @param string $companyLetterheadLogoName
  1220. *
  1221. * @return Account
  1222. */
  1223. public function setCompanyLetterheadLogoName($companyLetterheadLogoName)
  1224. {
  1225. $this->companyLetterheadLogoName = $companyLetterheadLogoName;
  1227. return $this;
  1228. }
  1230. /**
  1231. * Get companyLetterheadLogoName
  1232. *
  1233. * @return string
  1234. */
  1235. public function getCompanyLetterheadLogoName()
  1236. {
  1237. return $this->companyLetterheadLogoName;
  1238. }
  1240. /**
  1241. * Set allowedLicenseLevels
  1242. *
  1243. * @param array $allowedLicenseLevels
  1244. *
  1245. * @return Account
  1246. */
  1247. public function setAllowedLicenseLevels($allowedLicenseLevels)
  1248. {
  1249. $this->allowed_license_levels = $allowedLicenseLevels;
  1251. return $this;
  1252. }
  1254. /**
  1255. * Get allowedLicenseLevels
  1256. *
  1257. * @return array
  1258. */
  1259. public function getAllowedLicenseLevels()
  1260. {
  1261. if ($this->allowed_license_levels === null) {
  1262. return [];
  1263. }
  1265. return $this->allowed_license_levels;
  1266. }
  1268. /**
  1269. * Set prefix
  1270. *
  1271. * @param string $prefix
  1272. *
  1273. * @return Account
  1274. */
  1275. public function setPrefix($prefix)
  1276. {
  1277. $this->prefix = strtoupper($prefix);
  1279. return $this;
  1280. }
  1282. /**
  1283. * Get prefix
  1284. *
  1285. * @return string
  1286. */
  1287. public function getPrefix()
  1288. {
  1289. return strtoupper($this->prefix);
  1290. }
  1292. /**
  1293. * Set legalEntityName
  1294. *
  1295. * @param string $legalEntityName
  1296. *
  1297. * @return Account
  1298. */
  1299. public function setLegalEntityName($legalEntityName)
  1300. {
  1301. $this->legal_entity_name = $legalEntityName;
  1303. return $this;
  1304. }
  1306. /**
  1307. * Get legalEntityName
  1308. *
  1309. * @return string
  1310. */
  1311. public function getLegalEntityName()
  1312. {
  1313. return $this->legal_entity_name;
  1314. }
  1316. /**
  1317. * Set defaultRole
  1318. *
  1319. * @param string $defaultRole
  1320. *
  1321. * @return Account
  1322. */
  1323. public function setDefaultRole($defaultRole)
  1324. {
  1325. $this->default_role = $defaultRole;
  1327. return $this;
  1328. }
  1330. /**
  1331. * Get defaultRole
  1332. *
  1333. * @return string
  1334. */
  1335. public function getDefaultRole()
  1336. {
  1337. return $this->default_role;
  1338. }
  1340. /**
  1341. * Get defaultRoleOptions
  1342. *
  1343. * @return array
  1344. */
  1345. public static function getDefaultRoleOptions()
  1346. {
  1347. return [
  1348. self::DEFAULT_ROLE_ADMINISTRATOR => 'Client Administrator',
  1349. self::DEFAULT_ROLE_SUPERADMINISTRATOR => 'Client Super Administrator',
  1350. self::DEFAULT_ROLE_PROJECTMANAGER => 'Client Project Manager',
  1351. self::DEFAULT_ROLE_SORTER => 'Sorter',
  1352. ];
  1353. }
  1355. /**
  1356. * Get DefaultRoleLabel
  1357. *
  1358. * @return string
  1359. */
  1360. public function getDefaultRoleLabel()
  1361. {
  1362. $options = self::getDefaultRoleOptions();
  1363. return $options[$this->getDefaultRole()] ?? '';
  1364. }
  1366. /**
  1367. * Get DefaultRoleLabel
  1368. *
  1369. * @return string
  1370. */
  1371. public function getDefaultRoleAsRole()
  1372. {
  1373. if (!$this->getDefaultRole()) {
  1374. return '';
  1375. }
  1377. return 'ROLE_ACCOUNT_' . $this->getId() . '_' . $this->getDefaultRole();
  1378. }
  1380. /**
  1381. * Set hideFromInvoicing
  1382. *
  1383. * @param bool $hideFromInvoicing
  1384. *
  1385. * @return Account
  1386. */
  1387. public function setHideFromInvoicing($hideFromInvoicing)
  1388. {
  1389. $this->hide_from_invoicing = $hideFromInvoicing;
  1391. return $this;
  1392. }
  1394. /**
  1395. * Get hideFromInvoicing
  1396. *
  1397. * @return bool
  1398. */
  1399. public function getHideFromInvoicing()
  1400. {
  1401. return $this->hide_from_invoicing;
  1402. }
  1404. /**
  1405. * Set invoicePaymentTerms
  1406. *
  1407. * @param int $invoicePaymentTerms
  1408. *
  1409. * @return Account
  1410. */
  1411. public function setInvoicePaymentTerms($invoicePaymentTerms)
  1412. {
  1413. $this->invoice_payment_terms = $invoicePaymentTerms;
  1415. return $this;
  1416. }
  1418. /**
  1419. * Get invoicePaymentTerms
  1420. *
  1421. * @return int
  1422. */
  1423. public function getInvoicePaymentTerms()
  1424. {
  1425. return $this->invoice_payment_terms;
  1426. }
  1428. /**
  1429. * Get the disabled UserNotification types
  1430. *
  1431. * @return array
  1432. */
  1433. public function getDisabledNotifications(): array
  1434. {
  1435. return $this->disabled_notifications ?: [];
  1436. }
  1438. /**
  1439. * @param array $disabled_notifications
  1440. *
  1441. * @return Account
  1442. */
  1443. public function setDisabledNotifications(array $disabled_notifications): Account
  1444. {
  1445. $this->disabled_notifications = $disabled_notifications;
  1447. return $this;
  1448. }
  1450. /**
  1451. * Disable a notification
  1452. *
  1453. * @param $notification_type
  1454. *
  1455. * @return Account
  1456. */
  1457. public function disableNotification($notification_type)
  1458. {
  1459. if (!$this->disabled_notifications) {
  1460. $this->disabled_notifications = [];
  1461. }
  1463. array_push($this->disabled_notifications, $notification_type);
  1465. return $this;
  1466. }
  1468. /**
  1469. * Function to determine if the specific UserNotification is disabled for this Entity
  1470. *
  1471. * @param $notification_type
  1472. *
  1473. * @return bool
  1474. */
  1475. public function isNotificationDisabled($notification_type)
  1476. {
  1477. if (!$this->disabled_notifications) {
  1478. $this->disabled_notifications = [];
  1479. return false;
  1480. }
  1481. return in_array($notification_type, $this->disabled_notifications) ? true : false;
  1482. }
  1484. /**
  1485. * Set defaultSortingInstruction.
  1486. *
  1487. * @param SortingInstruction|null $defaultSortingInstruction
  1488. *
  1489. * @return Account
  1490. */
  1491. public function setDefaultSortingInstruction(?SortingInstruction $defaultSortingInstruction = null)
  1492. {
  1493. $this->defaultSortingInstruction = $defaultSortingInstruction;
  1495. return $this;
  1496. }
  1498. /**
  1499. * Get defaultSortingInstruction.
  1500. *
  1501. * @return SortingInstruction|null
  1502. */
  1503. public function getDefaultSortingInstruction()
  1504. {
  1505. return $this->defaultSortingInstruction;
  1506. }
  1508. /**
  1509. * Set requireMemo.
  1510. *
  1511. * @param bool $requireMemo
  1512. *
  1513. * @return Account
  1514. */
  1515. public function setRequireMemo($requireMemo)
  1516. {
  1517. $this->requireMemo = $requireMemo;
  1519. return $this;
  1520. }
  1522. /**
  1523. * Get requireMemo.
  1524. *
  1525. * @return bool
  1526. */
  1527. public function getRequireMemo()
  1528. {
  1529. return $this->requireMemo;
  1530. }
  1532. /**
  1533. * Set requirePasswordOnDownload.
  1534. *
  1535. * @param bool $requirePasswordOnDownload
  1536. *
  1537. * @return Account
  1538. */
  1539. public function setRequirePasswordOnDownload($requirePasswordOnDownload)
  1540. {
  1541. $this->require_password_on_download = $requirePasswordOnDownload;
  1543. return $this;
  1544. }
  1546. /**
  1547. * Get requirePasswordOnDownload.
  1548. *
  1549. * @return bool
  1550. */
  1551. public function getRequirePasswordOnDownload()
  1552. {
  1553. return $this->require_password_on_download;
  1554. }
  1556. /**
  1557. * Add accountSortingMemoPhrase.
  1558. *
  1559. * @param AccountSortingMemoPhrase $accountSortingMemoPhrase
  1560. *
  1561. * @return Account
  1562. */
  1563. public function addAccountSortingMemoPhrase(AccountSortingMemoPhrase $accountSortingMemoPhrase)
  1564. {
  1565. $this->accountSortingMemoPhrases[] = $accountSortingMemoPhrase;
  1567. return $this;
  1568. }
  1570. /**
  1571. * Remove accountSortingMemoPhrase.
  1572. *
  1573. * @param AccountSortingMemoPhrase $accountSortingMemoPhrase
  1574. *
  1575. * @return bool TRUE if this collection contained the specified element, FALSE otherwise.
  1576. */
  1577. public function removeAccountSortingMemoPhrase(AccountSortingMemoPhrase $accountSortingMemoPhrase)
  1578. {
  1579. return $this->accountSortingMemoPhrases->removeElement($accountSortingMemoPhrase);
  1580. }
  1582. /**
  1583. * Get accountSortingMemoPhrases.
  1584. *
  1585. * @return Collection
  1586. */
  1587. public function getAccountSortingMemoPhrases()
  1588. {
  1589. return $this->accountSortingMemoPhrases;
  1590. }
  1592. /**
  1593. * Set matterRequestDefaults.
  1594. *
  1595. * @param MatterRequestDefaults|null $matterRequestDefaults
  1596. *
  1597. * @return Account
  1598. */
  1599. public function setMatterRequestDefaults(?MatterRequestDefaults $matterRequestDefaults = null)
  1600. {
  1601. $this->matterRequestDefaults = $matterRequestDefaults;
  1603. return $this;
  1604. }
  1606. /**
  1607. * Get matterRequestDefaults.
  1608. *
  1609. * @return MatterRequestDefaults|null
  1610. */
  1611. public function getMatterRequestDefaults()
  1612. {
  1613. return $this->matterRequestDefaults;
  1614. }
  1616. /**
  1617. * Returns the return details address.
  1618. *
  1619. * @return ContactableAddress|null
  1620. */
  1621. public function getReturnDetailsAddress(): ?ContactableAddress
  1622. {
  1623. if ($this->getOffices() && $this->getOffices()->first()) {
  1624. return $this->getOffices()->first();
  1625. }
  1626. return null;
  1627. }
  1629. /**
  1630. * Set matterCreationProcess.
  1631. *
  1632. * @param string|null $matterCreationProcess
  1633. *
  1634. * @return Account
  1635. */
  1636. public function setMatterCreationProcess($matterCreationProcess = null): Account
  1637. {
  1638. $this->matterCreationProcess = $matterCreationProcess;
  1640. return $this;
  1641. }
  1643. /**
  1644. * Set customIndexHeader.
  1645. *
  1646. * @param string|null $customIndexHeader
  1647. *
  1648. * @return Account
  1649. */
  1650. public function setCustomIndexHeader($customIndexHeader = null)
  1651. {
  1652. $this->custom_index_header = $customIndexHeader;
  1654. return $this;
  1655. }
  1657. /**
  1658. * Get customIndexHeader.
  1659. *
  1660. * @return string|null
  1661. */
  1662. public function getCustomIndexHeader()
  1663. {
  1664. return $this->custom_index_header;
  1665. }
  1667. /**
  1668. * Get matterCreationProcess.
  1669. *
  1670. * @return string|null
  1671. */
  1672. public function getMatterCreationProcess(): ?string
  1673. {
  1674. return $this->matterCreationProcess;
  1675. }
  1677. /**
  1678. * Returns true if the client has access to classic matter creation.
  1679. *
  1680. * @return bool
  1681. */
  1682. public function hasAccessToClassicMatterCreation(): bool
  1683. {
  1684. return $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_CLASSIC || $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_ALL || $this->matterCreationProcess === null;
  1685. }
  1687. /**
  1688. * Returns true if the client has access to standard matter creation.
  1689. *
  1690. * @return bool
  1691. */
  1692. public function hasAccessToStandardMatterCreation(): bool
  1693. {
  1694. return $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_STANDARD || $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_ALL;
  1695. }
  1697. /**
  1698. * Returns matter creations options as an array, usable as the choices for a form.
  1699. *
  1700. * @return array
  1701. */
  1702. public static function getMatterCreationProcessOptions(): array
  1703. {
  1704. $matterCreationProcessOptions = self::getConstantsWithLabelsAsChoices('MATTER_CREATION_PROCESS');
  1706. return array_flip($matterCreationProcessOptions);
  1707. }
  1709. /**
  1710. * Returns a human readable version of matterCreationProcess.
  1711. *
  1712. * @return string
  1713. */
  1714. public function getMatterCreationProcessName()
  1715. {
  1716. $options = self::getMatterCreationProcessOptions();
  1718. return $options[$this->getMatterCreationProcess()] ?? $this->getMatterCreationProcess();
  1719. }
  1721. /**
  1722. * Get the value of standardIndexHeader
  1723. *
  1724. * @return string|null
  1725. */
  1726. public function getStandardIndexHeader()
  1727. {
  1728. return $this->standardIndexHeader;
  1729. }
  1731. /**
  1732. * Set the value of standardIndexHeader
  1733. *
  1734. * @param string|null $standardIndexHeader
  1735. *
  1736. * @return self
  1737. */
  1738. public function setStandardIndexHeader($standardIndexHeader)
  1739. {
  1740. $this->standardIndexHeader = $standardIndexHeader;
  1742. return $this;
  1743. }
  1745. /**
  1746. * Set canCreateBatchAndSort.
  1747. *
  1748. * @param bool $canCreateBatchAndSort
  1749. *
  1750. * @return Account
  1751. */
  1752. public function setCanCreateBatchAndSort($canCreateBatchAndSort)
  1753. {
  1754. $this->canCreateBatchAndSort = $canCreateBatchAndSort;
  1756. return $this;
  1757. }
  1759. /**
  1760. * Get canCreateBatchAndSort.
  1761. *
  1762. * @return bool
  1763. */
  1764. public function getCanCreateBatchAndSort()
  1765. {
  1766. return $this->canCreateBatchAndSort;
  1767. }
  1769. /**
  1770. * Set matchOptIn.
  1771. *
  1772. * @param string|null $matchOptIn
  1773. *
  1774. * @return Account
  1775. */
  1776. public function setMatchOptIn(?string $matchOptIn): self
  1777. {
  1778. $this->matchOptIn = $matchOptIn;
  1780. return $this;
  1781. }
  1783. /**
  1784. * Get matchOptIn.
  1785. *
  1786. * @return string|null
  1787. */
  1788. public function getMatchOptIn(): ?string
  1789. {
  1790. return $this->matchOptIn;
  1791. }
  1793. /**
  1794. * Check if match is enabled for this account.
  1795. *
  1796. * @return bool
  1797. */
  1798. public function isMatchEnabled(): bool
  1799. {
  1800. $allowedArray = [
  1801. self::MATCH_OPT_IN_ALL_CLIENT_USERS,
  1802. self::MATCH_OPT_IN_SPECIFIC_USERS,
  1803. ];
  1805. return in_array($this->getMatchOptIn(), $allowedArray);
  1806. }
  1808. /**
  1809. * Check if match opt-in is set to all client users.
  1810. *
  1811. * @return bool
  1812. */
  1813. public function isMatchOptInAllClientUsers(): bool
  1814. {
  1815. return $this->matchOptIn === self::MATCH_OPT_IN_ALL_CLIENT_USERS;
  1816. }
  1818. /**
  1819. * Check if match opt-in is set to specific users.
  1820. *
  1821. * @return bool
  1822. */
  1823. public function isMatchOptInSpecificUsers(): bool
  1824. {
  1825. return $this->matchOptIn === self::MATCH_OPT_IN_SPECIFIC_USERS;
  1826. }
  1828. /**
  1829. * getAllowExpertViewUnsortedRecords
  1830. *
  1831. * @return bool
  1832. */
  1833. public function getAllowExpertViewUnsortedRecords(): bool
  1834. {
  1835. return $this->allowExpertViewUnsortedRecords;
  1836. }
  1838. /**
  1839. * @param bool $allowExpertViewUnsortedRecords
  1840. *
  1841. * @return self
  1842. */
  1843. public function setAllowExpertViewUnsortedRecords(bool $allowExpertViewUnsortedRecords): self
  1844. {
  1845. $this->allowExpertViewUnsortedRecords = $allowExpertViewUnsortedRecords;
  1847. return $this;
  1848. }
  1850. /**
  1851. * @return bool
  1852. */
  1853. public function getMatterClosureQuestionsOptional(): bool
  1854. {
  1855. return $this->matterClosureQuestionsOptional;
  1856. }
  1858. /**
  1859. * @param bool $matterClosureQuestionsOptional
  1860. *
  1861. * @return Account
  1862. */
  1863. public function setMatterClosureQuestionsOptional(bool $matterClosureQuestionsOptional): self
  1864. {
  1865. $this->matterClosureQuestionsOptional = $matterClosureQuestionsOptional;
  1867. return $this;
  1868. }
  1870. /**
  1871. * @return bool|null
  1872. *
  1873. */
  1874. public function getUseParentClinicalSectionsOnly(): ?bool
  1875. {
  1876. return $this->useParentClinicalSectionsOnly;
  1877. }
  1879. /**
  1880. * @param bool $useParentClinicalSectionsOnly
  1881. *
  1882. * @return self
  1883. *
  1884. */
  1885. public function setUseParentClinicalSectionsOnly(bool $useParentClinicalSectionsOnly): self
  1886. {
  1887. $this->useParentClinicalSectionsOnly = $useParentClinicalSectionsOnly;
  1889. return $this;
  1890. }
  1892. public function getFirm(): ?Firm
  1893. {
  1894. return $this->firm;
  1895. }
  1897. public function setFirm(?Firm $firm): self
  1898. {
  1899. $this->firm = $firm;
  1901. return $this;
  1902. }
  1904. /**
  1905. * @return bool
  1906. */
  1907. public function getHideLogoFromIndex(): bool
  1908. {
  1909. return $this->hideLogoFromIndex;
  1910. }
  1912. /**
  1913. * @param bool $hideLogoFromIndex
  1914. *
  1915. * @return self
  1916. */
  1917. public function setHideLogoFromIndex(bool $hideLogoFromIndex): self
  1918. {
  1919. $this->hideLogoFromIndex = $hideLogoFromIndex;
  1921. return $this;
  1922. }
  1924. /**
  1925. * @return array|null
  1926. *
  1927. */
  1928. public function getAllowedMatterTypes(): ?array
  1929. {
  1930. return $this->allowedMatterTypes;
  1931. }
  1933. /**
  1934. * @param array|null $allowedMatterTypes
  1935. *
  1936. * @return self
  1937. *
  1938. */
  1939. public function setAllowedMatterTypes(?array $allowedMatterTypes): self
  1940. {
  1941. $this->allowedMatterTypes = $allowedMatterTypes;
  1943. return $this;
  1944. }
  1946. /**
  1947. * @return array
  1948. */
  1949. public static function getAllowedMatterTypeOptions(): array
  1950. {
  1951. return self::getConstantsWithLabelsAsChoices('MATTER_TYPE');
  1952. }
  1954. /**
  1955. * @return Collection<int, LicenceRenewalTerm>
  1956. */
  1957. public function getLicenceRenewalTerms(): Collection
  1958. {
  1959. return $this->licenceRenewalTerms;
  1960. }
  1962. /**
  1963. * @return Collection<int, LicenceRenewalTerm>
  1964. */
  1965. public function getZeroPeriodLicenceRenewalTerms(): Collection
  1966. {
  1967. return $this->licenceRenewalTerms->filter(function ($term) {
  1968. return $term->getPeriod() === 0;
  1969. });
  1970. }
  1972. /**
  1973. * @param LicenceRenewalTerm $licenceRenewalTerm
  1974. *
  1975. * @return self
  1976. */
  1977. public function addLicenceRenewalTerm(LicenceRenewalTerm $licenceRenewalTerm): self
  1978. {
  1979. if (!$this->licenceRenewalTerms->contains($licenceRenewalTerm)) {
  1980. $this->licenceRenewalTerms[] = $licenceRenewalTerm;
  1981. $licenceRenewalTerm->setAccount($this);
  1982. }
  1984. return $this;
  1985. }
  1987. /**
  1988. * @param LicenceRenewalTerm $licenceRenewalTerm
  1989. *
  1990. * @return self
  1991. */
  1992. public function removeLicenceRenewalTerm(LicenceRenewalTerm $licenceRenewalTerm): self
  1993. {
  1994. if ($this->licenceRenewalTerms->removeElement($licenceRenewalTerm)) {
  1995. // set the owning side to null (unless already changed)
  1996. if ($licenceRenewalTerm->getAccount() === $this) {
  1997. $licenceRenewalTerm->setAccount(null);
  1998. }
  1999. }
  2001. return $this;
  2002. }
  2004. /**
  2005. * @return bool|null
  2006. */
  2007. public function isEnforceTwoFactorAuth(): ?bool
  2008. {
  2009. return $this->enforceTwoFactorAuth;
  2010. }
  2012. /**
  2013. * @param bool $enforceTwoFactorAuth
  2014. *
  2015. * @return self
  2016. */
  2017. public function setEnforceTwoFactorAuth(bool $enforceTwoFactorAuth): self
  2018. {
  2019. $this->enforceTwoFactorAuth = $enforceTwoFactorAuth;
  2021. return $this;
  2022. }
  2024. /**
  2025. * @return bool|null
  2026. */
  2027. public function isAllowTwoFactorAuthGracePeriod(): ?bool
  2028. {
  2029. return $this->allowTwoFactorAuthGracePeriod;
  2030. }
  2032. /**
  2033. * @param bool $allowTwoFactorAuthGracePeriod
  2034. *
  2035. * @return self
  2036. */
  2037. public function setAllowTwoFactorAuthGracePeriod(bool $allowTwoFactorAuthGracePeriod): self
  2038. {
  2039. $this->allowTwoFactorAuthGracePeriod = $allowTwoFactorAuthGracePeriod;
  2041. return $this;
  2042. }
  2044. /**
  2045. * Checks if the client is not liable for the disclosure fee.
  2046. *
  2047. * @return bool True if the client is not liable, false otherwise.
  2048. */
  2049. public function isClientNotLiableForDisclosureFee(): bool
  2050. {
  2051. return $this->clientNotLiableForDisclosureFee;
  2052. }
  2054. /**
  2055. * Sets whether the client is not liable for the disclosure fee.
  2056. *
  2057. * @param bool $clientNotLiableForDisclosureFee True if the client is not liable, false otherwise.
  2058. *
  2059. * @return self
  2060. */
  2061. public function setClientNotLiableForDisclosureFee(bool $clientNotLiableForDisclosureFee): self
  2062. {
  2063. $this->clientNotLiableForDisclosureFee = $clientNotLiableForDisclosureFee;
  2065. return $this;
  2066. }
  2068. /**
  2069. * Returns an array of permitted values for the country of registration field and their
  2070. * associated labels.
  2071. *
  2072. * @return array
  2073. */
  2074. public static function getCountryOfRegistrationOptions()
  2075. {
  2076. return [
  2077. self::COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES => self::COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES__LABEL,
  2078. self::COUNTRY_OF_REGISTRATION_SCOTLAND => self::COUNTRY_OF_REGISTRATION_SCOTLAND__LABEL,
  2079. self::COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND => self::COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND__LABEL,
  2080. ];
  2081. }
  2083. /**
  2084. * Get trading_name.
  2085. *
  2086. * @return string|null
  2087. */
  2088. public function getTradingName(): ?string
  2089. {
  2090. return $this->trading_name;
  2091. }
  2093. /**
  2094. * Set trading_name.
  2095. *
  2096. * @param string|null $trading_name
  2097. *
  2098. * @return self
  2099. */
  2100. public function setTradingName(?string $trading_name): self
  2101. {
  2102. $this->trading_name = $trading_name;
  2104. return $this;
  2105. }
  2107. /**
  2108. * Get company_registration_number.
  2109. *
  2110. * @return string|null
  2111. */
  2112. public function getCompanyRegistrationNumber(): ?string
  2113. {
  2114. return $this->company_registration_number;
  2115. }
  2117. /**
  2118. * Set company_registration_number.
  2119. *
  2120. * @param string|null $company_registration_number
  2121. *
  2122. * @return self
  2123. */
  2124. public function setCompanyRegistrationNumber(?string $company_registration_number): self
  2125. {
  2126. $this->company_registration_number = $company_registration_number;
  2128. return $this;
  2129. }
  2131. /**
  2132. * Get country_of_registration.
  2133. *
  2134. * @return string|null
  2135. */
  2136. public function getCountryOfRegistration(): ?string
  2137. {
  2138. return $this->country_of_registration;
  2139. }
  2141. /**
  2142. * Set country_of_registration.
  2143. *
  2144. * @param string|null $country_of_registration
  2145. *
  2146. * @return self
  2147. */
  2148. public function setCountryOfRegistration(?string $country_of_registration): self
  2149. {
  2150. $this->country_of_registration = $country_of_registration;
  2152. return $this;
  2153. }
  2155. /**
  2156. * Returns a human-readable version of the country of registration
  2157. *
  2158. * @return string
  2159. */
  2160. public function getCountryOfRegistrationName()
  2161. {
  2162. $options = self::getCountryOfRegistrationOptions();
  2164. return $options[$this->getCountryOfRegistration()] ?? $this->getCountryOfRegistration();
  2165. }
  2166. }