Guillermoandrae\DynamoDb\Contract\LimitAwareOperationTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setOffset()	0	4	1
A	setLimit()	0	4	1
A	toArray()	0	4	1

<?php

namespace Guillermoandrae\DynamoDb\Contract;

/**
 * Trait for limit aware operations.
 *
 * @author Guillermo A. Fisher <me@guillermoandraefisher.com>
 */
trait LimitAwareOperationTrait
{
    /**
     * @var int The result offset.
     */
    protected $offset = 0;

    /**
     * @var int|null The result limit.
     */
    protected $limit;

    /**
     * Registers the result offset with this object.
     *
     * @param integer $offset The result offset.
     * @return mixed An implementation of this trait.
     */
    final public function setOffset(int $offset)
    {
        $this->offset = $offset;
        return $this;
    }

    /**
     * Registers the result limit with this object.
     *
     * @param integer|null $limit The result limit.
     * @return mixed An implementation of this trait.
     */
    final public function setLimit(?int $limit)
    {
        $this->limit = $limit;
        return $this;
    }

    public function toArray(): array
    {
        return [
            'Limit' => $this->offset + $this->limit
        ];
    }
}