Level23\Druid\Limits\Limit

Complexity

Total Complexity

13

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setOffset()	0	3	1
A	getLimit()	0	3	1
A	setLimit()	0	3	1
A	__construct()	0	5	1
A	getOrderByCollection()	0	7	2
A	getOffset()	0	3	1
A	addOrderBy()	0	6	2
A	toArray()	0	14	4

<?php
declare(strict_types=1);

namespace Level23\Druid\Limits;

use Level23\Druid\OrderBy\OrderByInterface;
use Level23\Druid\Collections\OrderByCollection;

class Limit implements LimitInterface
{
    /**
     * @var int|null
     */
    protected $limit;

    /**
     * @var \Level23\Druid\Collections\OrderByCollection|null
     */
    protected $orderBy;

    /**
     * @var int|null
     */
    protected $offset;

    public function __construct(int $limit = null, OrderByCollection $orderBy = null, int $offset = null)
    {
        $this->limit   = $limit;
        $this->orderBy = $orderBy;
        $this->offset  = $offset;
    }

    /**
     * Return the limit in array format so that it can be used in a druid query.
     *
     * @return array
     */
    public function toArray(): array
    {
        $result = [
            'type'    => 'default',
            'columns' => ($this->orderBy ? $this->orderBy->toArray() : []),
        ];
        if ($this->limit !== null) {
            $result['limit'] = $this->limit;
        }
        if ($this->offset !== null) {
            $result['offset'] = $this->offset;
        }

        return $result;
    }

    /**
     * @param int $limit
     */
    public function setLimit(int $limit): void
    {
        $this->limit = $limit;
    }

    /**
     * Add an order by field to the collection.
     *
     * @param \Level23\Druid\OrderBy\OrderByInterface $orderBy
     */
    public function addOrderBy(OrderByInterface $orderBy)
    {
        if ($this->orderBy === null) {
            $this->orderBy = new OrderByCollection();
        }
        $this->orderBy->add($orderBy);
    }

    /**
     * Get the limit which is currently configured.
     *
     * @return int|null
     */
    public function getLimit(): ?int
    {
        return $this->limit;
    }

    /**
     * Return the fields which are used to sort the result by.
     *
     * @return \Level23\Druid\Collections\OrderByCollection
     */
    public function getOrderByCollection(): OrderByCollection
    {
        if (is_null($this->orderBy)) {
            return new OrderByCollection();
        }

        return $this->orderBy;
    }

    /**
     * @param int $offset
     */
    public function setOffset(int $offset): void
    {
        $this->offset = $offset;
    }

    /**
     * @return int|null
     */
    public function getOffset(): ?int
    {
        return $this->offset;
    }
}