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. // Insights Opt In options
  139. public const INSIGHTS_OPT_IN_NONE = 'none';
  140. public const INSIGHTS_OPT_IN_NONE__LABEL = 'None';
  141. public const INSIGHTS_OPT_IN_ALL_CLIENT_USERS = 'all_client_users';
  142. public const INSIGHTS_OPT_IN_ALL_CLIENT_USERS__LABEL = 'All Client Users';
  143. public const INSIGHTS_OPT_IN_SPECIFIC_USERS = 'specific_users';
  144. public const INSIGHTS_OPT_IN_SPECIFIC_USERS__LABEL = 'Specific Users';
  146. /**
  147. * @var ContactableAddress
  148. *
  149. * This field is unmapped, and is purely here for the API.
  150. *
  151. * @Groups({"account:read", "matter_request:read"})
  152. */
  153. protected $returnDetailsAddress;
  155. /**
  156. * @var string
  157. *
  158. * @ORM\Column(name="matterCreationProcess", type="string", nullable=true)
  159. */
  160. protected $matterCreationProcess = self::MATTER_CREATION_PROCESS_CLASSIC;
  162. /**
  163. * @var string|null
  164. *
  165. * @ORM\Column(name="custom_index_header", type="text", nullable=true)
  166. */
  167. protected $custom_index_header;
  169. /**
  170. * @var string|null
  171. *
  172. * @ORM\Column(name="standardIndexHeader", type="text", nullable=true)
  173. */
  174. protected $standardIndexHeader;
  176. /**
  177. * Indicates if the MedBrief logo should be hidden from the index produced.
  178. * The scenario for this is where clients sort their own records, or a sorting standard that
  179. * deviates from our standard sorting product.
  180. *
  181. * @var bool
  182. *
  183. * @ORM\Column(type="boolean", options={"default"=false})
  184. */
  185. protected $hideLogoFromIndex = false;
  187. /**
  188. * @Groups({"client_area:read"})
  189. *
  190. * @ORM\Column(name="id", type="bigint", nullable=false)
  191. *
  192. * @ORM\Id
  193. *
  194. * @ORM\GeneratedValue(strategy="IDENTITY")
  195. */
  196. private ?int $id;
  198. /**
  199. * @Groups({"account:read", "matter_request:read", "client_area:read"})
  200. *
  201. * @ORM\Column(name="name", type="string", length=155, nullable=false)
  202. */
  203. private ?string $name;
  205. /**
  206. * @var Collection
  207. *
  208. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Domain", mappedBy="account", cascade={"all"})
  209. */
  210. private $domains;
  212. /**
  213. * @var array|null
  214. *
  215. * @ORM\Column(name="allowed_license_levels", type="array", nullable=true)
  216. */
  217. private $allowed_license_levels;
  219. /**
  220. * @var string|null
  221. *
  222. * @ORM\Column(name="prefix", type="string", length=25, nullable=true)
  223. */
  224. private $prefix;
  226. /**
  227. * @var string|null
  228. *
  229. * @ORM\Column(name="legal_entity_name", type="text", nullable=true)
  230. */
  231. private $legal_entity_name = null;
  233. /**
  234. * Sets all service requests for this client not to come up for invoicing.
  235. *
  236. * @var bool
  237. *
  238. * @ORM\Column(name="hide_from_invoicing", type="boolean", options={"default"=false})
  239. */
  240. private $hide_from_invoicing;
  242. /**
  243. * @var string|null
  244. *
  245. * @ORM\Column(name="default_role", type="string", nullable=true)
  246. */
  247. private $default_role;
  249. /**
  250. * Holds the Account's payment terms value (in days) for adjusting
  251. * the due date on invoices automagically.
  252. *
  253. * @var int
  254. *
  255. * @ORM\Column(name="invoice_payment_terms", type="integer", nullable=true)
  256. */
  257. private $invoice_payment_terms;
  259. /**
  260. * @var int|null
  261. *
  262. * @ORM\Column(name="invoice_billing_frequency", type="integer", nullable=true)
  263. */
  264. private $invoice_billing_frequency;
  266. /**
  267. * @var int|null
  268. *
  269. * @ORM\Column(name="invoice_type", type="integer", nullable=true)
  270. */
  271. private $invoice_type;
  273. /**
  274. * The different UserNotifications disabled for this Client
  275. *
  276. * @var array
  277. *
  278. * @ORM\Column(name="disabled_notifications", type="array", nullable=true)
  279. */
  280. private $disabled_notifications = [];
  282. /**
  283. * A default sorting instruction for all the Account's sorting sessions.
  284. * This is visible to the sorter.
  285. *
  286. * @var SortingInstruction
  287. *
  288. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\SortingInstruction", inversedBy="account", cascade={"persist","remove"}, orphanRemoval=true)
  289. *
  290. * @ORM\JoinColumns({
  291. *
  292. * @ORM\JoinColumn(name="defaultSortingInstruction_id", referencedColumnName="id", unique=true)
  293. * })
  294. */
  295. private $defaultSortingInstruction;
  297. /**
  298. * Determines if a draft memo will be exported for the client on Sorting Session completions.
  299. *
  300. * @var bool
  301. *
  302. * @ORM\Column(name="requireMemo", type="boolean", options={"default"=false})
  303. */
  304. private $requireMemo = false;
  306. /**
  307. * Whether to require the user to enter a password on downloading a document or folder
  308. *
  309. * @var bool
  310. *
  311. * @ORM\Column(name="require_password_on_download", type="boolean", options={"default"=false})
  312. */
  313. private $require_password_on_download;
  315. /**
  316. * @var ArrayCollection
  317. *
  318. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\AccountSortingMemoPhrase", mappedBy="account", cascade={"all"})
  319. */
  320. private $accountSortingMemoPhrases;
  322. /**
  323. * @var MatterRequestDefaults
  324. *
  325. * @Groups({"account:read", "matter_request:read"})
  326. *
  327. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\MatterRequestDefaults", mappedBy="account")
  328. */
  329. private $matterRequestDefaults;
  331. /**
  332. * @var ContactableAddress
  333. *
  334. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ContactableAddress", cascade={"all"})
  335. *
  336. * @ORM\JoinColumns({
  337. *
  338. * @ORM\JoinColumn(name="billingAddress_id", referencedColumnName="id", unique=true)
  339. * })
  340. */
  341. private $billingAddress;
  343. /**
  344. * @var ContactableAddress
  345. */
  346. private $accountsAddress;
  348. /**
  349. * @var ContactableAddress
  350. *
  351. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ContactableAddress", cascade={"all"})
  352. *
  353. * @ORM\JoinColumns({
  354. *
  355. * @ORM\JoinColumn(name="physicalAddress_id", referencedColumnName="id", unique=true)
  356. * })
  357. */
  358. private $physicalAddress;
  360. /**
  361. * @var Collection
  362. *
  363. * @ORM\ManyToMany(targetEntity="MedBrief\MSR\Entity\ContactableAddress", inversedBy="accounts", cascade={"persist"})
  364. *
  365. * @ORM\JoinTable(name="account_contactableaddress",
  366. * joinColumns={
  367. *
  368. * @ORM\JoinColumn(name="account_id", referencedColumnName="id", onDelete="CASCADE")
  369. * },
  370. * inverseJoinColumns={
  371. * @ORM\JoinColumn(name="contactableaddress_id", referencedColumnName="id", onDelete="CASCADE")
  372. * }
  373. * )
  374. */
  375. private $offices;
  377. /**
  378. * @var string
  379. *
  380. * @ORM\Column(name="slug", type="string")
  381. *
  382. * @Gedmo\Slug(fields={"name"}, updatable=false, separator="_")
  383. */
  384. private $slug;
  386. /**
  387. * @var \DateTime
  388. *
  389. * @ORM\Column(name="created", type="datetime")
  390. *
  391. * @Gedmo\Timestampable(on="create")
  392. */
  393. private $created;
  395. /**
  396. * @var \DateTime
  397. *
  398. * @ORM\Column(name="updated", type="datetime")
  399. *
  400. * @Gedmo\Timestampable(on="update")
  401. */
  402. private $updated;
  404. /**
  405. * @var Collection
  406. *
  407. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Project", mappedBy="account", cascade={"all"})
  408. */
  409. private $projects;
  411. /**
  412. * @var Collection
  413. */
  414. private $addresses;
  416. /**
  417. * @var \DateTime
  418. *
  419. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
  420. */
  421. private $deletedAt;
  423. /**
  424. * @var string
  425. */
  426. private $image;
  428. /**
  429. * @var string
  430. *
  431. * @ORM\Column(name="image_name", type="string", length=255, nullable=true)
  432. */
  433. private $image_name;
  435. /**
  436. * @var string|null
  437. */
  438. private $companyThumbnail = null;
  440. /**
  441. * @var string|null
  442. *
  443. * @ORM\Column(name="companyThumbnailName", type="string", length=255, nullable=true)
  444. *
  445. */
  446. private $companyThumbnailName = null;
  448. /**
  449. * @var string|null
  450. */
  451. private $companyLetterheadLogo = null;
  453. /**
  454. * @var string|null
  455. *
  456. * @ORM\Column(name="companyLetterheadLogoName", type="string", length=255, nullable=true)
  457. *
  458. */
  459. private $companyLetterheadLogoName = null;
  461. /**
  462. * Determines if an account can create/update batch requests and sort sessions.
  463. *
  464. * @var bool
  465. *
  466. * @ORM\Column(name="canCreateBatchAndSort", type="boolean", options={"default"=false})
  467. */
  468. private $canCreateBatchAndSort = false;
  470. /**
  471. * Determines if an account is able to use match.
  472. *
  473. * @var string
  474. *
  475. * @ORM\Column(name="matchOptIn", type="string", length=50, nullable=false)
  476. */
  477. private string $matchOptIn = self::MATCH_OPT_IN_NONE;
  479. /**
  480. * Determines if an account is able to use MedBrief Insights.
  481. *
  482. * @var string
  483. *
  484. * @ORM\Column(name="insightsOptIn", type="string", length=50, nullable=false)
  485. */
  486. private ?string $insightsOptIn = self::INSIGHTS_OPT_IN_NONE;
  488. /**
  489. * Determines the default value of the same field on a Project/Matter, when a new Project is created.
  490. *
  491. * @var bool
  492. *
  493. * @ORM\Column(name="allowExpertViewUnsortedRecords", type="boolean", options={"default"=false})
  494. */
  495. private $allowExpertViewUnsortedRecords = false;
  497. /**
  498. * Determines if the questions presented during the Matter Closure Wizard are optional.
  499. *
  500. * @var bool
  501. *
  502. * @ORM\Column(name="matterClosureQuestionsOptional", type="boolean", options={"default"=false})
  503. */
  504. private $matterClosureQuestionsOptional = false;
  506. /**
  507. * @var bool
  508. *
  509. * @ORM\Column(name="useParentClinicalSectionsOnly", type="boolean")
  510. */
  511. private $useParentClinicalSectionsOnly = false;
  513. /**
  514. * @ORM\ManyToOne(targetEntity=Firm::class, inversedBy="clientAreas")
  515. */
  516. private $firm;
  518. /**
  519. * @Groups({"account:read", "matter_request:read"})
  520. *
  521. * @ORM\Column(name="allowedMatterTypes", type="array", nullable=true)
  522. *
  523. * @Assert\Count(
  524. * min=1,
  525. * minMessage = "Please select an option.",
  526. * groups={"account:read", "matter_request:read"}
  527. * )
  528. */
  529. private array $allowedMatterTypes = [];
  531. /**
  532. * @ORM\OneToMany(targetEntity=LicenceRenewalTerm::class, mappedBy="account", orphanRemoval=true)
  533. *
  534. * @ORM\OrderBy({"effectiveDate" = "ASC"})
  535. *
  536. * When a new period is added, a new related service option for the same period should also be created and mapped.
  537. */
  538. private ?Collection $licenceRenewalTerms;
  540. /**
  541. * Sets whether any client level users, or users invited to the client's
  542. * matters should require 2FA to be enabled.
  543. *
  544. * @ORM\Column(type="boolean", options={"default"=false})
  545. */
  546. private bool $enforceTwoFactorAuth = false;
  548. /**
  549. * If enabled, allows the users that are forced to enabled 2FA via the
  550. * enforceTwoFactorAuth property to skip the requirement for the first
  551. * two (2) logins.
  552. *
  553. * @ORM\Column(type="boolean", options={"default"=false})
  554. */
  555. private bool $allowTwoFactorAuthGracePeriod = false;
  557. /**
  558. * If enabled, the account (client) is not liable for the disclosure fee,
  559. * the Recipient Firm is liable.
  560. *
  561. * @ORM\Column(type="boolean", options={"default"=false})
  562. */
  563. private bool $clientNotLiableForDisclosureFee = false;
  565. /**
  566. * @var string|null
  567. *
  568. * @ORM\Column(name="trading_name", type="text", nullable=true)
  569. */
  570. private $trading_name = null;
  572. /**
  573. * @var string|null
  574. *
  575. * @ORM\Column(name="company_registration_number", type="string", length=255, nullable=true)
  576. */
  577. private $company_registration_number = null;
  579. /**
  580. * @var string|null
  581. *
  582. * @ORM\Column(name="country_of_registration", type="string", length=255, nullable=true)
  583. */
  584. private $country_of_registration = null;
  586. /**
  587. * Constructor
  588. */
  589. public function __construct()
  590. {
  591. $this->domains = new ArrayCollection();
  592. $this->allowed_license_levels = [];
  593. $this->hide_from_invoicing = false;
  594. $this->require_password_on_download = false;
  595. $this->accountSortingMemoPhrases = new ArrayCollection();
  596. $this->matterCreationProcess = self::MATTER_CREATION_PROCESS_CLASSIC;
  597. $this->projects = new ArrayCollection();
  598. $this->offices = new ArrayCollection();
  599. $this->licenceRenewalTerms = new ArrayCollection();
  600. }
  602. public function __toString()
  603. {
  604. return $this->getName();
  605. }
  607. /**
  608. * Get id
  609. *
  610. * @return int
  611. */
  612. public function getId()
  613. {
  614. return $this->id;
  615. }
  617. /**
  618. * Set name
  619. *
  620. * @param string $name
  621. *
  622. * @return Account
  623. */
  624. public function setName($name)
  625. {
  626. $this->name = $name;
  628. return $this;
  629. }
  631. /**
  632. * Get name
  633. *
  634. * @return string
  635. */
  636. public function getName()
  637. {
  638. return $this->name;
  639. }
  641. /**
  642. * Add domains
  643. *
  644. * @param Domain $domains
  645. *
  646. * @return Account
  647. */
  648. public function addDomain(Domain $domains)
  649. {
  650. $this->domains[] = $domains;
  652. return $this;
  653. }
  655. /**
  656. * Remove domains
  657. *
  658. * @param Domain $domains
  659. */
  660. public function removeDomain(Domain $domains)
  661. {
  662. $this->domains->removeElement($domains);
  663. }
  665. /**
  666. * Get domains
  667. *
  668. * @return Collection
  669. */
  670. public function getDomains()
  671. {
  672. return $this->domains;
  673. }
  675. /**
  676. * Set slug
  677. *
  678. * @param string $slug
  679. *
  680. * @return Account
  681. */
  682. public function setSlug($slug)
  683. {
  684. $this->slug = $slug;
  686. return $this;
  687. }
  689. /**
  690. * Get slug
  691. *
  692. * @return string
  693. */
  694. public function getSlug()
  695. {
  696. return $this->slug;
  697. }
  699. /**
  700. * Set created
  701. *
  702. * @param \DateTime $created
  703. *
  704. * @return Account
  705. */
  706. public function setCreated($created)
  707. {
  708. $this->created = $created;
  710. return $this;
  711. }
  713. /**
  714. * Get created
  715. *
  716. * @return \DateTime
  717. */
  718. public function getCreated()
  719. {
  720. return $this->created;
  721. }
  723. /**
  724. * Set updated
  725. *
  726. * @param \DateTime $updated
  727. *
  728. * @return Account
  729. */
  730. public function setUpdated($updated)
  731. {
  732. $this->updated = $updated;
  734. return $this;
  735. }
  737. /**
  738. * Get updated
  739. *
  740. * @return \DateTime
  741. */
  742. public function getUpdated()
  743. {
  744. return $this->updated;
  745. }
  747. /**
  748. * Add projects
  749. *
  750. * @param Project $projects
  751. *
  752. * @return Account
  753. */
  754. public function addProject(Project $projects)
  755. {
  756. $this->projects[] = $projects;
  758. return $this;
  759. }
  761. /**
  762. * Remove projects
  763. *
  764. * @param Project $projects
  765. */
  766. public function removeProject(Project $projects)
  767. {
  768. $this->projects->removeElement($projects);
  769. }
  771. /**
  772. * Get projects
  773. *
  774. * @return Collection
  775. */
  776. public function getProjects()
  777. {
  778. return $this->projects;
  779. }
  781. public function getArchivedProjects()
  782. {
  783. $criteria = Criteria::create()
  784. ->where(Criteria::expr()->gt('archive_status', 0))
  785. ->orderBy(['name' => Criteria::ASC])
  786. ;
  788. return $this->getProjects()->matching($criteria);
  789. }
  791. public function getActiveProjects()
  792. {
  793. $criteria = Criteria::create()
  794. ->where(Criteria::expr()->eq('status', Project::STATUS_ACTIVE))
  795. ->orderBy(['name' => Criteria::ASC])
  796. ;
  798. return $this->getProjects()->matching($criteria);
  799. }
  801. public function getInactiveProjects()
  802. {
  803. $criteria = Criteria::create()
  804. ->where(Criteria::expr()->eq('status', Project::STATUS_INACTIVE))
  805. ->orderBy(['name' => Criteria::ASC])
  806. ;
  808. return $this->getProjects()->matching($criteria);
  809. }
  811. /**
  812. * Set invoice_billing_frequency
  813. *
  814. * @param string $invoiceBillingFrequency
  815. *
  816. * @return Account
  817. */
  818. public function setInvoiceBillingFrequency($invoiceBillingFrequency)
  819. {
  820. $this->invoice_billing_frequency = $invoiceBillingFrequency;
  822. return $this;
  823. }
  825. /**
  826. * Get invoice_billing_frequency
  827. *
  828. * @return string
  829. */
  830. public function getInvoiceBillingFrequency()
  831. {
  832. return $this->invoice_billing_frequency;
  833. }
  835. /**
  836. * Set invoice_type
  837. *
  838. * @param string $invoiceType
  839. *
  840. * @return Account
  841. */
  842. public function setInvoiceType($invoiceType)
  843. {
  844. $this->invoice_type = $invoiceType;
  846. return $this;
  847. }
  849. /**
  850. * Get invoice_type
  851. *
  852. * @return string
  853. */
  854. public function getInvoiceType()
  855. {
  856. return $this->invoice_type;
  857. }
  859. /**
  860. * Set billingAddress
  861. *
  862. * @param ContactableAddress $billingAddress
  863. *
  864. * @return Account
  865. */
  866. public function setBillingAddress(?ContactableAddress $billingAddress = null)
  867. {
  868. $this->billingAddress = $billingAddress;
  870. return $this;
  871. }
  873. /**
  874. * Get billingAddress
  875. *
  876. * @return ContactableAddress
  877. */
  878. public function getBillingAddress()
  879. {
  880. return $this->billingAddress;
  881. }
  883. /**
  884. * Set accountsAddress
  885. *
  886. * @param ContactableAddress $accountsAddress
  887. *
  888. * @return Account
  889. */
  890. public function setAccountsAddress(?ContactableAddress $accountsAddress = null)
  891. {
  892. $this->accountsAddress = $accountsAddress;
  894. return $this;
  895. }
  897. /**
  898. * Get accountsAddress
  899. *
  900. * @return ContactableAddress
  901. */
  902. public function getAccountsAddress()
  903. {
  904. return $this->accountsAddress;
  905. }
  907. /**
  908. * Set physicalAddress
  909. *
  910. * @param ContactableAddress $physicalAddress
  911. *
  912. * @return Account
  913. */
  914. public function setPhysicalAddress(?ContactableAddress $physicalAddress = null)
  915. {
  916. $this->physicalAddress = $physicalAddress;
  918. return $this;
  919. }
  921. /**
  922. * Get physicalAddress
  923. *
  924. * @return ContactableAddress
  925. */
  926. public function getPhysicalAddress()
  927. {
  928. return $this->physicalAddress;
  929. }
  931. /**
  932. * Add offices
  933. *
  934. * @param ContactableAddress $offices
  935. *
  936. * @return Account
  937. */
  938. public function addOffice(ContactableAddress $offices)
  939. {
  940. $this->offices[] = $offices;
  942. return $this;
  943. }
  945. /**
  946. * Remove offices
  947. *
  948. * @param ContactableAddress $offices
  949. */
  950. public function removeOffice(ContactableAddress $offices)
  951. {
  952. $this->offices->removeElement($offices);
  953. }
  955. /**
  956. * Get offices
  957. *
  958. * @return Collection
  959. */
  960. public function getOffices()
  961. {
  962. return $this->offices;
  963. }
  965. /**
  966. * Returns an array of permitted values for the invoice billing frequency field and their
  967. * associated labels,
  968. *
  969. * @return array
  970. */
  971. public static function getInvoiceBillingFrequencyOptions()
  972. {
  973. return [
  974. self::INVOICE_BILLING_FREQUENCY_MONTHLY => 'Monthly',
  975. self::INVOICE_BILLING_FREQUENCY_QUARTERLY => 'Quarterly',
  976. self::INVOICE_BILLING_FREQUENCY_START_OF_MATTER => 'At the start of the matter',
  977. ];
  978. }
  980. /**
  981. * Returns a human readable version of the invoice billing frequency
  982. *
  983. * @return string
  984. */
  985. public function getInvoiceBillingFrequencyName()
  986. {
  987. $options = self::getInvoiceBillingFrequencyOptions();
  989. return
  990. $options[$this->getInvoiceBillingFrequency()] ?? $this->getInvoiceBillingFrequency();
  991. }
  993. /**
  994. * Returns an array of permitted values for the invoice billing frequency field and their
  995. * associated labels,
  996. *
  997. * @return array
  998. */
  999. public static function getInvoiceTypeOptions()
  1000. {
  1001. return [
  1002. self::INVOICE_TYPE_CONSOLIDATED => 'Consolidated',
  1003. self::INVOICE_TYPE_INDIVIDUAL_MATTER => 'Individual Matter',
  1004. ];
  1005. }
  1007. /**
  1008. * Returns a human readable version of the invoice billing frequency
  1009. *
  1010. * @return string
  1011. */
  1012. public function getInvoiceTypeName()
  1013. {
  1014. $options = self::getInvoiceTypeOptions();
  1016. return
  1017. $options[$this->getInvoiceType()] ?? $this->getInvoiceType();
  1018. }
  1020. /**
  1021. * Set deletedAt
  1022. *
  1023. * @param \DateTime $deletedAt
  1024. *
  1025. * @return Account
  1026. */
  1027. public function setDeletedAt($deletedAt)
  1028. {
  1029. $this->deletedAt = $deletedAt;
  1031. return $this;
  1032. }
  1034. /**
  1035. * Get deletedAt
  1036. *
  1037. * @return \DateTime
  1038. */
  1039. public function getDeletedAt()
  1040. {
  1041. return $this->deletedAt;
  1042. }
  1044. /**
  1045. * Set image
  1046. *
  1047. * @param string $image
  1048. *
  1049. * @return Account
  1050. */
  1051. public function setImage($image)
  1052. {
  1053. if (null !== $image) {
  1054. // It is required that at least one field changes if you are using doctrine
  1055. // otherwise the event listeners won't be called and the file is lost
  1056. $this->updated = new \DateTimeImmutable();
  1057. }
  1059. $this->image = $image;
  1061. return $this;
  1062. }
  1064. /**
  1065. * Indicates whether or not this user has an image
  1066. *
  1067. * @return bool
  1068. */
  1069. public function hasImage()
  1070. {
  1071. // note that we use the imageName field because the image field will be
  1072. // populated with the gaufrette file location immediately on upload
  1073. // even if the upload fails. So if you call this function on the user
  1074. // before it is peristed it may give you a false positive.
  1075. $image = $this->getImageName();
  1077. return !empty($image);
  1078. }
  1080. /**
  1081. * Get image
  1082. *
  1083. * @return string
  1084. */
  1085. public function getImage()
  1086. {
  1087. return $this->image;
  1088. }
  1090. /**
  1091. * Set image_name
  1092. *
  1093. * @param string $imageName
  1094. *
  1095. * @return Account
  1096. */
  1097. public function setImageName($imageName)
  1098. {
  1099. $this->image_name = $imageName;
  1101. return $this;
  1102. }
  1104. /**
  1105. * Get image_name
  1106. *
  1107. * @return string
  1108. */
  1109. public function getImageName()
  1110. {
  1111. return $this->image_name;
  1112. }
  1114. /**
  1115. * Set companyThumbnail
  1116. *
  1117. * @param string $companyThumbnail
  1118. *
  1119. * @return Account
  1120. */
  1121. public function setCompanyThumbnail($companyThumbnail)
  1122. {
  1124. if (null !== $companyThumbnail) {
  1125. // It is required that at least one field changes if you are using doctrine
  1126. // otherwise the event listeners won't be called and the file is lost
  1127. $this->updated = new \DateTimeImmutable();
  1128. }
  1130. $this->companyThumbnail = $companyThumbnail;
  1132. return $this;
  1133. }
  1135. /**
  1136. * Get companyThumbnail
  1137. *
  1138. * @return string
  1139. */
  1140. public function getCompanyThumbnail()
  1141. {
  1142. return $this->companyThumbnail;
  1143. }
  1145. /**
  1146. * Indicates whether or not this account has a company thumbnail
  1147. *
  1148. * @return bool
  1149. */
  1150. public function hasCompanyThumbnail()
  1151. {
  1152. // note that we use the companyThumbnailName field because the companyThumbnail field will be
  1153. // populated with the gaufrette file location immediately on upload
  1154. // even if the upload fails. So if you call this function on the user
  1155. // before it is persisted it may give you a false positive.
  1156. $companyThumbnail = $this->getCompanyThumbnailName();
  1158. return !empty($companyThumbnail);
  1159. }
  1161. /**
  1162. * Set companyThumbnailName
  1163. *
  1164. * @param string $companyThumbnailName
  1165. *
  1166. * @return Account
  1167. */
  1168. public function setCompanyThumbnailName($companyThumbnailName)
  1169. {
  1170. $this->companyThumbnailName = $companyThumbnailName;
  1172. return $this;
  1173. }
  1175. /**
  1176. * Get companyThumbnailName
  1177. *
  1178. * @return string
  1179. */
  1180. public function getCompanyThumbnailName()
  1181. {
  1182. return $this->companyThumbnailName;
  1183. }
  1186. /**
  1187. * Set companyLetterheadLogo
  1188. *
  1189. * @param string $companyLetterheadLogo
  1190. *
  1191. * @return Account
  1192. */
  1193. public function setCompanyLetterheadLogo($companyLetterheadLogo)
  1194. {
  1196. if (null !== $companyLetterheadLogo) {
  1197. // It is required that at least one field changes if you are using doctrine
  1198. // otherwise the event listeners won't be called and the file is lost
  1199. $this->updated = new \DateTimeImmutable();
  1200. }
  1202. $this->companyLetterheadLogo = $companyLetterheadLogo;
  1204. return $this;
  1205. }
  1207. /**
  1208. * Get companyLetterheadLogo
  1209. *
  1210. * @return string
  1211. */
  1212. public function getCompanyLetterheadLogo()
  1213. {
  1214. return $this->companyLetterheadLogo;
  1215. }
  1217. /**
  1218. * Indicates whether or not this account has a company letterhead logo
  1219. *
  1220. * @return bool
  1221. */
  1222. public function hasCompanyLetterheadLogo()
  1223. {
  1224. // note that we use the companyLetterheadLogoName field because the companyLetterheadLogo field will be
  1225. // populated with the gaufrette file location immediately on upload
  1226. // even if the upload fails. So if you call this function on the user
  1227. // before it is persisted it may give you a false positive.
  1228. $companyLetterheadLogo = $this->getCompanyLetterheadLogoName();
  1230. return !empty($companyLetterheadLogo);
  1231. }
  1233. /**
  1234. * Set companyLetterheadLogoName
  1235. *
  1236. * @param string $companyLetterheadLogoName
  1237. *
  1238. * @return Account
  1239. */
  1240. public function setCompanyLetterheadLogoName($companyLetterheadLogoName)
  1241. {
  1242. $this->companyLetterheadLogoName = $companyLetterheadLogoName;
  1244. return $this;
  1245. }
  1247. /**
  1248. * Get companyLetterheadLogoName
  1249. *
  1250. * @return string
  1251. */
  1252. public function getCompanyLetterheadLogoName()
  1253. {
  1254. return $this->companyLetterheadLogoName;
  1255. }
  1257. /**
  1258. * Set allowedLicenseLevels
  1259. *
  1260. * @param array $allowedLicenseLevels
  1261. *
  1262. * @return Account
  1263. */
  1264. public function setAllowedLicenseLevels($allowedLicenseLevels)
  1265. {
  1266. $this->allowed_license_levels = $allowedLicenseLevels;
  1268. return $this;
  1269. }
  1271. /**
  1272. * Get allowedLicenseLevels
  1273. *
  1274. * @return array
  1275. */
  1276. public function getAllowedLicenseLevels()
  1277. {
  1278. if ($this->allowed_license_levels === null) {
  1279. return [];
  1280. }
  1282. return $this->allowed_license_levels;
  1283. }
  1285. /**
  1286. * Set prefix
  1287. *
  1288. * @param string $prefix
  1289. *
  1290. * @return Account
  1291. */
  1292. public function setPrefix($prefix)
  1293. {
  1294. $this->prefix = strtoupper($prefix);
  1296. return $this;
  1297. }
  1299. /**
  1300. * Get prefix
  1301. *
  1302. * @return string
  1303. */
  1304. public function getPrefix()
  1305. {
  1306. return strtoupper($this->prefix);
  1307. }
  1309. /**
  1310. * Set legalEntityName
  1311. *
  1312. * @param string $legalEntityName
  1313. *
  1314. * @return Account
  1315. */
  1316. public function setLegalEntityName($legalEntityName)
  1317. {
  1318. $this->legal_entity_name = $legalEntityName;
  1320. return $this;
  1321. }
  1323. /**
  1324. * Get legalEntityName
  1325. *
  1326. * @return string
  1327. */
  1328. public function getLegalEntityName()
  1329. {
  1330. return $this->legal_entity_name;
  1331. }
  1333. /**
  1334. * Set defaultRole
  1335. *
  1336. * @param string $defaultRole
  1337. *
  1338. * @return Account
  1339. */
  1340. public function setDefaultRole($defaultRole)
  1341. {
  1342. $this->default_role = $defaultRole;
  1344. return $this;
  1345. }
  1347. /**
  1348. * Get defaultRole
  1349. *
  1350. * @return string
  1351. */
  1352. public function getDefaultRole()
  1353. {
  1354. return $this->default_role;
  1355. }
  1357. /**
  1358. * Get defaultRoleOptions
  1359. *
  1360. * @return array
  1361. */
  1362. public static function getDefaultRoleOptions()
  1363. {
  1364. return [
  1365. self::DEFAULT_ROLE_ADMINISTRATOR => 'Client Administrator',
  1366. self::DEFAULT_ROLE_SUPERADMINISTRATOR => 'Client Super Administrator',
  1367. self::DEFAULT_ROLE_PROJECTMANAGER => 'Client Project Manager',
  1368. self::DEFAULT_ROLE_SORTER => 'Sorter',
  1369. ];
  1370. }
  1372. /**
  1373. * Get DefaultRoleLabel
  1374. *
  1375. * @return string
  1376. */
  1377. public function getDefaultRoleLabel()
  1378. {
  1379. $options = self::getDefaultRoleOptions();
  1380. return $options[$this->getDefaultRole()] ?? '';
  1381. }
  1383. /**
  1384. * Get DefaultRoleLabel
  1385. *
  1386. * @return string
  1387. */
  1388. public function getDefaultRoleAsRole()
  1389. {
  1390. if (!$this->getDefaultRole()) {
  1391. return '';
  1392. }
  1394. return 'ROLE_ACCOUNT_' . $this->getId() . '_' . $this->getDefaultRole();
  1395. }
  1397. /**
  1398. * Set hideFromInvoicing
  1399. *
  1400. * @param bool $hideFromInvoicing
  1401. *
  1402. * @return Account
  1403. */
  1404. public function setHideFromInvoicing($hideFromInvoicing)
  1405. {
  1406. $this->hide_from_invoicing = $hideFromInvoicing;
  1408. return $this;
  1409. }
  1411. /**
  1412. * Get hideFromInvoicing
  1413. *
  1414. * @return bool
  1415. */
  1416. public function getHideFromInvoicing()
  1417. {
  1418. return $this->hide_from_invoicing;
  1419. }
  1421. /**
  1422. * Set invoicePaymentTerms
  1423. *
  1424. * @param int $invoicePaymentTerms
  1425. *
  1426. * @return Account
  1427. */
  1428. public function setInvoicePaymentTerms($invoicePaymentTerms)
  1429. {
  1430. $this->invoice_payment_terms = $invoicePaymentTerms;
  1432. return $this;
  1433. }
  1435. /**
  1436. * Get invoicePaymentTerms
  1437. *
  1438. * @return int
  1439. */
  1440. public function getInvoicePaymentTerms()
  1441. {
  1442. return $this->invoice_payment_terms;
  1443. }
  1445. /**
  1446. * Get the disabled UserNotification types
  1447. *
  1448. * @return array
  1449. */
  1450. public function getDisabledNotifications(): array
  1451. {
  1452. return $this->disabled_notifications ?: [];
  1453. }
  1455. /**
  1456. * @param array $disabled_notifications
  1457. *
  1458. * @return Account
  1459. */
  1460. public function setDisabledNotifications(array $disabled_notifications): Account
  1461. {
  1462. $this->disabled_notifications = $disabled_notifications;
  1464. return $this;
  1465. }
  1467. /**
  1468. * Disable a notification
  1469. *
  1470. * @param $notification_type
  1471. *
  1472. * @return Account
  1473. */
  1474. public function disableNotification($notification_type)
  1475. {
  1476. if (!$this->disabled_notifications) {
  1477. $this->disabled_notifications = [];
  1478. }
  1480. array_push($this->disabled_notifications, $notification_type);
  1482. return $this;
  1483. }
  1485. /**
  1486. * Function to determine if the specific UserNotification is disabled for this Entity
  1487. *
  1488. * @param $notification_type
  1489. *
  1490. * @return bool
  1491. */
  1492. public function isNotificationDisabled($notification_type)
  1493. {
  1494. if (!$this->disabled_notifications) {
  1495. $this->disabled_notifications = [];
  1496. return false;
  1497. }
  1498. return in_array($notification_type, $this->disabled_notifications) ? true : false;
  1499. }
  1501. /**
  1502. * Set defaultSortingInstruction.
  1503. *
  1504. * @param SortingInstruction|null $defaultSortingInstruction
  1505. *
  1506. * @return Account
  1507. */
  1508. public function setDefaultSortingInstruction(?SortingInstruction $defaultSortingInstruction = null)
  1509. {
  1510. $this->defaultSortingInstruction = $defaultSortingInstruction;
  1512. return $this;
  1513. }
  1515. /**
  1516. * Get defaultSortingInstruction.
  1517. *
  1518. * @return SortingInstruction|null
  1519. */
  1520. public function getDefaultSortingInstruction()
  1521. {
  1522. return $this->defaultSortingInstruction;
  1523. }
  1525. /**
  1526. * Set requireMemo.
  1527. *
  1528. * @param bool $requireMemo
  1529. *
  1530. * @return Account
  1531. */
  1532. public function setRequireMemo($requireMemo)
  1533. {
  1534. $this->requireMemo = $requireMemo;
  1536. return $this;
  1537. }
  1539. /**
  1540. * Get requireMemo.
  1541. *
  1542. * @return bool
  1543. */
  1544. public function getRequireMemo()
  1545. {
  1546. return $this->requireMemo;
  1547. }
  1549. /**
  1550. * Set requirePasswordOnDownload.
  1551. *
  1552. * @param bool $requirePasswordOnDownload
  1553. *
  1554. * @return Account
  1555. */
  1556. public function setRequirePasswordOnDownload($requirePasswordOnDownload)
  1557. {
  1558. $this->require_password_on_download = $requirePasswordOnDownload;
  1560. return $this;
  1561. }
  1563. /**
  1564. * Get requirePasswordOnDownload.
  1565. *
  1566. * @return bool
  1567. */
  1568. public function getRequirePasswordOnDownload()
  1569. {
  1570. return $this->require_password_on_download;
  1571. }
  1573. /**
  1574. * Add accountSortingMemoPhrase.
  1575. *
  1576. * @param AccountSortingMemoPhrase $accountSortingMemoPhrase
  1577. *
  1578. * @return Account
  1579. */
  1580. public function addAccountSortingMemoPhrase(AccountSortingMemoPhrase $accountSortingMemoPhrase)
  1581. {
  1582. $this->accountSortingMemoPhrases[] = $accountSortingMemoPhrase;
  1584. return $this;
  1585. }
  1587. /**
  1588. * Remove accountSortingMemoPhrase.
  1589. *
  1590. * @param AccountSortingMemoPhrase $accountSortingMemoPhrase
  1591. *
  1592. * @return bool TRUE if this collection contained the specified element, FALSE otherwise.
  1593. */
  1594. public function removeAccountSortingMemoPhrase(AccountSortingMemoPhrase $accountSortingMemoPhrase)
  1595. {
  1596. return $this->accountSortingMemoPhrases->removeElement($accountSortingMemoPhrase);
  1597. }
  1599. /**
  1600. * Get accountSortingMemoPhrases.
  1601. *
  1602. * @return Collection
  1603. */
  1604. public function getAccountSortingMemoPhrases()
  1605. {
  1606. return $this->accountSortingMemoPhrases;
  1607. }
  1609. /**
  1610. * Set matterRequestDefaults.
  1611. *
  1612. * @param MatterRequestDefaults|null $matterRequestDefaults
  1613. *
  1614. * @return Account
  1615. */
  1616. public function setMatterRequestDefaults(?MatterRequestDefaults $matterRequestDefaults = null)
  1617. {
  1618. $this->matterRequestDefaults = $matterRequestDefaults;
  1620. return $this;
  1621. }
  1623. /**
  1624. * Get matterRequestDefaults.
  1625. *
  1626. * @return MatterRequestDefaults|null
  1627. */
  1628. public function getMatterRequestDefaults()
  1629. {
  1630. return $this->matterRequestDefaults;
  1631. }
  1633. /**
  1634. * Returns the return details address.
  1635. *
  1636. * @return ContactableAddress|null
  1637. */
  1638. public function getReturnDetailsAddress(): ?ContactableAddress
  1639. {
  1640. if ($this->getOffices() && $this->getOffices()->first()) {
  1641. return $this->getOffices()->first();
  1642. }
  1643. return null;
  1644. }
  1646. /**
  1647. * Set matterCreationProcess.
  1648. *
  1649. * @param string|null $matterCreationProcess
  1650. *
  1651. * @return Account
  1652. */
  1653. public function setMatterCreationProcess($matterCreationProcess = null): Account
  1654. {
  1655. $this->matterCreationProcess = $matterCreationProcess;
  1657. return $this;
  1658. }
  1660. /**
  1661. * Set customIndexHeader.
  1662. *
  1663. * @param string|null $customIndexHeader
  1664. *
  1665. * @return Account
  1666. */
  1667. public function setCustomIndexHeader($customIndexHeader = null)
  1668. {
  1669. $this->custom_index_header = $customIndexHeader;
  1671. return $this;
  1672. }
  1674. /**
  1675. * Get customIndexHeader.
  1676. *
  1677. * @return string|null
  1678. */
  1679. public function getCustomIndexHeader()
  1680. {
  1681. return $this->custom_index_header;
  1682. }
  1684. /**
  1685. * Get matterCreationProcess.
  1686. *
  1687. * @return string|null
  1688. */
  1689. public function getMatterCreationProcess(): ?string
  1690. {
  1691. return $this->matterCreationProcess;
  1692. }
  1694. /**
  1695. * Returns true if the client has access to classic matter creation.
  1696. *
  1697. * @return bool
  1698. */
  1699. public function hasAccessToClassicMatterCreation(): bool
  1700. {
  1701. return $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_CLASSIC || $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_ALL || $this->matterCreationProcess === null;
  1702. }
  1704. /**
  1705. * Returns true if the client has access to standard matter creation.
  1706. *
  1707. * @return bool
  1708. */
  1709. public function hasAccessToStandardMatterCreation(): bool
  1710. {
  1711. return $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_STANDARD || $this->matterCreationProcess === self::MATTER_CREATION_PROCESS_ALL;
  1712. }
  1714. /**
  1715. * Returns matter creations options as an array, usable as the choices for a form.
  1716. *
  1717. * @return array
  1718. */
  1719. public static function getMatterCreationProcessOptions(): array
  1720. {
  1721. $matterCreationProcessOptions = self::getConstantsWithLabelsAsChoices('MATTER_CREATION_PROCESS');
  1723. return array_flip($matterCreationProcessOptions);
  1724. }
  1726. /**
  1727. * Returns a human readable version of matterCreationProcess.
  1728. *
  1729. * @return string
  1730. */
  1731. public function getMatterCreationProcessName()
  1732. {
  1733. $options = self::getMatterCreationProcessOptions();
  1735. return $options[$this->getMatterCreationProcess()] ?? $this->getMatterCreationProcess();
  1736. }
  1738. /**
  1739. * Get the value of standardIndexHeader
  1740. *
  1741. * @return string|null
  1742. */
  1743. public function getStandardIndexHeader()
  1744. {
  1745. return $this->standardIndexHeader;
  1746. }
  1748. /**
  1749. * Set the value of standardIndexHeader
  1750. *
  1751. * @param string|null $standardIndexHeader
  1752. *
  1753. * @return self
  1754. */
  1755. public function setStandardIndexHeader($standardIndexHeader)
  1756. {
  1757. $this->standardIndexHeader = $standardIndexHeader;
  1759. return $this;
  1760. }
  1762. /**
  1763. * Set canCreateBatchAndSort.
  1764. *
  1765. * @param bool $canCreateBatchAndSort
  1766. *
  1767. * @return Account
  1768. */
  1769. public function setCanCreateBatchAndSort($canCreateBatchAndSort)
  1770. {
  1771. $this->canCreateBatchAndSort = $canCreateBatchAndSort;
  1773. return $this;
  1774. }
  1776. /**
  1777. * Get canCreateBatchAndSort.
  1778. *
  1779. * @return bool
  1780. */
  1781. public function getCanCreateBatchAndSort()
  1782. {
  1783. return $this->canCreateBatchAndSort;
  1784. }
  1786. /**
  1787. * Set matchOptIn.
  1788. *
  1789. * @param string $matchOptIn
  1790. *
  1791. * @return Account
  1792. */
  1793. public function setMatchOptIn(string $matchOptIn): self
  1794. {
  1795. $this->matchOptIn = $matchOptIn;
  1797. return $this;
  1798. }
  1800. /**
  1801. * Get matchOptIn.
  1802. *
  1803. * @return string
  1804. */
  1805. public function getMatchOptIn(): string
  1806. {
  1807. // Treat legacy nulls as an explicit "none" selection so existing rows keep their stored value
  1808. // while the UI and authorisation logic see a normalised default as per acceptance criteria.
  1809. return $this->matchOptIn ?? self::MATCH_OPT_IN_NONE;
  1810. }
  1812. /**
  1813. * Check if match is enabled for this account.
  1814. *
  1815. * @return bool
  1816. */
  1817. public function isMatchEnabled(): bool
  1818. {
  1819. $allowedArray = [
  1820. self::MATCH_OPT_IN_ALL_CLIENT_USERS,
  1821. self::MATCH_OPT_IN_SPECIFIC_USERS,
  1822. ];
  1824. return in_array($this->getMatchOptIn(), $allowedArray);
  1825. }
  1827. /**
  1828. * Check if match opt-in is set to all client users.
  1829. *
  1830. * @return bool
  1831. */
  1832. public function isMatchOptInAllClientUsers(): bool
  1833. {
  1834. return $this->matchOptIn === self::MATCH_OPT_IN_ALL_CLIENT_USERS;
  1835. }
  1837. /**
  1838. * Check if match opt-in is set to specific users.
  1839. *
  1840. * @return bool
  1841. */
  1842. public function isMatchOptInSpecificUsers(): bool
  1843. {
  1844. return $this->matchOptIn === self::MATCH_OPT_IN_SPECIFIC_USERS;
  1845. }
  1847. /**
  1848. * Get defaultMatchOptinOptions
  1849. *
  1850. * @return array
  1851. */
  1852. public static function getDefaultMatchOptinOptions(): array
  1853. {
  1854. return [
  1855. self::MATCH_OPT_IN_NONE => self::MATCH_OPT_IN_NONE__LABEL,
  1856. self::MATCH_OPT_IN_ALL_CLIENT_USERS => self::MATCH_OPT_IN_ALL_CLIENT_USERS__LABEL,
  1857. self::MATCH_OPT_IN_SPECIFIC_USERS => self::MATCH_OPT_IN_SPECIFIC_USERS__LABEL,
  1858. ];
  1859. }
  1861. /**
  1862. * Set insightsOptIn.
  1863. *
  1864. * @param string $insightsOptIn
  1865. *
  1866. * @return Account
  1867. */
  1868. public function setInsightsOptIn(string $insightsOptIn): self
  1869. {
  1870. $this->insightsOptIn = $insightsOptIn;
  1872. return $this;
  1873. }
  1875. /**
  1876. * Get insightsOptIn.
  1877. *
  1878. * @return string
  1879. */
  1880. public function getInsightsOptIn(): string
  1881. {
  1882. return $this->insightsOptIn ?? self::INSIGHTS_OPT_IN_NONE;
  1883. }
  1885. /**
  1886. * Check if MedBrief Insights is enabled for this account.
  1887. *
  1888. * @return bool
  1889. */
  1890. public function isInsightsEnabled(): bool
  1891. {
  1892. $allowedArray = [
  1893. self::INSIGHTS_OPT_IN_ALL_CLIENT_USERS,
  1894. self::INSIGHTS_OPT_IN_SPECIFIC_USERS,
  1895. ];
  1897. return in_array($this->getInsightsOptIn(), $allowedArray);
  1898. }
  1900. /**
  1901. * Check if Insights opt-in is set to all client users.
  1902. *
  1903. * @return bool
  1904. */
  1905. public function isInsightsOptInAllClientUsers(): bool
  1906. {
  1907. return $this->insightsOptIn === self::INSIGHTS_OPT_IN_ALL_CLIENT_USERS;
  1908. }
  1910. /**
  1911. * Check if Insights opt-in is set to specific users.
  1912. *
  1913. * @return bool
  1914. */
  1915. public function isInsightsOptInSpecificUsers(): bool
  1916. {
  1917. return $this->insightsOptIn === self::INSIGHTS_OPT_IN_SPECIFIC_USERS;
  1918. }
  1920. /**
  1921. * Get defaultInsightsOptInOptions.
  1922. *
  1923. * @return array
  1924. */
  1925. public static function getDefaultInsightsOptInOptions(): array
  1926. {
  1927. return [
  1928. self::INSIGHTS_OPT_IN_NONE => self::INSIGHTS_OPT_IN_NONE__LABEL,
  1929. self::INSIGHTS_OPT_IN_ALL_CLIENT_USERS => self::INSIGHTS_OPT_IN_ALL_CLIENT_USERS__LABEL,
  1930. self::INSIGHTS_OPT_IN_SPECIFIC_USERS => self::INSIGHTS_OPT_IN_SPECIFIC_USERS__LABEL,
  1931. ];
  1932. }
  1934. /**
  1935. * getAllowExpertViewUnsortedRecords
  1936. *
  1937. * @return bool
  1938. */
  1939. public function getAllowExpertViewUnsortedRecords(): bool
  1940. {
  1941. return $this->allowExpertViewUnsortedRecords;
  1942. }
  1944. /**
  1945. * @param bool $allowExpertViewUnsortedRecords
  1946. *
  1947. * @return self
  1948. */
  1949. public function setAllowExpertViewUnsortedRecords(bool $allowExpertViewUnsortedRecords): self
  1950. {
  1951. $this->allowExpertViewUnsortedRecords = $allowExpertViewUnsortedRecords;
  1953. return $this;
  1954. }
  1956. /**
  1957. * @return bool
  1958. */
  1959. public function getMatterClosureQuestionsOptional(): bool
  1960. {
  1961. return $this->matterClosureQuestionsOptional;
  1962. }
  1964. /**
  1965. * @param bool $matterClosureQuestionsOptional
  1966. *
  1967. * @return Account
  1968. */
  1969. public function setMatterClosureQuestionsOptional(bool $matterClosureQuestionsOptional): self
  1970. {
  1971. $this->matterClosureQuestionsOptional = $matterClosureQuestionsOptional;
  1973. return $this;
  1974. }
  1976. /**
  1977. * @return bool|null
  1978. *
  1979. */
  1980. public function getUseParentClinicalSectionsOnly(): ?bool
  1981. {
  1982. return $this->useParentClinicalSectionsOnly;
  1983. }
  1985. /**
  1986. * @param bool $useParentClinicalSectionsOnly
  1987. *
  1988. * @return self
  1989. *
  1990. */
  1991. public function setUseParentClinicalSectionsOnly(bool $useParentClinicalSectionsOnly): self
  1992. {
  1993. $this->useParentClinicalSectionsOnly = $useParentClinicalSectionsOnly;
  1995. return $this;
  1996. }
  1998. public function getFirm(): ?Firm
  1999. {
  2000. return $this->firm;
  2001. }
  2003. public function setFirm(?Firm $firm): self
  2004. {
  2005. $this->firm = $firm;
  2007. return $this;
  2008. }
  2010. /**
  2011. * @return bool
  2012. */
  2013. public function getHideLogoFromIndex(): bool
  2014. {
  2015. return $this->hideLogoFromIndex;
  2016. }
  2018. /**
  2019. * @param bool $hideLogoFromIndex
  2020. *
  2021. * @return self
  2022. */
  2023. public function setHideLogoFromIndex(bool $hideLogoFromIndex): self
  2024. {
  2025. $this->hideLogoFromIndex = $hideLogoFromIndex;
  2027. return $this;
  2028. }
  2030. /**
  2031. * @return array|null
  2032. *
  2033. */
  2034. public function getAllowedMatterTypes(): ?array
  2035. {
  2036. return $this->allowedMatterTypes;
  2037. }
  2039. /**
  2040. * @param array|null $allowedMatterTypes
  2041. *
  2042. * @return self
  2043. *
  2044. */
  2045. public function setAllowedMatterTypes(?array $allowedMatterTypes): self
  2046. {
  2047. $this->allowedMatterTypes = $allowedMatterTypes;
  2049. return $this;
  2050. }
  2052. /**
  2053. * @return array
  2054. */
  2055. public static function getAllowedMatterTypeOptions(): array
  2056. {
  2057. return self::getConstantsWithLabelsAsChoices('MATTER_TYPE');
  2058. }
  2060. /**
  2061. * @return Collection<int, LicenceRenewalTerm>
  2062. */
  2063. public function getLicenceRenewalTerms(): Collection
  2064. {
  2065. return $this->licenceRenewalTerms;
  2066. }
  2068. /**
  2069. * @return Collection<int, LicenceRenewalTerm>
  2070. */
  2071. public function getZeroPeriodLicenceRenewalTerms(): Collection
  2072. {
  2073. return $this->licenceRenewalTerms->filter(function ($term) {
  2074. return $term->getPeriod() === 0;
  2075. });
  2076. }
  2078. /**
  2079. * @param LicenceRenewalTerm $licenceRenewalTerm
  2080. *
  2081. * @return self
  2082. */
  2083. public function addLicenceRenewalTerm(LicenceRenewalTerm $licenceRenewalTerm): self
  2084. {
  2085. if (!$this->licenceRenewalTerms->contains($licenceRenewalTerm)) {
  2086. $this->licenceRenewalTerms[] = $licenceRenewalTerm;
  2087. $licenceRenewalTerm->setAccount($this);
  2088. }
  2090. return $this;
  2091. }
  2093. /**
  2094. * @param LicenceRenewalTerm $licenceRenewalTerm
  2095. *
  2096. * @return self
  2097. */
  2098. public function removeLicenceRenewalTerm(LicenceRenewalTerm $licenceRenewalTerm): self
  2099. {
  2100. if ($this->licenceRenewalTerms->removeElement($licenceRenewalTerm)) {
  2101. // set the owning side to null (unless already changed)
  2102. if ($licenceRenewalTerm->getAccount() === $this) {
  2103. $licenceRenewalTerm->setAccount(null);
  2104. }
  2105. }
  2107. return $this;
  2108. }
  2110. /**
  2111. * @return bool|null
  2112. */
  2113. public function isEnforceTwoFactorAuth(): ?bool
  2114. {
  2115. return $this->enforceTwoFactorAuth;
  2116. }
  2118. /**
  2119. * @param bool $enforceTwoFactorAuth
  2120. *
  2121. * @return self
  2122. */
  2123. public function setEnforceTwoFactorAuth(bool $enforceTwoFactorAuth): self
  2124. {
  2125. $this->enforceTwoFactorAuth = $enforceTwoFactorAuth;
  2127. return $this;
  2128. }
  2130. /**
  2131. * @return bool|null
  2132. */
  2133. public function isAllowTwoFactorAuthGracePeriod(): ?bool
  2134. {
  2135. return $this->allowTwoFactorAuthGracePeriod;
  2136. }
  2138. /**
  2139. * @param bool $allowTwoFactorAuthGracePeriod
  2140. *
  2141. * @return self
  2142. */
  2143. public function setAllowTwoFactorAuthGracePeriod(bool $allowTwoFactorAuthGracePeriod): self
  2144. {
  2145. $this->allowTwoFactorAuthGracePeriod = $allowTwoFactorAuthGracePeriod;
  2147. return $this;
  2148. }
  2150. /**
  2151. * Checks if the client is not liable for the disclosure fee.
  2152. *
  2153. * @return bool True if the client is not liable, false otherwise.
  2154. */
  2155. public function isClientNotLiableForDisclosureFee(): bool
  2156. {
  2157. return $this->clientNotLiableForDisclosureFee;
  2158. }
  2160. /**
  2161. * Sets whether the client is not liable for the disclosure fee.
  2162. *
  2163. * @param bool $clientNotLiableForDisclosureFee True if the client is not liable, false otherwise.
  2164. *
  2165. * @return self
  2166. */
  2167. public function setClientNotLiableForDisclosureFee(bool $clientNotLiableForDisclosureFee): self
  2168. {
  2169. $this->clientNotLiableForDisclosureFee = $clientNotLiableForDisclosureFee;
  2171. return $this;
  2172. }
  2174. /**
  2175. * Returns an array of permitted values for the country of registration field and their
  2176. * associated labels.
  2177. *
  2178. * @return array
  2179. */
  2180. public static function getCountryOfRegistrationOptions()
  2181. {
  2182. return [
  2183. self::COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES => self::COUNTRY_OF_REGISTRATION_ENGLAND_AND_WALES__LABEL,
  2184. self::COUNTRY_OF_REGISTRATION_SCOTLAND => self::COUNTRY_OF_REGISTRATION_SCOTLAND__LABEL,
  2185. self::COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND => self::COUNTRY_OF_REGISTRATION_NORTHERN_IRELAND__LABEL,
  2186. ];
  2187. }
  2189. /**
  2190. * Get trading_name.
  2191. *
  2192. * @return string|null
  2193. */
  2194. public function getTradingName(): ?string
  2195. {
  2196. return $this->trading_name;
  2197. }
  2199. /**
  2200. * Set trading_name.
  2201. *
  2202. * @param string|null $trading_name
  2203. *
  2204. * @return self
  2205. */
  2206. public function setTradingName(?string $trading_name): self
  2207. {
  2208. $this->trading_name = $trading_name;
  2210. return $this;
  2211. }
  2213. /**
  2214. * Get company_registration_number.
  2215. *
  2216. * @return string|null
  2217. */
  2218. public function getCompanyRegistrationNumber(): ?string
  2219. {
  2220. return $this->company_registration_number;
  2221. }
  2223. /**
  2224. * Set company_registration_number.
  2225. *
  2226. * @param string|null $company_registration_number
  2227. *
  2228. * @return self
  2229. */
  2230. public function setCompanyRegistrationNumber(?string $company_registration_number): self
  2231. {
  2232. $this->company_registration_number = $company_registration_number;
  2234. return $this;
  2235. }
  2237. /**
  2238. * Get country_of_registration.
  2239. *
  2240. * @return string|null
  2241. */
  2242. public function getCountryOfRegistration(): ?string
  2243. {
  2244. return $this->country_of_registration;
  2245. }
  2247. /**
  2248. * Set country_of_registration.
  2249. *
  2250. * @param string|null $country_of_registration
  2251. *
  2252. * @return self
  2253. */
  2254. public function setCountryOfRegistration(?string $country_of_registration): self
  2255. {
  2256. $this->country_of_registration = $country_of_registration;
  2258. return $this;
  2259. }
  2261. /**
  2262. * Returns a human-readable version of the country of registration
  2263. *
  2264. * @return string
  2265. */
  2266. public function getCountryOfRegistrationName()
  2267. {
  2268. $options = self::getCountryOfRegistrationOptions();
  2270. return $options[$this->getCountryOfRegistration()] ?? $this->getCountryOfRegistration();
  2271. }
  2272. }