seregazhuk\PinterestBot\Helpers\Pagination

Complexity

Total Complexity

21

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	8
Bugs	3	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	callProviderRequest()	0	13	2
B	paginate()	0	16	5
A	getDataFromPaginatedResponse()	0	10	2
A	responseHasData()	0	4	2
A	reachBatchesLimit()	0	4	2
A	clearResponseFromMetaData()	0	8	3
A	getBookMarks()	0	6	2
A	checkEndBookMarks()	0	4	2

<?php

namespace seregazhuk\PinterestBot\Helpers;

use seregazhuk\PinterestBot\Api\Providers\Provider;

class Pagination
{
    /**
     * @var Provider
     */
    private $provider;

    /**
     * @var array
     */
    protected $bookmarks = [];

    public function __construct(Provider $provider)
    {
        $this->provider = $provider;
    }

    /**
     * Iterate through results of Api function call. By
     * default generator will return all pagination results.
     * To limit result batches, set $batchesLimit. Call function
     * of object to get data.
     *
     * @param string $method
     * @param array $params
     * @param int $batchesLimit
     * @return \Iterator
     */
    public function paginate($method, $params, $batchesLimit = 0)
    {
        $batchesNum = 0;
        do {
            $results = $this->callProviderRequest($method, $params);
            if (empty($results) || $this->checkEndBookMarks()) {
                return;
            }

            $batchesNum++;
            foreach ($results as $result) {
                yield $result;
            }

        } while (!$this->reachBatchesLimit($batchesLimit, $batchesNum));
    }

    protected function callProviderRequest($method, array $params)
    {
        $params['bookmarks'] = $this->bookmarks;
        $response = call_user_func_array([$this->provider, $method], $params);

        if ($this->responseHasData($response)) {
            $this->getBookMarks($response);

            return $this->getDataFromPaginatedResponse($response);
        }

        return [];
    }

    protected function getDataFromPaginatedResponse($response)
    {
        if ($this->responseHasData($response)) {
            $res = $this->clearResponseFromMetaData($response);

            return $res['data'];
        }

        return [];
    }

    /**
     * @param array $response
     *
     * @return bool
     */
    protected function responseHasData($response)
    {
        return isset($response['data']) && !empty($response['data']);
    }

    /**
     * Check if we get batches limit in pagination.
     *
     * @param int $batchesLimit
     * @param int $batchesNum
     *
     * @return bool
     */
    protected function reachBatchesLimit($batchesLimit, $batchesNum)
    {
        return $batchesLimit && $batchesNum >= $batchesLimit;
    }

    /**
     * Remove 'module' data from response.
     *
     * @param array $response
     *
     * @return array mixed
     */
    protected function clearResponseFromMetaData($response)
    {
        if (isset($response['data'][0]['type']) && $response['data'][0]['type'] == 'module') {
            array_shift($response['data']);
        }

        return $response;
    }

    /**
     * @param $response
     *
     * @return array
     */
    protected function getBookMarks($response)
    {
        $this->bookmarks = isset($response['bookmarks']) ? $response['bookmarks'] : [];

        return $this;
    }

    protected function checkEndBookMarks()
    {
        return !empty($this->bookmarks) && $this->bookmarks[0] == '-end-';
    }
}