Adding upstream version 0.13.1.upstream/0.13.1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 203 insertions, 0 deletions

diff --git a/vendor/ipl/scheduler/src/Cron.php b/vendor/ipl/scheduler/src/Cron.php
new file mode 100644
index 0000000..639957b
--- /dev/null
+++ b/vendor/ipl/scheduler/src/Cron.php
@@ -0,0 +1,203 @@
+<?php
+
+namespace ipl\Scheduler;
+
+use Cron\CronExpression;
+use DateTime;
+use DateTimeInterface;
+use DateTimeZone;
+use InvalidArgumentException;
+use ipl\Scheduler\Contract\Frequency;
+
+use function ipl\Stdlib\get_php_type;
+
+class Cron implements Frequency
+{
+    public const PART_MINUTE = 0;
+    public const PART_HOUR = 1;
+    public const PART_DAY = 2;
+    public const PART_MONTH = 3;
+    public const PART_WEEKDAY = 4;
+
+    /** @var CronExpression */
+    protected $cron;
+
+    /** @var ?DateTimeInterface Start time of this frequency */
+    protected $start;
+
+    /** @var ?DateTimeInterface End time of this frequency */
+    protected $end;
+
+    /** @var string String representation of the cron expression */
+    protected $expression;
+
+    /**
+     * Create frequency from the specified cron expression
+     *
+     * @param string $expression
+     *
+     * @throws InvalidArgumentException If expression is not a valid cron expression
+     */
+    public function __construct(string $expression)
+    {
+        $this->cron = new CronExpression($expression);
+        $this->expression = $expression;
+    }
+
+    public function isDue(DateTimeInterface $dateTime): bool
+    {
+        if ($this->isExpired($dateTime) || $dateTime < $this->start) {
+            return false;
+        }
+
+        return $this->cron->isDue($dateTime);
+    }
+
+    public function getNextDue(DateTimeInterface $dateTime): DateTimeInterface
+    {
+        if ($this->isExpired($dateTime)) {
+            return $this->end;
+        }
+
+        if ($dateTime < $this->start) {
+            return $this->start;
+        }
+
+        return $this->cron->getNextRunDate($dateTime);
+    }
+
+    public function isExpired(DateTimeInterface $dateTime): bool
+    {
+        return $this->end !== null && $this->end < $dateTime;
+    }
+
+    public function getStart(): ?DateTimeInterface
+    {
+        return $this->start;
+    }
+
+    public function getEnd(): ?DateTimeInterface
+    {
+        return $this->end;
+    }
+
+    /**
+     * Get the configured cron expression
+     *
+     * @return string
+     */
+    public function getExpression(): string
+    {
+        return $this->expression;
+    }
+
+    /**
+     * Set the start time of this frequency
+     *
+     * @param DateTimeInterface $start
+     *
+     * @return $this
+     */
+    public function startAt(DateTimeInterface $start): self
+    {
+        $this->start = clone $start;
+        $this->start->setTimezone(new DateTimeZone(date_default_timezone_get()));
+
+        return $this;
+    }
+
+    /**
+     * Set the end time of this frequency
+     *
+     * @param DateTimeInterface $end
+     *
+     * @return $this
+     */
+    public function endAt(DateTimeInterface $end): Frequency
+    {
+        $this->end = clone $end;
+        $this->end->setTimezone(new DateTimeZone(date_default_timezone_get()));
+
+        return $this;
+    }
+
+    /**
+     * Get the given part of the underlying cron expression
+     *
+     * @param int $part One of the classes `PART_*` constants
+     *
+     * @return string
+     *
+     * @throws InvalidArgumentException If the given part is invalid
+     */
+    public function getPart(int $part): string
+    {
+        $value = $this->cron->getExpression($part);
+        if ($value === null) {
+            throw new InvalidArgumentException(sprintf('Invalid expression part specified: %d', $part));
+        }
+
+        return $value;
+    }
+
+    /**
+     * Get the parts of the underlying cron expression as an array
+     *
+     * @return string[]
+     */
+    public function getParts(): array
+    {
+        return $this->cron->getParts();
+    }
+
+    /**
+     * Get whether the given cron expression is valid
+     *
+     * @param string $expression
+     *
+     * @return bool
+     */
+    public static function isValid(string $expression): bool
+    {
+        return CronExpression::isValidExpression($expression);
+    }
+
+    public static function fromJson(string $json): Frequency
+    {
+        $data = json_decode($json, true);
+        if (! is_array($data)) {
+            throw new InvalidArgumentException(
+                sprintf(
+                    '%s expects json decoded value to be an array, got %s instead',
+                    __METHOD__,
+                    get_php_type($data)
+                )
+            );
+        }
+
+        $self = new static($data['expression']);
+        if (isset($data['start'])) {
+            $self->startAt(new DateTime($data['start']));
+        }
+
+        if (isset($data['end'])) {
+            $self->endAt(new DateTime($data['end']));
+        }
+
+        return $self;
+    }
+
+    public function jsonSerialize(): array
+    {
+        $data = ['expression' => $this->getExpression()];
+        if ($this->start) {
+            $data['start'] = $this->start->format(static::SERIALIZED_DATETIME_FORMAT);
+        }
+
+        if ($this->end) {
+            $data['end'] = $this->end->format(static::SERIALIZED_DATETIME_FORMAT);
+        }
+
+        return $data;
+    }
+}