Lyal\Checkr\Traits\Listable

Complexity

Total Complexity

19

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Importance

Changes	5
Bugs	2	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setPerPage()	0	6	1
A	hasNextPage()	0	3	1
A	getList()	0	7	1
A	getPerPage()	0	3	1
A	getCount()	0	3	1
A	all()	0	10	3
A	nextPage()	0	3	1
A	processList()	0	12	3
A	setCount()	0	3	1
A	getCurrentPage()	0	3	1
A	setListPath()	0	3	1
A	getListPath()	0	3	1
A	setNextPage()	0	3	1
A	setPagination()	0	6	1
A	setCurrentPage()	0	6	1

<?php

namespace Lyal\Checkr\Traits;

trait Listable
{
    /**
     * Abstract functions to imppose requirements for the exhibiting class.
     */
    abstract public function getResourceName($object = null);

    abstract public function getAttributes($sanitized = true);

    abstract public function processPath($path = null, array $values = null);

    abstract public function postRequest($path, array $options = []);

    abstract public function getClient();

    abstract public function setValues($values);

    abstract public function getAttribute($key);

    abstract public function setAttribute($key, $value);

    abstract protected function getRequest($path = null, $parameters = null);

    abstract protected function __construct($values, $client);

    protected $listPath;

    private $perPage = 25;
    private $currentPage = 1;
    private $count;
    private $list = [];

    private $hasNextPage;

    public function setListPath($path)
    {
        $this->listPath = $path;
    }

    public function getListPath()
    {
        return $this->listPath;
    }

    /**
     * Number of results to return per request.
     *
     * @return int
     */
    public function getPerPage()
    {
        return $this->perPage;
    }

    /**
     * @param int $perPage
     *
     * @return $this
     */
    public function setPerPage(int $perPage)
    {
        $this->perPage = $perPage;
        $this->setAttribute('per_page', $perPage);

        return $this;
    }

    /**
     * @param int $currentPage
     *
     * @return $this
     */
    public function setCurrentPage(int $currentPage)
    {
        $this->currentPage = $currentPage;
        $this->setAttribute('page', $currentPage);

        return $this;
    }

    /**
     * @return int
     */
    public function getCurrentPage()
    {
        return $this->currentPage;
    }

    public function nextPage()
    {
        return ++$this->currentPage;
    }

    public function getCount()
    {
        return $this->count;
    }

    public function setCount($count)
    {
        return $this->count = $count;
    }

    public function setPagination($page = null, $perPage = null)
    {
        $this->setCurrentPage($page ?? $this->getCurrentPage());
        $this->setPerPage($perPage ?? $this->getPerPage());

        return $this;
    }

    public function hasNextPage()
    {
        return $this->hasNextPage !== false;
    }

    public function setNextPage()
    {
        return $this->hasNextPage = (($this->getPerPage() * $this->getCurrentPage()) < $this->getCount());
    }

    public function getList($page = null, $perPage = null)
    {
        $this->setPagination($page, $perPage);

        $path = $this->getListPath() ?? null;

        return $this->processList($this->getRequest($this->processPath($path)));
    }

    /**
     * @param \stdClass $items
     *
     * @return \Illuminate\Support\Collection|array
     */
    public function processList($items)
    {
        $list = [];

        $this->setCount($items->count);
        $this->setNextPage();

        foreach ((array) $items->data as $item) {
            $list[] = new $this($item, $this->getClient());
        }

        return $this->getClient()->useCollections ? collect($list) : $list;
    }

    public function all()
    {
        $list = collect([]);

        while ($this->hasNextPage()) {
            $list = $list->merge($this->getList());
            $this->nextPage();
        }

        return $this->getClient()->useCollections ? $list : $list->toArray();
    }
}