seregazhuk\PinterestBot\Helpers\Providers\PaginationHelper

Complexity

Total Complexity

19

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	4
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getBookMarks()	0	4	2
A	getPaginatedResponse()	0	9	2
A	getDataFromPaginatedResponse()	0	10	2
A	responseHasData()	0	4	2
A	reachBatchesLimit()	0	4	2
A	clearResponseFromMetaData()	0	8	3
A	getPaginatedData()	0	16	4
A	checkEndBookMarks()	0	4	2

<?php

namespace seregazhuk\PinterestBot\Helpers\Providers;

trait PaginationHelper
{
    /**
     * 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 callable $callback
     * @param array    $params
     * @param int      $batchesLimit
     * @return \Iterator
     */
    public function getPaginatedData($callback, $params, $batchesLimit = 0)
    {
        $batchesNum = 0;
        do {
            $response = self::getPaginatedResponse($callback, $params);
            $items = self::getDataFromPaginatedResponse($response);
            if (empty($items)) return;

            $batchesNum++;
            yield $items;

            $params['bookmarks'] = self::getBookMarks($response);
            if ($this->checkEndBookMarks($params['bookmarks'])) return;

        } while ( ! self::reachBatchesLimit($batchesLimit, $batchesNum));
    }

    protected function getPaginatedResponse(callable $callback, array $params)
    {
        $response = call_user_func_array($callback, $params);
        if (self::responseHasData($response)) {
            return self::clearResponseFromMetaData($response);
        }

        return [];
    }

    protected function getDataFromPaginatedResponse($response)
    {
        if (self::responseHasData($response)) {
            $res = self::clearResponseFromMetaData($response);

            return $res['data'];
        }

        return [];
    }

    /**
     * @param array $res
     * @return bool
     */
    protected function responseHasData($res)
    {
        return isset($res['data']) && ! empty($res['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 $res
     * @return array mixed
     */
    protected function clearResponseFromMetaData($res)
    {
        if (isset($res['data'][0]['type']) && $res['data'][0]['type'] == 'module') {
            array_shift($res['data']);
        }

        return $res;
    }

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

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