src/Entity/Activity.php line 39

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity;
  7. use App\Contracts\Activity\ActivityBoostStatus;
  8. use App\Contracts\Activity\Status;
  9. use App\Contracts\Platform\Platform;
  10. use App\Entity\Lite\CreatorLite;
  11. use App\Repository\ActivityRepository;
  12. use App\Services\DraftCampaign\Contract\DraftVideoStatus;
  13. use DateTime;
  14. use DateTimeImmutable;
  15. use Doctrine\Common\Collections\ArrayCollection;
  16. use Doctrine\Common\Collections\Collection;
  17. use Doctrine\Common\Collections\Criteria;
  18. use Doctrine\ORM\Mapping\Column;
  19. use Doctrine\ORM\Mapping\Entity;
  20. use Doctrine\ORM\Mapping\GeneratedValue;
  21. use Doctrine\ORM\Mapping\HasLifecycleCallbacks;
  22. use Doctrine\ORM\Mapping\Id;
  23. use Doctrine\ORM\Mapping\Index;
  24. use Doctrine\ORM\Mapping\JoinColumn;
  25. use Doctrine\ORM\Mapping\ManyToOne;
  26. use Doctrine\ORM\Mapping\OneToMany;
  27. use Doctrine\ORM\Mapping\OneToOne;
  28. use Doctrine\ORM\Mapping\PrePersist;
  29. use Doctrine\ORM\Mapping\PreUpdate;
  30. use Doctrine\ORM\Mapping\UniqueConstraint;
  31. use Symfony\Component\String\AbstractString;
  33. use function Symfony\Component\String\s;
  35. #[Entity(ActivityRepository::class)]
  36. #[Index(fields: ['status', 'updatedAt'])]
  37. #[UniqueConstraint('unique_activity', ['creator_id', 'campaign_id'])]
  38. #[HasLifecycleCallbacks]
  39. class Activity
  40. {
  41.     /** @var int */
  42.     private const READ_MORE_LENGTH = 35;
  43.     /** @var int */
  44.     private const DEFAULT_AMOUNT = 0;
  46.     #[Id]
  47.     #[GeneratedValue]
  48.     #[Column('id', 'bigint', options: ['unsigned' => true])]
  49.     private ?int $id = null;
  51.     #[ManyToOne(targetEntity: Creator::class, inversedBy: 'activities')]
  52.     #[JoinColumn(onDelete: 'CASCADE')]
  53.     private Creator|CreatorLite $creator;
  55.     #[Column(
  56.         type: 'bigint',
  57.         options: [
  58.             'unsigned' => true,
  59.             'comment' => 'Field to specify the user responsible for processing the activity',
  60.         ],
  61.     )]
  62.     private ?int $curatorUserId = null;
  64.     #[Column(type: 'datetime_immutable', nullable: true)]
  65.     private ?DateTimeImmutable $curatedAt = null;
  67.     #[ManyToOne(targetEntity: Campaign::class, inversedBy: 'activities')]
  68.     private Campaign $campaign;
  70.     #[OneToOne(targetEntity: Video::class)]
  71.     private ?Video $video = null;
  73.     #[OneToOne(targetEntity: Complaint::class, cascade: ['persist'])]
  74.     #[JoinColumn(onDelete: 'SET NULL')]
  75.     private ?Complaint $complaint = null;
  77.     #[Column(name: 'boost_status', type: 'smallint', nullable: false, options: [
  78.         'comment' => 'Status related to the boost code request from creator',
  79.     ])]
  80.     private int $boostStatus = ActivityBoostStatus::NONE;
  82.     #[Column('boost_requested_by_admin', 'boolean', nullable: false, options: ['default' => false])]
  83.     private bool $boostRequestedByAdmin = false;
  85.     #[OneToMany(mappedBy: 'activity', targetEntity: VideoPending::class)]
  86.     private Collection $pendingVideos;
  88.     #[OneToMany(mappedBy: 'activity', targetEntity: DraftVideo::class)]
  89.     private Collection $draftVideos;
  91.     #[Column(name: 'status', type: 'smallint')]
  92.     private int $status = Status::INBOX;
  94.     #[Column('amount', 'float', options: ['unsigned' => true, 'default' => self::DEFAULT_AMOUNT])]
  95.     private float $amount = self::DEFAULT_AMOUNT;
  97.     #[Column(type: 'float', precision: 10, scale: 2, nullable: false, options: ['unsigned' => true])]
  98.     private float $cpm;
  100.     #[Column('paid', 'float', options: ['unsigned' => true, 'default' => self::DEFAULT_AMOUNT])]
  101.     private float $paid = self::DEFAULT_AMOUNT;
  103.     #[Column('personal_bonus', 'float', options: ['unsigned' => true, 'default' => self::DEFAULT_AMOUNT])]
  104.     private float $personalBonus = self::DEFAULT_AMOUNT;
  106.     #[Column('followers', 'bigint', nullable: true, options: ['unsigned' => true])]
  107.     private ?int $followers = null;
  109.     #[Column('averageViews', 'bigint', nullable: true, options: ['unsigned' => true])]
  110.     private ?int $averageViews = null;
  112.     #[Column('vip_multiplier', 'float', nullable: true, options: ['unsigned' => true, 'default' => null])]
  113.     private ?float $vipMultiplier = null;
  115.     #[Column(type: 'text')]
  116.     private string $reason = '';
  118.     #[Column(type: 'text', nullable: true)]
  119.     private ?string $disputeReason = '';
  121.     #[Column(
  122.         name: 'video_deadline_at',
  123.         type: 'datetime_immutable',
  124.         nullable: true,
  125.         options: [
  126.             'comment' => 'End date for adding a video to the activity',
  127.         ],
  128.     )]
  129.     private ?DateTimeImmutable $videoDeadlineAt = null;
  131.     #[Column(name: 'created_at', type: 'datetime')]
  132.     private ?DateTime $createdAt = null;
  134.     #[Column(name: 'updated_at', type: 'datetime', nullable: true)]
  135.     private ?DateTime $updatedAt = null;
  137.     #[Column('payed_at', 'datetime', nullable: true)]
  138.     private ?DateTime $payedAt = null;
  140.     public function __construct()
  141.     {
  142.         $this->pendingVideos = new ArrayCollection();
  143.         $this->draftVideos = new ArrayCollection();
  144.     }
  146.     #[PrePersist]
  147.     public function prePersist(): void
  148.     {
  149.         $this->createdAt = new DateTime();
  150.     }
  152.     #[PreUpdate]
  153.     public function preUpdate(): void
  154.     {
  155.         $this->updatedAt = new DateTime();
  156.     }
  158.     public function getId(): ?int
  159.     {
  160.         return $this->id;
  161.     }
  163.     public function getCreator(): Creator
  164.     {
  165.         return $this->creator;
  166.     }
  168.     public function setCreator(Creator $creator): self
  169.     {
  170.         $this->creator = $creator;
  172.         return $this;
  173.     }
  175.     public function getCpm(): float
  176.     {
  177.         return $this->cpm;
  178.     }
  180.     public function setCpm(float $cpm): static
  181.     {
  182.         $this->cpm = $cpm;
  184.         return $this;
  185.     }
  187.     public function getCuratorUserId(): ?int
  188.     {
  189.         return $this->curatorUserId;
  190.     }
  192.     public function setCuratorUserId(?int $curatorUserId): self
  193.     {
  194.         $this->curatorUserId = $curatorUserId;
  196.         return $this;
  197.     }
  199.     public function getCuratedAt(): ?DateTimeImmutable
  200.     {
  201.         return $this->curatedAt;
  202.     }
  204.     public function setCuratedAt(?DateTimeImmutable $curatedAt): void
  205.     {
  206.         $this->curatedAt = $curatedAt;
  207.     }
  209.     public function getCampaign(): Campaign
  210.     {
  211.         return $this->campaign;
  212.     }
  214.     public function resolvePlatform(): Platform
  215.     {
  216.         $platform = $this->campaign->getPlatform() ?? $this->creator->getPlatform();
  217.         if ($platform === null) {
  218.             throw new \RuntimeException(
  219.                 sprintf('Activity #%s has no platform on campaign or creator.', $this->id ?? 'unknown'),
  220.             );
  221.         }
  223.         return $platform;
  224.     }
  226.     public function setCampaign(Campaign $campaign): self
  227.     {
  228.         $this->campaign = $campaign;
  230.         return $this;
  231.     }
  233.     public function setStatus(int $status): self
  234.     {
  235.         $this->status = $status;
  237.         return $this;
  238.     }
  240.     public function getStatus(): int
  241.     {
  242.         return $this->status;
  243.     }
  245.     public function isHideAudio(): bool
  246.     {
  247.         return $this->getCampaign()->isHideAudio()
  248.             && ($this->isReviewed() || $this->isInbox());
  249.     }
  251.     public function isInbox(): bool
  252.     {
  253.         return Status::INBOX === $this->status;
  254.     }
  256.     public function isAccepted(): bool
  257.     {
  258.         return in_array($this->status, [
  259.             Status::ACCEPTED,
  260.             Status::SPONSOR_REVIEW,
  261.             Status::VIDEO_PENDING,
  262.         ], true);
  263.     }
  265.     public function isActive(): bool
  266.     {
  267.         return Status::ACTIVE === $this->status;
  268.     }
  270.     public function isReviewed(): bool
  271.     {
  272.         return Status::SPONSOR_REVIEW === $this->status;
  273.     }
  275.     public function isVideoPending(): bool
  276.     {
  277.         return Status::VIDEO_PENDING === $this->status;
  278.     }
  280.     public function isVideoReview(): bool
  281.     {
  282.         return Status::VIDEO_REVIEW === $this->status;
  283.     }
  285.     public function isDraftVideoReview(): bool
  286.     {
  287.         return Status::DRAFT_VIDEO_REVIEW === $this->status;
  288.     }
  290.     public function isCompleted(): bool
  291.     {
  292.         return Status::COMPLETED === $this->status;
  293.     }
  295.     public function isDeclined(): bool
  296.     {
  297.         return in_array($this->status, [
  298.             Status::DECLINE,
  299.             Status::SPONSOR_DECLINE,
  300.         ], true);
  301.     }
  303.     public function isSponsorDeclined(): bool
  304.     {
  305.         return Status::SPONSOR_DECLINE === $this->status;
  306.     }
  308.     public function accept(int $videoExecutionLimitInDays = 0, ?float $vipMultiplier = null, int $newStatus = Status::ACCEPTED): self
  309.     {
  310.         $this->followers = $this->getCreator()->getFollowers();
  311.         $this->averageViews = $this->getCreator()->getAverageViews();
  312.         $this->status = $newStatus;
  313.         $this->vipMultiplier = $vipMultiplier;
  315.         if ($videoExecutionLimitInDays > 0) {
  316.             $this->videoDeadlineAt = (new DateTimeImmutable())->modify(sprintf('+%d days', $videoExecutionLimitInDays));
  317.         }
  319.         return $this;
  320.     }
  322.     public function decline(bool $bySponsor = false): self
  323.     {
  324.         $this->status = $bySponsor ? Status::SPONSOR_DECLINE : Status::DECLINE;
  326.         return $this;
  327.     }
  329.     public function activate(): self
  330.     {
  331.         $this->status = Status::ACTIVE;
  333.         return $this;
  334.     }
  336.     public function videoPending(): self
  337.     {
  338.         $this->status = Status::VIDEO_PENDING;
  340.         return $this;
  341.     }
  343.     public function review(): self
  344.     {
  345.         $this->status = Status::SPONSOR_REVIEW;
  347.         return $this;
  348.     }
  350.     public function complete(): self
  351.     {
  352.         $this->status = Status::COMPLETED;
  354.         return $this;
  355.     }
  357.     public function setVideo(Video $video): self
  358.     {
  359.         $this->video = $video;
  361.         return $this;
  362.     }
  364.     public function getVideo(): ?Video
  365.     {
  366.         return $this->video;
  367.     }
  369.     public function getComplaint(): ?Complaint
  370.     {
  371.         return $this->complaint;
  372.     }
  374.     public function setComplaint(?Complaint $complaint): self
  375.     {
  376.         $this->complaint = $complaint;
  378.         return $this;
  379.     }
  381.     public function isBoostCodeNotRequested(): bool
  382.     {
  383.         return ActivityBoostStatus::NONE === $this->boostStatus;
  384.     }
  386.     public function isBoostCodeRequested(): bool
  387.     {
  388.         return ActivityBoostStatus::REQUESTED === $this->boostStatus;
  389.     }
  391.     public function isBoostCodeReceived(): bool
  392.     {
  393.         return ActivityBoostStatus::RECEIVED === $this->boostStatus;
  394.     }
  396.     public function isBoostCodeRequestedByAdmin(): bool
  397.     {
  398.         return $this->boostRequestedByAdmin;
  399.     }
  401.     public function setBoostRequestedByAdmin(bool $boostRequestedByAdmin): self
  402.     {
  403.         $this->boostRequestedByAdmin = $boostRequestedByAdmin;
  405.         return $this;
  406.     }
  408.     public function getBoostStatus(): int
  409.     {
  410.         return $this->boostStatus;
  411.     }
  413.     public function setBoostStatus(int $boostStatus): self
  414.     {
  415.         $this->boostStatus = $boostStatus;
  417.         return $this;
  418.     }
  420.     public function getVideoDeadlineAt(): ?DateTimeImmutable
  421.     {
  422.         return $this->videoDeadlineAt;
  423.     }
  425.     public function setVideoDeadlineAt(?DateTimeImmutable $videoDeadlineAt): void
  426.     {
  427.         $this->videoDeadlineAt = $videoDeadlineAt;
  428.     }
  430.     public function getCreatedAt(): ?DateTime
  431.     {
  432.         return $this->createdAt;
  433.     }
  435.     public function getUpdatedAt(): ?DateTime
  436.     {
  437.         return $this->updatedAt;
  438.     }
  440.     public function getInstructions(): AbstractString
  441.     {
  442.         return s($this->getCampaign()->getInstructions());
  443.     }
  445.     public function isReadMore(): bool
  446.     {
  447.         return $this->getCampaign()->isPredefinedInstructions()
  448.             && $this->getInstructions()->length() > self::READ_MORE_LENGTH;
  449.     }
  451.     public function getShortInstructions(): string
  452.     {
  453.         return $this->getInstructions()->truncate(self::READ_MORE_LENGTH, cut: false)->toString();
  454.     }
  456.     public function setAmount(float $amount): self
  457.     {
  458.         $this->amount = $amount;
  460.         return $this;
  461.     }
  463.     public function getAmount(): float
  464.     {
  465.         return $this->amount;
  466.     }
  468.     public function setPaid(float $paid): self
  469.     {
  470.         $this->paid = $paid;
  472.         return $this;
  473.     }
  475.     public function getPaid(): float
  476.     {
  477.         return $this->paid;
  478.     }
  480.     public function getPayedAt(): ?DateTime
  481.     {
  482.         return $this->payedAt;
  483.     }
  485.     public function confirmPayout(): self
  486.     {
  487.         $this->payedAt = new DateTime();
  489.         return $this;
  490.     }
  492.     public function isNeedPayment(): bool
  493.     {
  494.         return $this->isCompleted() && $this->getPayedAt() === null;
  495.     }
  497.     public function videoPaid(): bool
  498.     {
  499.         return Status::COMPLETED === $this->getStatus() && $this->getPayedAt() !== null;
  500.     }
  502.     public function setFollowers(int $followers): self
  503.     {
  504.         $this->followers = $followers;
  506.         return $this;
  507.     }
  509.     public function getFollowers(): int
  510.     {
  511.         return $this->followers ?? $this->getCreator()->getFollowers();
  512.     }
  514.     public function getRawFollowers(): ?int
  515.     {
  516.         return $this->followers;
  517.     }
  519.     public function setAverageViews(int $averageViews): self
  520.     {
  521.         $this->averageViews = $averageViews;
  523.         return $this;
  524.     }
  526.     public function getAverageViews(): int
  527.     {
  528.         return $this->averageViews ?? $this->getCreator()->getAverageViews();
  529.     }
  531.     public function getVipMultiplier(): ?float
  532.     {
  533.         return $this->vipMultiplier;
  534.     }
  536.     public function setVipMultiplier(?float $vipMultiplier): self
  537.     {
  538.         $this->vipMultiplier = $vipMultiplier;
  540.         return $this;
  541.     }
  543.     public function getRawAverageViews(): ?int
  544.     {
  545.         return $this->averageViews;
  546.     }
  548.     public function getPersonalBonus(): float
  549.     {
  550.         return $this->personalBonus;
  551.     }
  553.     public function setPersonalBonus(float $personalBonus): self
  554.     {
  555.         $this->personalBonus = $personalBonus;
  557.         return $this;
  558.     }
  560.     public function isSetPersonalBonus(): bool
  561.     {
  562.         return $this->getPersonalBonus() > 0;
  563.     }
  565.     public function getReason(): string
  566.     {
  567.         return $this->reason;
  568.     }
  570.     public function setReason(string $reason): self
  571.     {
  572.         $this->reason = $reason;
  574.         return $this;
  575.     }
  577.     public function getDisputeReason(): ?string
  578.     {
  579.         return $this->disputeReason;
  580.     }
  582.     public function setDisputeReason(?string $disputeReason): self
  583.     {
  584.         $this->disputeReason = $disputeReason;
  586.         return $this;
  587.     }
  589.     public function getPendingVideos(): Collection
  590.     {
  591.         return $this->pendingVideos;
  592.     }
  594.     public function getDraftVideos(): Collection
  595.     {
  596.         return $this->draftVideos;
  597.     }
  599.     public function getPendingDraftVideo(): ?DraftVideo
  600.     {
  601.         $video = $this->getDraftVideos()->filter(function ($video) {
  602.             return $video->getStatus() == DraftVideoStatus::PENDING;
  603.         })->first();
  605.         if ($video === false) {
  606.             return null;
  607.         }
  609.         return $video;
  610.     }
  612.     public function getApprovedDraftVideo(): ?DraftVideo
  613.     {
  614.         $video = $this->getDraftVideos()->filter(function ($video) {
  615.             return $video->getStatus() == DraftVideoStatus::APPROVED;
  616.         })->first();
  618.         if ($video === false) {
  619.             return null;
  620.         }
  622.         return $video;
  623.     }
  625.     public function getActualDraftVideo(): ?DraftVideo
  626.     {
  627.         if ($this->isDraftVideoReview()) {
  628.             return $this->getPendingDraftVideo();
  629.         }
  631.         return $this->getApprovedDraftVideo();
  632.     }
  634.     public function isDraftVideoRequired(): bool
  635.     {
  636.         return
  637.             $this->getStatus() == Status::ACCEPTED &&
  638.             $this->getActualDraftVideo() === null &&
  639.             $this->getCampaign()->isDraftVideo();
  640.     }
  642.     public function getActualModifyDraftVideo(): ?DraftVideo
  643.     {
  644.         if ($this->getActualDraftVideo() !== null) {
  645.             return null;
  646.         }
  648.         return $this->getLastModifyDraftVideo();
  649.     }
  651.     public function getLastModifyDraftVideo(): ?DraftVideo
  652.     {
  653.         if ($this->getActualDraftVideo() !== null) {
  654.             return null;
  655.         }
  657.         $declinedVideos = $this->getDraftVideos()->filter(function ($video) {
  658.             return $video->getStatus() === DraftVideoStatus::MODIFY;
  659.         });
  661.         if ($declinedVideos->isEmpty()) {
  662.             return null;
  663.         }
  665.         $sortedVideos = $declinedVideos->matching(
  666.             Criteria::create()->orderBy(['id' => Criteria::DESC])
  667.         );
  669.         return $sortedVideos->first();
  670.     }
  672.     /**
  673.      * Average-view rate: a creator-account quality proxy (average views / followers).
  674.      * Historically — and misleadingly — surfaced as "engagement rate" on creator-screening
  675.      * surfaces (creator review, targeting/eligibility, analytics). This is NOT post
  676.      * engagement and must not be confused with {@see getEngagementRate()}.
  677.      * See docs/EngagementRateMetric.md.
  678.      */
  679.     public function getAverageViewRate(): float
  680.     {
  681.         if ($this->followers === 0) {
  682.             return 0;
  683.         }
  685.         return $this->averageViews / $this->followers;
  686.     }
  688.     /**
  689.      * Post engagement rate for this activity's video: (likes + comments + shares) / views.
  690.      * This is the campaign-performance engagement metric shown on results dashboards.
  691.      * Returns 0.0 when there is no video or the video has zero views.
  692.      * See docs/EngagementRateMetric.md.
  693.      */
  694.     public function getEngagementRate(): float
  695.     {
  696.         $video = $this->getVideo();
  698.         if ($video === null || $video->getViews() === 0) {
  699.             return 0.0;
  700.         }
  702.         return ($video->getLikes() + $video->getComments() + $video->getShares()) / $video->getViews();
  703.     }
  704. }