HOME

<?php

/**
 * @file classes/db/DBResultRange.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class DBResultRange
 *
 * @ingroup db
 *
 * @brief Container class for range information when retrieving a result set.
 */

namespace PKP\db;

class DBResultRange
{
    /** @var int The number of items to display */
    public $count;

    /** @var int The number of pages to skip */
    public $page;

    /** @var int Optional offset if pagination is not used. */
    public $offset;

    /**
     * Constructor.
     * Initialize the DBResultRange.
     *
     * @param null|mixed $offset
     */
    public function __construct($count, $page = 1, $offset = null)
    {
        $this->count = $count;
        $this->page = $page;
        $this->offset = $offset;
    }

    /**
     * Checks to see if the DBResultRange is valid.
     *
     * @return bool
     */
    public function isValid()
    {
        return (($this->count > 0) && ($this->page >= 0))
                || ($this->count > 0 && !is_null($this->offset));
    }

    /**
     * Returns the count of pages to skip.
     *
     * @return int
     */
    public function getPage()
    {
        return $this->page;
    }

    /**
     * Set the count of pages to skip.
     *
     * @param int $page
     */
    public function setPage($page)
    {
        $this->page = $page;
    }

    /**
     * Returns the count of items in this range to display.
     *
     * @return int
     */
    public function getCount()
    {
        return $this->count;
    }

    /**
     * Set the count of items in this range to display.
     *
     * @param int $count
     */
    public function setCount($count)
    {
        $this->count = $count;
    }

    /**
     * Returns the offset of items in this range to display.
     *
     * @return int
     */
    public function getOffset()
    {
        return $this->offset;
    }

    /**
     * Set the offset of items in this range to display.
     *
     * @param int $offset
     */
    public function setOffset($offset)
    {
        $this->offset = $offset;
    }
}

if (!PKP_STRICT_MODE) {
    class_alias('\PKP\db\DBResultRange', '\DBResultRange');
}