fab2s\YaEtl\Extractors\ExtractorLimitAbstract

Complexity

Total Complexity

4

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setLimit()	0	5	1
A	getLimit()	0	3	1
A	isLimitReached()	0	3	2

<?php

/*
 * This file is part of YaEtl
 *     (c) Fabrice de Stefanis / https://github.com/fab2s/YaEtl
 * This source file is licensed under the MIT license which you will
 * find in the LICENSE file or at https://opensource.org/licenses/MIT
 */

namespace fab2s\YaEtl\Extractors;

/**
 * Class ExtractorLimitAbstract
 */
abstract class ExtractorLimitAbstract extends ExtractorAbstract implements ExtractorLimitInterface
{
    /**
     * Total number of records to fetch
     *
     * @var int
     */
    protected $limit;

    /**
     * Set extract limit
     *
     * @param int|null $limit
     *
     * @return static
     */
    public function setLimit(?int $limit): ExtractorLimitInterface
    {
        $this->limit = $limit;

        return $this;
    }

    /**
     * Get current limit
     *
     * @return int|null
     */
    public function getLimit(): ? int
    {
        return $this->limit;
    }

    /**
     * Tells if limit is reached already
     *
     * @return bool true if limit is reached
     */
    public function isLimitReached(): bool
    {
        return $this->limit && ($this->numRecords >= $this->limit);
    }
}