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

Open in your IDE?
  1. <?php
  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;
  9. /**
  10.  * GoogleToken.
  11.  */
  12. #[ORM\Entity]
  13. #[ORM\Table(name: 'google_token')]
  14. #[ORM\Index(name: 'got_token', columns: ['got_token'])]
  15. #[ORM\Index(name: 'got_m_id', columns: ['got_m_id'])]
  16. #[ORM\UniqueConstraint(name: 'got_account_id__m_id', columns: ['got_account_id', 'got_m_id'])]
  17. class GoogleToken
  18. {
  19.     /**
  20.      * @var int
  21.      */
  22.     #[ORM\Column(name: 'got_id', type: 'integer', nullable: false, options: ['unsigned' => true])]
  23.     #[ORM\Id]
  24.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  25.     private $id;
  27.     /**
  28.      * @var Member
  29.      */
  30.     #[ORM\ManyToOne(targetEntity: Member::class)]
  31.     #[ORM\JoinColumn(name: 'got_m_id', referencedColumnName: 'm_id', nullable: true)]
  32.     private $member;
  34.     /**
  35.      * @var Collection|User[]
  36.      */
  37.     #[ORM\ManyToMany(targetEntity: User::class, inversedBy: 'googleTokens')]
  38.     #[ORM\JoinTable(name: 'google_token_users', joinColumns: [new ORM\JoinColumn(name: 'gotu_got_id', referencedColumnName: 'got_id', onDelete: 'CASCADE')], inverseJoinColumns: [new ORM\JoinColumn(name: 'gotu_u_id', referencedColumnName: 'u_id', onDelete: 'CASCADE')])]
  39.     private $users;
  41.     /**
  42.      * @deprecated Kept for Doctrine mapping purposes, use $users collection instead
  43.      *
  44.      * @var User|null
  45.      */
  46.     #[ORM\Column(name: 'got_u_id', type: 'integer', nullable: true, options: ['unsigned' => true])]
  47.     private $user;
  49.     /**
  50.      * @var string
  51.      */
  52.     #[ORM\Column(name: 'got_account_id', type: 'string', length: 32, nullable: false)]
  53.     private $accountId;
  55.     /**
  56.      * @var string
  57.      */
  58.     #[ORM\Column(name: 'got_token', type: 'text', length: 16777215, nullable: false)]
  59.     private $token;
  61.     /**
  62.      * @var string|null
  63.      */
  64.     #[ORM\Column(name: 'got_refresh_token', type: 'text', length: 16777215, nullable: true)]
  65.     private $refreshToken;
  67.     /**
  68.      * @var string|null
  69.      */
  70.     #[ORM\Column(name: 'got_token_owner_display_name', type: 'string', length: 255, nullable: true)]
  71.     private $tokenOwnerDisplayName;
  73.     /**
  74.      * @var string|null
  75.      */
  76.     #[ORM\Column(name: 'got_token_owner_email', type: 'binary_aes_encrypted', precision: 0, scale: 0, nullable: true, unique: false)]
  77.     private $tokenOwnerEmail;
  79.     /**
  80.      * @var \DateTime|null
  81.      */
  82.     #[ORM\Column(name: 'got_token_expiry', type: 'datetime', nullable: true)]
  83.     private $tokenExpiry;
  85.     /**
  86.      * @var \DateTime|null
  87.      */
  88.     #[ORM\Column(name: 'got_token_last_checked', type: 'datetime', nullable: true)]
  89.     private $tokenLastChecked;
  91.     /**
  92.      * @var bool|null
  93.      */
  94.     #[ORM\Column(name: 'got_error', type: 'boolean', nullable: true)]
  95.     private $error = false;
  97.     /**
  98.      * @var bool|null
  99.      */
  100.     #[ORM\Column(name: 'got_deleted', type: 'boolean', nullable: true)]
  101.     private $deleted = false;
  103.     /**
  104.      * @var bool|null
  105.      */
  106.     #[ORM\Column(name: 'got_login_enabled', type: 'boolean', nullable: true, options: ['default' => '1'])]
  107.     private $loginEnabled = true;
  109.     #[ORM\OneToMany(targetEntity: Google::class, mappedBy: 'googleToken')]
  110.     private $googleEntities;
  112.     #[ORM\OneToMany(targetEntity: YouTube::class, mappedBy: 'googleToken')]
  113.     private $youtubeEntities;
  115.     public function __construct(?Member $member, string $token, string $refreshToken, string $tokenOwnerDisplayName, ?string $tokenOwnerEmail = null, ?string $accountId = null, ?User $user = null)
  116.     {
  117.         $this->member = $member;
  118.         $this->accountId = $accountId;
  119.         $this->token = $token;
  120.         $this->refreshToken = $refreshToken;
  121.         $this->tokenOwnerDisplayName = $tokenOwnerDisplayName;
  122.         $this->tokenOwnerEmail = $tokenOwnerEmail;
  123.         $this->users = new ArrayCollection();
  124.         if ($user !== null)
  125.         {
  126.             $this->addUser($user);
  127.         }
  128.         $this->googleEntities = new ArrayCollection();
  129.         $this->youtubeEntities = new ArrayCollection();
  130.     }
  132.     public function getId(): ?int
  133.     {
  134.         return $this->id;
  135.     }
  137.     public function getMember(): ?Member
  138.     {
  139.         return $this->member;
  140.     }
  142.     // If a member has already been set, do not disassociate said member from the Google Token.
  143.     public function setMember(Member $member): self
  144.     {
  145.         $this->member = $member;
  147.         return $this;
  148.     }
  150.     /**
  151.      * @return Collection|User[]
  152.      */
  153.     public function getUsers(): Collection
  154.     {
  155.         return $this->users;
  156.     }
  158.     public function addUser(User $user): self
  159.     {
  160.         if (!$this->users->contains($user))
  161.         {
  162.             $this->users->add($user);
  163.         }
  165.         return $this;
  166.     }
  168.     public function removeUser(User $user): self
  169.     {
  170.         $this->users->removeElement($user);
  172.         return $this;
  173.     }
  175.     public function getAccountId(): string
  176.     {
  177.         return $this->accountId;
  178.     }
  180.     public function setAccountId(string $accountId): self
  181.     {
  182.         $this->accountId = $accountId;
  184.         return $this;
  185.     }
  187.     public function getToken(): string
  188.     {
  189.         return $this->token;
  190.     }
  192.     public function setToken(string $token): self
  193.     {
  194.         $this->token = $token;
  196.         return $this;
  197.     }
  199.     public function getRefreshToken(): string
  200.     {
  201.         return $this->refreshToken;
  202.     }
  204.     public function setRefreshToken(string $refreshToken): self
  205.     {
  206.         $this->refreshToken = $refreshToken;
  208.         return $this;
  209.     }
  211.     public function getTokenOwnerDisplayName(): ?string
  212.     {
  213.         return $this->tokenOwnerDisplayName;
  214.     }
  216.     public function setTokenOwnerDisplayName(?string $tokenOwnerDisplayName): self
  217.     {
  218.         $this->tokenOwnerDisplayName = $tokenOwnerDisplayName;
  220.         return $this;
  221.     }
  223.     public function getTokenOwnerEmail(): ?string
  224.     {
  225.         return $this->tokenOwnerEmail;
  226.     }
  228.     public function setTokenOwnerEmail(?string $tokenOwnerEmail): self
  229.     {
  230.         $this->tokenOwnerEmail = $tokenOwnerEmail;
  232.         return $this;
  233.     }
  235.     public function getTokenExpiry(): ?\DateTimeInterface
  236.     {
  237.         return $this->tokenExpiry;
  238.     }
  240.     public function setTokenExpiry(?\DateTimeInterface $tokenExpiry): self
  241.     {
  242.         $this->tokenExpiry = $tokenExpiry;
  244.         return $this;
  245.     }
  247.     public function getTokenLastChecked(): ?\DateTimeInterface
  248.     {
  249.         return $this->tokenLastChecked;
  250.     }
  252.     public function setTokenLastChecked(?\DateTimeInterface $tokenLastChecked): self
  253.     {
  254.         $this->tokenLastChecked = $tokenLastChecked;
  256.         return $this;
  257.     }
  259.     public function hasError(): bool
  260.     {
  261.         return $this->error;
  262.     }
  264.     public function setError(bool $error): self
  265.     {
  266.         $this->error = $error;
  268.         return $this;
  269.     }
  271.     public function isDeleted(): bool
  272.     {
  273.         return $this->deleted;
  274.     }
  276.     public function setDeleted(bool $deleted): self
  277.     {
  278.         $this->deleted = $deleted;
  280.         return $this;
  281.     }
  283.     public function isLoginEnabled(): bool
  284.     {
  285.         return $this->loginEnabled;
  286.     }
  288.     public function setLoginEnabled(bool $loginEnabled): self
  289.     {
  290.         $this->loginEnabled = $loginEnabled;
  292.         return $this;
  293.     }
  295.     /**
  296.      * Get all connected Google social profiles for this google account/user token.
  297.      *
  298.      * @param bool $onlyActive
  299.      *   If it should filter out all deleted profiles.
  300.      *
  301.      * @return \Doctrine\Common\Collections\Collection<GoogleSocialProfile>
  302.      */
  303.     public function getGoogleSocialProfiles(bool $onlyActive = false): Collection
  304.     {
  305.         return $this->googleEntities
  306.             ->filter(fn (Google $googleEntity): bool => !$onlyActive || !$googleEntity->isDeleted())
  307.             ->map(fn (Google $googleEntity): GoogleSocialProfile => $googleEntity->getSocialProfile());
  308.     }
  310.     /**
  311.      * Get all connected YouTube social profiles for this google account/user token.
  312.      *
  313.      * @param bool $onlyActive
  314.      *   If it should filter out all deleted profiles.
  315.      *
  316.      * @return \Doctrine\Common\Collections\Collection<YouTubeSocialProfile>
  317.      */
  318.     public function getYouTubeSocialProfiles(bool $onlyActive = false): Collection
  319.     {
  320.         return $this->youtubeEntities
  321.             ->filter(fn (YouTube $youtubeEntity): bool => !$onlyActive || !$youtubeEntity->isDeleted())
  322.             ->map(fn (YouTube $youtubeEntity): YouTubeSocialProfile => $youtubeEntity->getSocialProfile());
  323.     }
  325.     public function addGoogleEntity(Google $accountEntity): self
  326.     {
  327.         if (!$this->googleEntities->contains($accountEntity))
  328.         {
  329.             $this->googleEntities->add($accountEntity);
  330.         }
  331.         return $this;
  332.     }
  334.     public function removeGoogleEntity(Google $accountEntity): self
  335.     {
  336.         $this->googleEntities->removeElement($accountEntity);
  337.         return $this;
  338.     }
  340.     public function addYouTubeEntity(YouTube $accountEntity): self
  341.     {
  342.         if (!$this->youtubeEntities->contains($accountEntity))
  343.         {
  344.             $this->youtubeEntities->add($accountEntity);
  345.         }
  346.         return $this;
  347.     }
  349.     public function removeYouTubeEntity(YouTube $accountEntity): self
  350.     {
  351.         $this->youtubeEntities->removeElement($accountEntity);
  352.         return $this;
  353.     }
  355.     /**
  356.      * Is the Google token expired? If so, we will need to request a new one using the refresh token.
  357.      *
  358.      * @return bool
  359.      */
  360.     public function isTokenExpired(): bool
  361.     {
  362.         return $this->tokenExpiry < server_datetime();
  363.     }
  364. }