Added the PromotionStatus enum

src/Promotion/Contracts/Promotion.php

@@ -15,6 +15,7 @@
 namespace Vanilo\Promotion\Contracts;
 
 use Illuminate\Support\Collection;
+use Vanilo\Promotion\Models\PromotionStatus;
 
 interface Promotion
 {
@@ -28,6 +29,9 @@ public function isExpired(?\DateTimeInterface $at = null): bool;
 
  public function isDepleted(): bool;
 
+ /** A read-only, calculated enum */
+ public function getStatus(): PromotionStatus;
+
  public function isEligible(object $subject): bool;
 
  public function isCouponBased(): bool;

src/Promotion/Models/Promotion.php

@@ -132,6 +132,16 @@ public function isDepleted(): bool
  return $this->usage_count >= $this->usage_limit;
  }
 
+ public function getStatus(): PromotionStatus
+ {
+ return match(true) {
+ $this->isExpired() => PromotionStatus::Expired,
+ $this->isDepleted() => PromotionStatus::Depleted,
+ $this->isValid() => PromotionStatus::Active,
+ default => PromotionStatus::Inactive,
+ };
+ }
+
  public function isEligible(object $subject): bool
  {
  /** @var PromotionRule $rule */

src/Promotion/Models/PromotionStatus.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vanilo\Promotion\Models;
+
+enum PromotionStatus: string
+{
+ case Inactive = 'inactive';
+ case Active = 'active';
+ case Expired = 'expired';
+ case Depleted = 'depleted';
+
+ public function label(): string
+ {
+ return match ($this) {
+ self::Inactive => __('Inactive'),
+ self::Active => __('Active'),
+ self::Expired => __('Expired'),
+ self::Depleted => __('Depleted'),
+ };
+ }
+}