Merge pull request #20 from FrittenKeeZ/feature/with-start-expire-null

Allow `Vouchers::withStart*()` and `Vouchers::withExpire*()` methods to accept `null`

Author: FrittenKeeZ

CHANGELOG.md

@@ -1,9 +1,14 @@
 # Release Notes
 
+## [v0.6.2 (2025-07-10)](https://github.com/FrittenKeeZ/laravel-vouchers/compare/0.6.1...0.6.2)
+
+### Changed
+- Allow `Vouchers::withStart*()` and `Vouchers::withExpire*()` methods to accept `null`
+
 ## [v0.6.1 (2025-07-09)](https://github.com/FrittenKeeZ/laravel-vouchers/compare/0.6.0...0.6.1)
 
 ### Changed
-- Allow withEntities to accept any iterable
+- Allow `Vouchers::withEntities()` method to accept any `iterable`
 
 ## [v0.6.0 (2025-02-27)](https://github.com/FrittenKeeZ/laravel-vouchers/compare/0.5.0...0.6.0)
 

README.md

@@ -116,21 +116,21 @@ Following methods only apply to `Vouchers::create()` call.
 // Add metadata to voucher.
 Vouchers::withMetadata(array $metadata);
 // Set voucher start time.
-Vouchers::withStartTime(DateTime $timestamp);
+Vouchers::withStartTime(DateTime|null $timestamp);
 // Set voucher start time using interval.
-Vouchers::withStartTimeIn(DateInterval $interval);
+Vouchers::withStartTimeIn(DateInterval|null $interval);
 // Set voucher start date - time component is zeroed.
-Vouchers::withStartDate(DateTime $timestamp);
+Vouchers::withStartDate(DateTime|null $timestamp);
 // Set voucher start date using interval - time component is zeroed.
-Vouchers::withStartDateIn(DateInterval $interval);
+Vouchers::withStartDateIn(DateInterval|null $interval);
 // Set voucher expire time.
-Vouchers::withExpireTime(DateTime $timestamp);
+Vouchers::withExpireTime(DateTime|null $timestamp);
 // Set voucher expire time using interval.
-Vouchers::withExpireTimeIn(DateInterval $interval);
+Vouchers::withExpireTimeIn(DateInterval|null $interval);
 // Set voucher expire date - time component is set to end of day (23:59:59).
-Vouchers::withExpireDate(DateTime $timestamp);
+Vouchers::withExpireDate(DateTime|null $timestamp);
 // Set voucher expire date using interval - time component is set to end of day (23:59:59).
-Vouchers::withExpireDateIn(DateInterval $interval);
+Vouchers::withExpireDateIn(DateInterval|null $interval);
 // Set related entities to voucher - using spread operater.
 Vouchers::withEntities(Illuminate\Database\Eloquent\Model ...$entities);
 // Set related entities to voucher - iterable.

src/Config.php

@@ -174,35 +174,39 @@ public function getStartTime(): ?Carbon
     /**
      * With start time.
      */
-    public function withStartTime(DateTime $timestamp): self
+    public function withStartTime(?DateTime $timestamp): self
     {
-        Arr::set($this->options, 'starts_at', Carbon::instance($timestamp));
+        if ($timestamp === null) {
+            Arr::forget($this->options, 'starts_at');
+        } else {
+            Arr::set($this->options, 'starts_at', Carbon::instance($timestamp));
+        }
 
         return $this;
     }
 
     /**
      * With start time in the given interval.
      */
-    public function withStartTimeIn(DateInterval $interval): self
+    public function withStartTimeIn(?DateInterval $interval): self
     {
-        return $this->withStartTime(Carbon::now()->add($interval));
+        return $this->withStartTime($interval ? Carbon::now()->add($interval) : null);
     }
 
     /**
      * With start date - time component is set to 00:00:00.000000.
      */
-    public function withStartDate(DateTime $timestamp): self
+    public function withStartDate(?DateTime $timestamp): self
     {
-        return $this->withStartTime(Carbon::instance($timestamp)->startOfDay());
+        return $this->withStartTime($timestamp ? Carbon::instance($timestamp)->startOfDay() : null);
     }
 
     /**
      * With start date in the given interval - time component is set to 00:00:00.000000.
      */
-    public function withStartDateIn(DateInterval $interval): self
+    public function withStartDateIn(?DateInterval $interval): self
     {
-        return $this->withStartTime(Carbon::now()->add($interval)->startOfDay());
+        return $this->withStartTime($interval ? Carbon::now()->add($interval)->startOfDay() : null);
     }
 
     /**
@@ -216,35 +220,39 @@ public function getExpireTime(): ?Carbon
     /**
      * With expire time.
      */
-    public function withExpireTime(DateTime $timestamp): self
+    public function withExpireTime(?DateTime $timestamp): self
     {
-        Arr::set($this->options, 'expires_at', Carbon::instance($timestamp));
+        if ($timestamp === null) {
+            Arr::forget($this->options, 'expires_at');
+        } else {
+            Arr::set($this->options, 'expires_at', Carbon::instance($timestamp));
+        }
 
         return $this;
     }
 
     /**
      * With expire time in the given interval.
      */
-    public function withExpireTimeIn(DateInterval $interval): self
+    public function withExpireTimeIn(?DateInterval $interval): self
     {
-        return $this->withExpireTime(Carbon::now()->add($interval));
+        return $this->withExpireTime($interval ? Carbon::now()->add($interval) : null);
     }
 
     /**
      * With expire date - time component is set to 23:59:59.999999.
      */
-    public function withExpireDate(DateTime $timestamp): self
+    public function withExpireDate(?DateTime $timestamp): self
     {
-        return $this->withExpireTime(Carbon::instance($timestamp)->endOfDay());
+        return $this->withExpireTime($timestamp ? Carbon::instance($timestamp)->endOfDay() : null);
     }
 
     /**
      * With expire date in the given interval - time component is set to 23:59:59.999999.
      */
-    public function withExpireDateIn(DateInterval $interval): self
+    public function withExpireDateIn(?DateInterval $interval): self
     {
-        return $this->withExpireTime(Carbon::now()->add($interval)->endOfDay());
+        return $this->withExpireTime($interval ? Carbon::now()->add($interval)->endOfDay() : null);
     }
 
     /**

tests/Feature/ConfigTest.php

@@ -170,37 +170,45 @@ function _assert_array_structure(array $expected, array $actual): void
         Carbon::now()->toDateTimeString(),
         $config->withStartTime(Carbon::now())->getStartTime()->toDateTimeString()
     );
+    $this->assertNull($config->withStartTime(null)->getStartTime());
     $this->assertSame(
         Carbon::now()->add($interval)->toDateTimeString(),
         $config->withStartTimeIn($interval)->getStartTime()->toDateTimeString()
     );
+    $this->assertNull($config->withStartTimeIn(null)->getStartTime());
     $this->assertSame(
         Carbon::now()->startOfDay()->toDateTimeString(),
         $config->withStartDate(Carbon::now())->getStartTime()->toDateTimeString()
     );
+    $this->assertNull($config->withStartDate(null)->getStartTime());
     $this->assertSame(
         Carbon::now()->add($interval)->startOfDay()->toDateTimeString(),
         $config->withStartDateIn($interval)->getStartTime()->toDateTimeString()
     );
+    $this->assertNull($config->withStartDateIn(null)->getStartTime());
 
     // Test expire time.
     $interval = CarbonInterval::create('P15DT20M10S');
     $this->assertSame(
         Carbon::now()->toDateTimeString(),
         $config->withExpireTime(Carbon::now())->getExpireTime()->toDateTimeString()
     );
+    $this->assertNull($config->withExpireTime(null)->getExpireTime());
     $this->assertSame(
         Carbon::now()->add($interval)->toDateTimeString(),
         $config->withExpireTimeIn($interval)->getExpireTime()->toDateTimeString()
     );
+    $this->assertNull($config->withExpireTimeIn(null)->getExpireTime());
     $this->assertSame(
         Carbon::now()->endOfDay()->toDateTimeString(),
         $config->withExpireDate(Carbon::now())->getExpireTime()->toDateTimeString()
     );
+    $this->assertNull($config->withExpireDate(null)->getExpireTime());
     $this->assertSame(
         Carbon::now()->add($interval)->endOfDay()->toDateTimeString(),
         $config->withExpireDateIn($interval)->getExpireTime()->toDateTimeString()
     );
+    $this->assertNull($config->withExpireDateIn(null)->getExpireTime());
 
     // Test owner.
     $owner = User::factory()->make();