Level23\Druid\Concerns\HasInterval

Complexity

Total Complexity

1

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	interval()	0	5	1

<?php
declare(strict_types=1);

namespace Level23\Druid\Concerns;

use DateTimeInterface;
use Level23\Druid\Interval\Interval;
use Level23\Druid\Interval\IntervalInterface;

trait HasInterval
{
    /**
     * @var \Level23\Druid\Interval\Interval|null
     */
    protected ?IntervalInterface $interval = null;

    /**
     * Set the interval, e.g. the date where we want to select data from.
     *
     * You should specify the interval in string form like "$start/$stop" format, or give two parameters
     * where each parameter should be a DateTime object, unix timestamp or string accepted by DateTime::__construct.
     *
     * All these examples are valid:
     *
     * ```php
     * // Select an interval with string values. Anything which can be parsed by the DateTime object
     * // can be given. Also, "yesterday" or "now" is valid.
     * interval('2019-12-23', '2019-12-24');
     *
     * // When a string is given which contains a slash, we will split it for you and parse it as "begin/end".
     * interval('yesterday/now');
     *
     * // An "raw" interval as druid uses them is also allowed
     * interval('2015-09-12T00:00:00.000Z/2015-09-13T00:00:00.000Z');
     *
     * // You can also give DateTime objects
     * interval(new DateTime('yesterday'), new DateTime('now'));
     *
     * // Carbon is also supported, as it extends DateTime
     * interval(Carbon::now()->subDay(), Carbon::now());
     *
     * // Timestamps are also supported:
     * interval(1570643085, 1570729485);
     * ```
     *
     * @param \DateTimeInterface|int|string      $start DateTime object, unix timestamp or string accepted by
     *                                                  DateTime::__construct
     * @param \DateTimeInterface|int|string|null $stop  DateTime object, unix timestamp or string accepted by
     *                                                  DateTime::__construct
     *
     * @return $this
     * @throws \Exception
     */
    public function interval(DateTimeInterface|int|string $start, DateTimeInterface|int|string|null $stop = null): self
    {
        $this->interval = new Interval($start, $stop);

        return $this;
    }
}