[Scheduler] have TriggerInterface extend \Stringable

kbond · kbond · commit 2df4a224bc03 · 2023-03-29T16:29:49.000-04:00
diff --git a/src/Symfony/Component/Scheduler/Tests/Generator/MessageGeneratorTest.php b/src/Symfony/Component/Scheduler/Tests/Generator/MessageGeneratorTest.php
@@ -135,6 +135,11 @@ public static function messagesProvider(): \Generator
             ],
             'schedule' => [
                 RecurringMessage::trigger(new class() implements TriggerInterface {
+                    public function __toString(): string
+                    {
+                        return 'foo';
+                    }
+
                     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
                     {
                         return null;
diff --git a/src/Symfony/Component/Scheduler/Trigger/CallbackTrigger.php b/src/Symfony/Component/Scheduler/Trigger/CallbackTrigger.php
@@ -20,11 +20,16 @@ final class CallbackTrigger implements TriggerInterface
 {
     private \Closure $callback;
 
-    public function __construct(callable $callback)
+    public function __construct(callable $callback, private string $description)
     {
         $this->callback = $callback(...);
     }
 
+    public function __toString(): string
+    {
+        return $this->description;
+    }
+
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
     {
         return ($this->callback)($run);
diff --git a/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php b/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php
@@ -21,7 +21,7 @@
  *
  * @experimental
  */
-final class CronExpressionTrigger implements TriggerInterface, \Stringable
+final class CronExpressionTrigger implements TriggerInterface
 {
     public function __construct(
         private readonly CronExpression $expression = new CronExpression('* * * * *'),
diff --git a/src/Symfony/Component/Scheduler/Trigger/DatePeriodTrigger.php b/src/Symfony/Component/Scheduler/Trigger/DatePeriodTrigger.php
@@ -21,6 +21,16 @@ public function __construct(
     ) {
     }
 
+    public function __toString(): string
+    {
+        return sprintf(
+            '%s - %s, %s',
+            $this->period->getStartDate()->format(\DateTimeInterface::ATOM),
+            $this->period->getEndDate()?->format(\DateTimeInterface::ATOM) ?? '(inf)',
+            'every ?',
+        );
+    }
+
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
     {
         $iterator = $this->period->getIterator();
diff --git a/src/Symfony/Component/Scheduler/Trigger/ExcludeTimeTrigger.php b/src/Symfony/Component/Scheduler/Trigger/ExcludeTimeTrigger.php
@@ -23,6 +23,11 @@ public function __construct(
     ) {
     }
 
+    public function __toString(): string
+    {
+        return sprintf('%s, from: %s, until: %s', $this->inner, $this->from->format(\DateTimeInterface::ATOM), $this->until->format(\DateTimeInterface::ATOM));
+    }
+
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
     {
         $nextRun = $this->inner->getNextRunDate($run);
diff --git a/src/Symfony/Component/Scheduler/Trigger/TriggerInterface.php b/src/Symfony/Component/Scheduler/Trigger/TriggerInterface.php
@@ -14,7 +14,7 @@
 /**
  * @experimental
  */
-interface TriggerInterface
+interface TriggerInterface extends \Stringable
 {
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable;
 }

Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,16 @@ final class CallbackTrigger implements TriggerInterface`
`20`	`20`	`{`
`21`	`21`	`private \Closure $callback;`
`22`	`22`
`23`		`- public function __construct(callable $callback)`
	`23`	`+ public function __construct(callable $callback, private string $description)`
`24`	`24`	`{`
`25`	`25`	`$this->callback = $callback(...);`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ public function __toString(): string`
	`29`	`+ {`
	`30`	`+ return $this->description;`
	`31`	`+ }`
	`32`	`+`
`28`	`33`	`public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable`
`29`	`34`	`{`
`30`	`35`	`return ($this->callback)($run);`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`*`
`22`	`22`	`* @experimental`
`23`	`23`	`*/`
`24`		`-final class CronExpressionTrigger implements TriggerInterface, \Stringable`
	`24`	`+final class CronExpressionTrigger implements TriggerInterface`
`25`	`25`	`{`
`26`	`26`	`public function __construct(`
`27`	`27`	`private readonly CronExpression $expression = new CronExpression('* * * * *'),`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,11 @@ public function __construct(`
`23`	`23`	`) {`
`24`	`24`	`}`
`25`	`25`
	`26`	`+ public function __toString(): string`
	`27`	`+ {`
	`28`	`+ return sprintf('%s, from: %s, until: %s', $this->inner, $this->from->format(\DateTimeInterface::ATOM), $this->until->format(\DateTimeInterface::ATOM));`
	`29`	`+ }`
	`30`	`+`
`26`	`31`	`public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable`
`27`	`32`	`{`
`28`	`33`	`$nextRun = $this->inner->getNextRunDate($run);`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`/**`
`15`	`15`	`* @experimental`
`16`	`16`	`*/`
`17`		`-interface TriggerInterface`
	`17`	`+interface TriggerInterface extends \Stringable`
`18`	`18`	`{`
`19`	`19`	`public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable;`
`20`	`20`	`}`