seregazhuk\PinterestBot\Helpers\Providers\Traits\Searchable

Complexity

Total Complexity

6

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
	getScope()	0	1	?
A	searchCall()	0	8	1
A	searchWithPagination()	0	9	1
A	createSearchQuery()	0	9	1
A	search()	0	4	1
A	appendBookMarks()	0	20	2

<?php

namespace seregazhuk\PinterestBot\Helpers\Providers\Traits;

use seregazhuk\PinterestBot\Api\Request;
use seregazhuk\PinterestBot\Helpers\Pagination;
use seregazhuk\PinterestBot\Helpers\UrlHelper;

trait Searchable
{
    use ProviderTrait;

    private $moduleSearchPage = 'SearchPage';

    /**
     * @return string
     */
    abstract protected function getScope();

    /**
     * Executes search to API. Query - search string.
     *
     * @param string $query
     * @param string $scope
     * @param array  $bookmarks
     *
     * @return array
     */
    public function searchCall($query, $scope, $bookmarks = [])
    {
        $url = UrlHelper::getSearchUrl(!empty($bookmarks));
        $get = $this->createSearchQuery($query, $scope, $bookmarks);
        $response = $this->getRequest()->exec($url . '?' . $get);

        return $this->getResponse()->parseSearchResponse($response, !empty($bookmarks));
    }

    /**
     * Executes search to API with pagination.
     *
     * @param string $query
     * @param int    $batchesLimit
     *
     * @return \Iterator
     */
    public function searchWithPagination($query, $batchesLimit)
    {
        return (new Pagination($this))->getPaginatedData(
            'searchCall', [
            'query' => $query,
            'scope' => $this->getScope(),
        ], $batchesLimit
        );
    }

    /**
     * Creates Pinterest API search request.
     *
     * @param       $query
     * @param       $scope
     * @param array $bookmarks
     *
     * @return array
     */
    public function createSearchQuery($query, $scope, $bookmarks = [])
    {
        $options = ['scope' => $scope, 'query' => $query];
        $dataJson = $this->appendBookMarks($bookmarks, $options);

        return Request::createQuery(
            $dataJson, "/search/$scope/?q=".$query
        );
    }

    /**
     * Search entities by search query.
     *
     * @param string $query
     * @param int    $batchesLimit
     *
     * @return \Iterator
     */
    public function search($query, $batchesLimit = 0)
    {
        return $this->searchWithPagination($query, $batchesLimit);
    }

    /**
     * @param $bookmarks
     * @param $options
     *
     * @return array
     */
    protected function appendBookMarks($bookmarks, $options)
    {
        $dataJson = ['options' => $options];
        if (!empty($bookmarks)) {
            $dataJson['options']['bookmarks'] = $bookmarks;

            return $dataJson;
        } else {
            $dataJson = array_merge(
                $dataJson, [
                    'module' => [
                        'name'    => $this->moduleSearchPage,
                        'options' => $options,
                    ],
                ]
            );

            return $dataJson;
        }
    }
}