1 files changed, 62 insertions, 0 deletions
diff --git a/vendor/ipl/scheduler/src/Contract/Frequency.php b/vendor/ipl/scheduler/src/Contract/Frequency.php
new file mode 100644
index 0000000..2235787
--- /dev/null
+++ b/vendor/ipl/scheduler/src/Contract/Frequency.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace ipl\Scheduler\Contract;
+
+use DateTimeInterface;
+use JsonSerializable;
+
+interface Frequency extends JsonSerializable
+{
+    /** @var string Format for representing datetimes when serializing the frequency to JSON */
+    public const SERIALIZED_DATETIME_FORMAT = 'Y-m-d\TH:i:s.ue';
+
+    /**
+     * Get whether the frequency is due at the specified time
+     *
+     * @param DateTimeInterface $dateTime
+     *
+     * @return bool
+     */
+    public function isDue(DateTimeInterface $dateTime): bool;
+
+    /**
+     * Get the next due date relative to the given time
+     *
+     * @param DateTimeInterface $dateTime
+     *
+     * @return DateTimeInterface
+     */
+    public function getNextDue(DateTimeInterface $dateTime): DateTimeInterface;
+
+    /**
+     * Get whether the specified time is beyond the frequency's expiry time
+     *
+     * @param DateTimeInterface $dateTime
+     *
+     * @return bool
+     */
+    public function isExpired(DateTimeInterface $dateTime): bool;
+
+    /**
+     * Get the start time of this frequency
+     *
+     * @return ?DateTimeInterface
+     */
+    public function getStart(): ?DateTimeInterface;
+
+    /**
+     * Get the end time of this frequency
+     *
+     * @return ?DateTimeInterface
+     */
+    public function getEnd(): ?DateTimeInterface;
+
+    /**
+     * Create frequency from its stored JSON representation previously encoded with {@see json_encode()}
+     *
+     * @param string $json
+     *
+     * @return $this
+     */
+    public static function fromJson(string $json): self;
+}