app/Entity/Schema/ORM/Organization.php line 17

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Sq\Entity\Schema\ORM;
  5. use Doctrine\Common\Collections\ArrayCollection;
  6. use Doctrine\Common\Collections\Collection;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use ReflectionClass;
  9. use Sq\Entity\Schema\Column\OrganizationBillingCycle;
  10. use Sq\Entity\Schema\Column\OrganizationSubscriptionStatus;
  11. use Sq\Entity\Schema\Column\OrganizationSuspended;
  12. use Sq\Service\Repository\ORM\OrganizationRepository;
  13. use Symfony\Component\Uid\Uuid;
  15. #[ORM\Entity(repositoryClass: OrganizationRepository::class)]
  16. #[ORM\Table(name: 'organizations')]
  17. class Organization
  18. {
  19.     /**
  20.      *
  21.      * @var int|null
  22.      */
  23.     #[ORM\Id]
  24.     #[ORM\GeneratedValue(strategy: 'AUTO')]
  25.     #[ORM\Column(name: 'o_id', type: 'integer', nullable: false, options: ['unsigned' => true])]
  26.     private $id;
  28.     /**
  29.      *
  30.      * @var Member
  31.      */
  32.     #[ORM\OneToOne(targetEntity: Member::class, inversedBy: 'organization', fetch: 'EAGER', cascade: ['persist'])]
  33.     #[ORM\JoinColumn(name: 'o_m_id', referencedColumnName: 'm_id', nullable: false)]
  34.     private $legacyMember;
  36.     /**
  37.      * @var string
  38.      */
  39.     #[ORM\Column(name: 'o_name', type: 'string', nullable: false)]
  40.     private $name;
  42.     /**
  43.      * @var Collection
  44.      */
  45.     #[ORM\OneToMany(targetEntity: Workspace::class, mappedBy: 'organization', fetch: 'LAZY', cascade: ['persist'])]
  46.     private $workspaces;
  48.     /**
  49.      * @var OrganizationSettings
  50.      */
  51.     #[ORM\OneToOne(targetEntity: OrganizationSettings::class, mappedBy: 'organization', cascade: ['persist'])]
  52.     private $settings;
  54.     /**
  55.      * @var Collection
  56.      */
  57.     #[ORM\OneToMany(targetEntity: UserOrganizationAssignment::class, mappedBy: 'organization', fetch: 'LAZY', orphanRemoval: true)]
  58.     private $userAssignments;
  60.     /**
  61.      * @var Collection
  62.      */
  63.     #[ORM\OneToMany(targetEntity: UserInvitation::class, mappedBy: 'organization', fetch: 'LAZY')]
  64.     private $userInvitations;
  66.     /**
  67.     * @var Collection<Bitly>
  68.     */
  69.     #[ORM\OneToMany(targetEntity: Bitly::class, mappedBy: 'organization', fetch: 'LAZY')]
  70.     private $bitlyAccounts;
  72.     /**
  73.      * @var string|null
  74.      */
  75.     #[ORM\Column(name: 'o_sub_status', type: 'string', nullable: false, options: ['default' => 'trial'])]
  76.     private $subscriptionStatus = OrganizationSubscriptionStatus::TRIAL;
  78.     /**
  79.      * @var string|null
  80.      */
  81.     #[ORM\Column(name: 'o_subscription_extid', type: 'integer', nullable: true)]
  82.     private $subscriptionExternalId;
  84.     /**
  85.      * @var BillingDetails|null
  86.      */
  87.     #[ORM\OneToOne(targetEntity: BillingDetails::class, mappedBy: 'organization')]
  88.     private $billingDetails;
  90.     /**
  91.      * @var string
  92.      */
  93.     #[ORM\Column(name: 'o_billing_cycle', type: 'string', nullable: false, options: ['default' => 'monthly'])]
  94.     private $billingCycle = OrganizationBillingCycle::MONTHLY;
  96.     /**
  97.      * @var \DateTimeInterface|null
  98.      */
  99.     #[ORM\Column(name: 'o_trial_expiry_local_date', type: 'date', nullable: true)]
  100.     private $trialExpiryLocalDate;
  102.     /**
  103.      * @var \DateTimeInterface|null
  104.      */
  105.     #[ORM\Column(name: 'o_next_billing_date', type: 'date', nullable: true)]
  106.     private $nextBillingDate;
  108.     /**
  109.      * @var string|null
  110.      */
  111.     #[ORM\Column(name: 'o_next_bill_amount', type: 'decimal', precision: 8, scale: 2, nullable: true, options: ['default' => '0.00'])]
  112.     private $nextBillAmount = '0.00';
  114.     /**
  115.      * @var string|null
  116.      */
  117.     #[ORM\Column(name: 'o_balance', type: 'decimal', precision: 15, scale: 2, nullable: true, options: ['default' => '0.00'])]
  118.     private $balance = '0.00';
  120.     /**
  121.      * @var string|null
  122.      */
  123.     #[ORM\Column(name: 'o_currency', type: 'string', length: 3, nullable: true)]
  124.     private $currency;
  126.     /**
  127.      * @var \DateTimeInterface|null
  128.      */
  129.     #[ORM\Column(name: 'o_date_activated', type: 'datetime', nullable: true)]
  130.     private $dateActivated;
  132.     /**
  133.      * @var \DateTimeInterface|null
  134.      */
  135.     #[ORM\Column(name: 'o_date_upgraded', type: 'datetime', nullable: true)]
  136.     private $dateUpgraded;
  138.     /**
  139.      * @var string|null
  140.      */
  141.     #[ORM\Column(name: 'o_country_code', type: 'string', length: 2, nullable: true)]
  142.     private $countryCode;
  144.     /**
  145.      * @var int
  146.      */
  147.     #[ORM\Column(name: 'o_plan_id', type: 'smallint', nullable: false, options: ['default' => 1, 'unsigned' => true])]
  148.     private $planId = 1;
  150.     /**
  151.      * @var int|null
  152.      */
  153.     #[ORM\Column(name: 'o_plan_group', type: 'smallint', nullable: true, options: ['default' => 3, 'unsigned' => true])]
  154.     private $planGroup = 4;
  156.     /**
  157.      * @var int|null
  158.      */
  159.     #[ORM\Column(name: 'o_addon_group', type: 'smallint', nullable: true, options: ['default' => 1, 'unsigned' => true])]
  160.     private $addonGroup = 2;
  162.     /**
  163.      * @var bool|null
  164.      */
  165.     #[ORM\Column(name: 'o_custom_plans', type: 'boolean', nullable: true, options: ['default' => 1])]
  166.     private $customPlans = true;
  168.     /**
  169.      * @var int|null
  170.      */
  171.     #[ORM\Column(name: 'o_onboarding', type: 'smallint', nullable: true, options: ['default' => 1])]
  172.     private $onboarding = 1;
  174.     /**
  175.      * @var bool|null
  176.      */
  177.     #[ORM\Column(name: 'o_early_upgrade_offer', type: 'boolean', nullable: true, options: ['default' => false])]
  178.     private $earlyUpgradeOffer = false;
  180.     /**
  181.      * @var int|null
  182.      */
  183.     #[ORM\Column(name: 'o_pricing_design', type: 'integer', nullable: true, options: ['default' => 1])]
  184.     private $pricingDesign = 2;
  186.     /**
  187.      * @var string|null
  188.      */
  189.     #[ORM\Column(name: 'o_ref', type: 'string', length: 45, nullable: true)]
  190.     private $ref;
  192.     /**
  193.      * @var bool|null
  194.      */
  195.     #[ORM\Column(name: 'o_ref_gift', type: 'boolean', nullable: true, options: ['default' => false])]
  196.     private $refGift = false;
  198.     /**
  199.      * @var int|null
  200.      */
  201.     #[ORM\Column(name: 'o_suspended', type: 'integer', nullable: true, options: ['default' => 0])]
  202.     private $suspended = OrganizationSuspended::ACTIVE;
  204.     public function __construct(
  205.         string $name,
  206.         string $email,
  207.         string $timezone,
  208.         ?string $countryCode,
  209.         string $billingCycle = 'monthly',
  210.         int $trialLength = 14,
  211.         ?\DateTimeInterface $firstVisit = null,
  212.     ) {
  213.         $name = trim($name);
  214.         $this->name = $name;
  215.         $this->legacyMember = new Member(
  216.             username: Uuid::v4()->toRfc4122(), // Not used for anything for overhaul, but cant be null.
  217.             email: $email,
  218.             firstName: $name,
  219.             timezone: $timezone,
  220.             countryCode: $countryCode,
  221.             billingCycle: $billingCycle,
  222.             trialLength: $trialLength,
  223.             organization: $this,
  224.             firstVisit: $firstVisit
  225.         );
  226.         $this->legacyMember->skipOnboarding();
  227.         $this->legacyMember->setInOverhaul(true);
  228.         $this->createDefaultsForNewInstance();
  229.     }
  231.     private function createDefaultsForNewInstance(): self
  232.     {
  233.         $this->settings = new OrganizationSettings($this);
  234.         $this->userAssignments = new ArrayCollection;
  235.         $this->userInvitations = new ArrayCollection;
  236.         $this->workspaces = new ArrayCollection;
  237.         $this->bitlyAccounts = new ArrayCollection;
  238.         return $this;
  239.     }
  241.     /**
  242.      * @throws \ReflectionException
  243.      */
  244.     public static function createForExistingLegacyMember(Member $member): Organization
  245.     {
  246.         $org = (new ReflectionClass(static::class))
  247.             ->newInstanceWithoutConstructor()
  248.             ->createDefaultsForNewInstance();
  249.         $org->name = $member->getBusiness()?->getCompany() ?? "Default Organization for " . $member->getFirstName();
  250.         $org->legacyMember = $member;
  251.         return $org;
  252.     }
  254.     public function getId(): ?int
  255.     {
  256.         return $this->id;
  257.     }
  259.     /**
  260.      * Every org has a member entity for billing/subscription purposes.
  261.      */
  262.     public function getLegacyMember(): Member
  263.     {
  264.         return $this->legacyMember;
  265.     }
  267.     public function getName(): string
  268.     {
  269.         return $this->name;
  270.     }
  272.     public function setName(string $name): self
  273.     {
  274.         $this->name = trim($name);
  275.         return $this;
  276.     }
  278.     public function getSettings(): OrganizationSettings
  279.     {
  280.         return $this->settings;
  281.     }
  283.     /**
  284.      * @return Collection|Workspace[]
  285.      */
  286.     public function getWorkspaces(bool $includeDeleted = false): Collection
  287.     {
  288.         if ($includeDeleted)
  289.         {
  290.             return $this->workspaces;
  291.         }
  293.         return $this->workspaces->filter(
  294.             fn (Workspace $workspace): bool => !$workspace->isDeleted()
  295.         );
  296.     }
  298.     public function addWorkspace(Workspace $workspace): self
  299.     {
  300.         if (!$this->workspaces->contains($workspace))
  301.         {
  302.             $this->workspaces->add($workspace);
  303.         }
  304.         return $this;
  305.     }
  307.     public function removeWorkspace(Workspace $workspace): self
  308.     {
  309.         if ($this->workspaces->contains($workspace))
  310.         {
  311.             $this->workspaces->removeElement($workspace);
  312.         }
  313.         return $this;
  314.     }
  316.     /**
  317.      * @return Collection|User[]
  318.      */
  319.     public function getUsers(): Collection
  320.     {
  321.         return $this->userAssignments->map(function (UserOrganizationAssignment $assignment): User
  322.         {
  323.             return $assignment->getUser();
  324.         });
  325.     }
  327.     public function getOwner(): User
  328.     {
  329.         return $this->userAssignments
  330.             ->filter(fn (UserOrganizationAssignment $assignment) => $assignment->getRole() === UserOrganizationAssignment::ROLE_OWNER)
  331.             ->first()
  332.             ->getUser();
  333.     }
  335.     public function hasUser(User $user): bool
  336.     {
  337.         return $this->getUsers()->contains($user);
  338.     }
  340.     /**
  341.      * @return Collection<UserOrganizationAssignment>
  342.      */
  343.     public function getUserAssignments(): Collection
  344.     {
  345.         return $this->userAssignments;
  346.     }
  348.     public function getUserAssignment(User $user): ?UserOrganizationAssignment
  349.     {
  350.         $assignments = $this->userAssignments->filter(function (UserOrganizationAssignment $assignment) use ($user)
  351.         {
  352.             return $assignment->getUser() === $user;
  353.         });
  355.         return $assignments->count() > 0 ? $assignments->first() : null;
  356.     }
  358.     public function getUserInvitations(): Collection
  359.     {
  360.         return $this->userInvitations;
  361.     }
  363.     public function addUser(User $user, string $role): self
  364.     {
  365.         $user->addToOrganization($this, $role);
  366.         return $this;
  367.     }
  369.     public function removeUser(User $user): self
  370.     {
  371.         $user->removeFromOrganization($this);
  372.         return $this;
  373.     }
  375.     public function getSubscriptionStatus(): ?string
  376.     {
  377.         return $this->subscriptionStatus;
  378.     }
  380.     public function setSubscriptionStatus(?string $subscriptionStatus): self
  381.     {
  382.         $this->subscriptionStatus = $subscriptionStatus;
  383.         return $this;
  384.     }
  386.     public function getSubscriptionExternalId(): ?string
  387.     {
  388.         return $this->subscriptionExternalId;
  389.     }
  391.     public function setSubscriptionExternalId(?string $subscriptionExternalId): self
  392.     {
  393.         $this->subscriptionExternalId = $subscriptionExternalId;
  394.         return $this;
  395.     }
  397.     public function getBillingDetails(): ?BillingDetails
  398.     {
  399.         return $this->billingDetails;
  400.     }
  402.     public function getBillingCycle(): string
  403.     {
  404.         return $this->billingCycle;
  405.     }
  407.     public function setBillingCycle(string $billingCycle): self
  408.     {
  409.         $this->billingCycle = $billingCycle;
  410.         return $this;
  411.     }
  413.     public function getTrialExpiryLocalDate(): ?\DateTimeInterface
  414.     {
  415.         return $this->trialExpiryLocalDate !== null
  416.             ? clone $this->trialExpiryLocalDate
  417.             : null;
  418.     }
  420.     public function setTrialExpiryLocalDate(?\DateTimeInterface $trialExpiryLocalDate): self
  421.     {
  422.         $this->trialExpiryLocalDate = $trialExpiryLocalDate !== null ? clone $trialExpiryLocalDate : null;
  423.         return $this;
  424.     }
  426.     public function getNextBillingDate(): ?\DateTimeInterface
  427.     {
  428.         return $this->nextBillingDate !== null
  429.             ? clone $this->nextBillingDate
  430.             : null;
  431.     }
  433.     public function setNextBillingDate(?\DateTimeInterface $nextBillingDate): self
  434.     {
  435.         $this->nextBillingDate = $nextBillingDate !== null ? clone $nextBillingDate : null;
  436.         return $this;
  437.     }
  439.     public function getNextBillAmount(): ?string
  440.     {
  441.         return $this->nextBillAmount;
  442.     }
  444.     public function setNextBillAmount(?string $nextBillAmount): self
  445.     {
  446.         $this->nextBillAmount = $nextBillAmount;
  447.         return $this;
  448.     }
  450.     public function getBalance(): ?string
  451.     {
  452.         return $this->balance;
  453.     }
  455.     public function setBalance(?string $balance): self
  456.     {
  457.         $this->balance = $balance;
  458.         return $this;
  459.     }
  461.     public function getCurrency(): ?string
  462.     {
  463.         return $this->currency;
  464.     }
  466.     public function setCurrency(?string $currency): self
  467.     {
  468.         $this->currency = $currency;
  469.         return $this;
  470.     }
  472.     public function getDateActivated(): ?\DateTimeInterface
  473.     {
  474.         return $this->dateActivated !== null
  475.             ? clone $this->dateActivated
  476.             : null;
  477.     }
  479.     public function setDateActivated(?\DateTimeInterface $dateActivated): self
  480.     {
  481.         $this->dateActivated = $dateActivated !== null ? clone $dateActivated : null;
  482.         return $this;
  483.     }
  485.     public function getDateUpgraded(): ?\DateTimeInterface
  486.     {
  487.         return $this->dateUpgraded !== null
  488.             ? clone $this->dateUpgraded
  489.             : null;
  490.     }
  492.     public function setDateUpgraded(?\DateTimeInterface $dateUpgraded): self
  493.     {
  494.         $this->dateUpgraded = $dateUpgraded !== null ? clone $dateUpgraded : null;
  495.         return $this;
  496.     }
  498.     public function getCountryCode(): ?string
  499.     {
  500.         return $this->countryCode;
  501.     }
  503.     public function setCountryCode(?string $countryCode): self
  504.     {
  505.         $this->countryCode = $countryCode;
  506.         return $this;
  507.     }
  509.     public function getAddonGroup(): ?int
  510.     {
  511.         return $this->addonGroup;
  512.     }
  514.     public function setAddonGroup(?int $addonGroup): self
  515.     {
  516.         $this->addonGroup = $addonGroup;
  517.         return $this;
  518.     }
  520.     public function hasCustomPlans(): ?bool
  521.     {
  522.         return $this->customPlans;
  523.     }
  525.     public function setCustomPlans(?bool $customPlans): self
  526.     {
  527.         $this->customPlans = $customPlans;
  528.         return $this;
  529.     }
  531.     public function getOnboardingVersion(): int
  532.     {
  533.         return $this->onboarding ?? 1; // TODO Default to the minimum available onboarding version.
  534.     }
  536.     public function setOnboardingVersion(int $onboarding): self
  537.     {
  538.         $this->onboarding = $onboarding;
  539.         return $this;
  540.     }
  542.     public function isEarlyUpgradeOffer(): ?bool
  543.     {
  544.         return $this->earlyUpgradeOffer;
  545.     }
  547.     public function setEarlyUpgradeOffer(?bool $earlyUpgradeOffer): self
  548.     {
  549.         $this->earlyUpgradeOffer = $earlyUpgradeOffer;
  550.         return $this;
  551.     }
  553.     public function getPricingDesign(): ?int
  554.     {
  555.         return $this->pricingDesign;
  556.     }
  558.     public function setPricingDesign(?int $pricingDesign): self
  559.     {
  560.         $this->pricingDesign = $pricingDesign;
  561.         return $this;
  562.     }
  564.     public function getRef(): ?string
  565.     {
  566.         return $this->ref;
  567.     }
  569.     public function setRef(?string $ref): self
  570.     {
  571.         $this->ref = $ref;
  572.         return $this;
  573.     }
  575.     public function isRefGift(): ?bool
  576.     {
  577.         return $this->refGift;
  578.     }
  580.     public function setRefGift(?bool $refGift): self
  581.     {
  582.         $this->refGift = $refGift;
  583.         return $this;
  584.     }
  586.     public function isSuspended(): ?int
  587.     {
  588.         return $this->suspended;
  589.     }
  591.     public function setSuspended(?int $suspended): self
  592.     {
  593.         $this->suspended = $suspended;
  594.         return $this;
  595.     }
  597.     public function getPlan(): Plan
  598.     {
  599.         return $this->getLegacyMember()->getPlan();
  600.     }
  602.     public function changePlan(Plan $plan): self
  603.     {
  604.         $this->getLegacyMember()->changePlan($plan);
  605.         return $this;
  606.     }
  608.     /**
  609.      * @return Collection|Bitly[]
  610.      */
  611.     public function getBitlyAccounts(): Collection
  612.     {
  613.         return $this->bitlyAccounts;
  614.     }
  615. }