ILIAS\Data\Range Class Reference

A simple class to express a range of whole positive numbers. More...

Collaboration diagram for ILIAS\Data\Range:

Public Member Functions
	__construct (int $start, int $length)
	unpack ()
	getStart ()
	getLength ()
	getEnd ()
	getEnd will return the (excluded) endpoint. More...
	withStart (int $start)
	withLength (int $length)
	croppedTo (int $max)
	This will create a range that is guaranteed to not exceed $max. More...

Protected Member Functions
	checkStart (int $start)
	checkLength (int $length)

Protected Attributes
int	$start
int	$length

Detailed Description

A simple class to express a range of whole positive numbers.

Range is a half-open interval (right-open): [a,b) = {x ∈ ℕ: a ≤ x < b}. Since the endpoint is excluded, a Range of 0,3 means: records 0,1,2, but not 3.

Author

Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 30 of file Range.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Range::__construct	(	int	$start,
		int	$length
	)

Definition at line 35 of file Range.php.

References ILIAS\Data\Range\$length, ILIAS\Data\Range\$start, ILIAS\Data\Range\checkLength(), and ILIAS\Data\Range\checkStart().

    {
        $this->checkStart($start);
        $this->checkLength($length);
        $this->start = $start;
        $this->length = $length;
    }

Here is the call graph for this function:

Member Function Documentation

checkLength()

ILIAS\Data\Range::checkLength ( int  $length )

protected

Definition at line 50 of file Range.php.

Referenced by ILIAS\Data\Range\__construct(), and ILIAS\Data\Range\withLength().

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

Here is the caller graph for this function:

checkStart()

ILIAS\Data\Range::checkStart ( int  $start )

protected

Definition at line 43 of file Range.php.

Referenced by ILIAS\Data\Range\__construct(), and ILIAS\Data\Range\withStart().

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

Here is the caller graph for this function:

croppedTo()

ILIAS\Data\Range::croppedTo

(

int

$max

)

This will create a range that is guaranteed to not exceed $max.

Definition at line 104 of file Range.php.

References ILIAS\Data\Range\getEnd(), ILIAS\Data\Range\getStart(), and ILIAS\Data\Range\withLength().

Referenced by ILIAS\UI\Implementation\Component\Table\Data\applyViewControls().

                                       : Range
    {
        if ($max > $this->getEnd()) {
            return $this;
        }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getEnd()

ILIAS\Data\Range::getEnd

(

)

getEnd will return the (excluded) endpoint.

For a Range of (4,2), e.g.: getEnd is 4 + 2 = 6, so valid records are 4 and 5, but not 6.

Definition at line 76 of file Range.php.

References ILIAS\Data\Range\$length.

Referenced by ILIAS\Data\Range\croppedTo(), RangeTest\testEndCalculation(), RangeTest\testWithLength(), and RangeTest\testWithStart().

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

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

Here is the caller graph for this function:

getLength()

ILIAS\Data\Range::getLength

(

)

Definition at line 67 of file Range.php.

References ILIAS\Data\Range\$length.

Referenced by ILIAS\UI\examples\Table\Data\base(), ILIAS\UI\Implementation\Component\Table\Data\getViewControlPagination(), RangeTest\testValues(), RangeTest\testWithLength(), and RangeTest\testWithStart().

                               : int
    {
        return $this->length;
    }

Here is the caller graph for this function:

getStart()

ILIAS\Data\Range::getStart

(

)

Definition at line 62 of file Range.php.

References ILIAS\Data\Range\$start.

Referenced by ILIAS\UI\examples\Table\Data\base(), ILIAS\Data\Range\croppedTo(), ILIAS\UI\Implementation\Component\Table\Data\getViewControlPagination(), RangeTest\testValues(), RangeTest\testWithLength(), and RangeTest\testWithStart().

                              : int
    {
        return $this->start;
    }

Here is the caller graph for this function:

unpack()

ILIAS\Data\Range::unpack

(

)

Definition at line 57 of file Range.php.

References ILIAS\Data\Range\$length, and ILIAS\Data\Range\$start.

Referenced by ILIAS\UI\examples\Table\Data\DataTableDemoRepo\doSelect(), ILIAS\UI\Implementation\Component\Input\ViewControl\Pagination\getCorrectOffsetForPageSize(), and RangeTest\testUnpack().

                            : array
    {
        return [$this->start, $this->length];
    }

Here is the caller graph for this function:

withLength()

ILIAS\Data\Range::withLength

(

int

$length

)

Definition at line 93 of file Range.php.

References ILIAS\Data\Range\$length, and ILIAS\Data\Range\checkLength().

Referenced by ILIAS\Data\Range\croppedTo(), RangeTest\testNegativeLength(), and RangeTest\testWithLength().

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

Here is the call graph for this function:

Here is the caller graph for this function:

withStart()

ILIAS\Data\Range::withStart

(

int

$start

)

Definition at line 85 of file Range.php.

References ILIAS\Data\Range\$start, and ILIAS\Data\Range\checkStart().

Referenced by RangeTest\testNegativeStart(), and RangeTest\testWithStart().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$length

int ILIAS\Data\Range::$length

protected

Definition at line 33 of file Range.php.

Referenced by ILIAS\Data\Range\__construct(), ILIAS\Data\Range\getEnd(), ILIAS\Data\Range\getLength(), ILIAS\Data\Range\unpack(), and ILIAS\Data\Range\withLength().

$start

int ILIAS\Data\Range::$start

protected

Definition at line 32 of file Range.php.

Referenced by ILIAS\Data\Range\__construct(), ILIAS\Data\Range\getStart(), ILIAS\Data\Range\unpack(), and ILIAS\Data\Range\withStart().

---

The documentation for this class was generated from the following file:

• src/Data/Range.php