Limoncello\Flute\Models\PaginatedData

Complexity

Total Complexity

12

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getData()	0	4	1
A	isCollection()	0	4	1
A	markAsCollection()	0	6	1
A	markAsSingleItem()	0	6	1
A	hasMoreItems()	0	4	1
A	markHasMoreItems()	0	6	1
A	markHasNoMoreItems()	0	6	1
A	getOffset()	0	4	1
A	setOffset()	0	6	1
A	getLimit()	0	4	1
A	setLimit()	0	6	1

<?php declare (strict_types = 1);

namespace Limoncello\Flute\Models;

/**
 * Copyright 2015-2019 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Flute\Contracts\Models\PaginatedDataInterface;

/**
 * @package Limoncello\Flute
 */
class PaginatedData implements PaginatedDataInterface
{
    /** @var  mixed */
    private $data;

    /** @var  bool */
    private $isCollection = false;

    /** @var  bool */
    private $hasMoreItems = false;

    /** @var  int|null */
    private $offset = null;

    /** @var  int|null */
    private $size = null;

    /**
     * @param mixed $data
     */
    public function __construct($data)
    {
        $this->data = $data;
    }

    /**
     * @inheritdoc
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * @inheritdoc
     */
    public function isCollection(): bool
    {
        return $this->isCollection;
    }

    /**
     * @inheritdoc
     */
    public function markAsCollection(): PaginatedDataInterface
    {
        $this->isCollection = true;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function markAsSingleItem(): PaginatedDataInterface
    {
        $this->isCollection = false;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function hasMoreItems(): bool
    {
        return $this->hasMoreItems;
    }

    /**
     * @inheritdoc
     */
    public function markHasMoreItems(): PaginatedDataInterface
    {
        $this->hasMoreItems = true;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function markHasNoMoreItems(): PaginatedDataInterface
    {
        $this->hasMoreItems = false;

        return $this;
    }

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

    /**
     * @inheritdoc
     */
    public function setOffset(int $offset = null): PaginatedDataInterface
    {
        $this->offset = $offset;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getLimit(): ?int
    {
        return $this->size;
    }

    /**
     * @inheritdoc
     */
    public function setLimit(int $size = null): PaginatedDataInterface
    {
        $this->size = $size;

        return $this;
    }
}