PHP Trait seregazhuk\PinterestBot\Api\Traits\Searchable

Inheritance: use trait HandlesRequest
Show file Open project: seregazhuk/php-pinterest-bot

Protected Properties

Property Type Description
$moduleSearchPage

Public Methods

Method Description
search ( string $query, integer $limit = Pagination::DEFAULT_LIMIT ) : Traversable Search entities by search query.
searchCall ( string $query, string $scope, array $bookmarks = [] ) : SearchResponse Executes search to API. Query - search string.

Protected Methods

Method Description
appendBookMarks ( array $bookmarks, array $options ) : array
createSearchQuery ( string $query, string $scope, array $bookmarks = [] ) : string Creates Pinterest API search request.
getSearchScope ( ) : string
processResult ( string $res ) : Response

Method Details

appendBookMarks() protected method

protected appendBookMarks ( array $bookmarks, array $options ) : array
$bookmarks array
$options array
return array

createSearchQuery() protected method

Creates Pinterest API search request.
protected createSearchQuery ( string $query, string $scope, array $bookmarks = [] ) : string
$query string
$scope string
$bookmarks array
return string

getSearchScope() protected method

protected getSearchScope ( ) : string
return string

processResult() abstract protected method

abstract protected processResult ( string $res ) : Response
$res string
return seregazhuk\PinterestBot\Api\Response

searchCall() public method

Executes search to API. Query - search string.
public searchCall ( string $query, string $scope, array $bookmarks = [] ) : SearchResponse
$query string
$scope string
$bookmarks array
return seregazhuk\PinterestBot\Api\SearchResponse

Property Details

$moduleSearchPage protected property

protected $moduleSearchPage