Range.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Data;

class Range
{
    protected int $start;
    protected int $length;

    public function __construct(int $start, int $length)
    {
        $this->checkStart($start);
        $this->checkLength($length);
        $this->start = $start;
        $this->length = $length;
    }

    protected function checkStart(int $start): void
    {
        if ($start < 0) {
            throw new \InvalidArgumentException("Start must be a positive number (or 0)", 1);
        }
    }

    protected function checkLength(int $length): void
    {
        if ($length < 0) {
            throw new \InvalidArgumentException("Length must be larger or equal then 0", 1);
        }
    }

    public function unpack(): array
    {
        return [$this->start, $this->length];
    }

    public function getStart(): int
    {
        return $this->start;
    }

    public function getLength(): int
    {
        return $this->length;
    }

    public function getEnd(): int
    {
        if ($this->length === PHP_INT_MAX) {
            return PHP_INT_MAX;
        }

        return $this->start + $this->length;
    }

    public function withStart(int $start): Range
    {
        $this->checkStart($start);
        $clone = clone $this;
        $clone->start = $start;
        return $clone;
    }

    public function withLength(int $length): Range
    {
        $this->checkLength($length);
        $clone = clone $this;
        $clone->length = $length;
        return $clone;
    }

    public function croppedTo(int $max): Range
    {
        if ($max > $this->getEnd()) {
            return $this;
        }

        if ($this->getStart() > $max) {
            return new self($max, 0);
        }

        return $this->withLength($max - $this->getStart());
    }
}