PHP Class seregazhuk\PinterestBot\Api\Providers\Pinners

Inheritance: extends Provider, use trait seregazhuk\PinterestBot\Api\Traits\Searchable, use trait seregazhuk\PinterestBot\Api\Traits\Followable
Datei anzeigen Open project: seregazhuk/php-pinterest-bot Class Usage Examples

Protected Properties

Property Type Description
$entityIdName
$followUrl
$followersFor
$followersUrl
$loginRequiredFor array
$searchScope
$unFollowUrl

Public Methods

Method Description
block ( string $username ) : boolean | Response
blockById ( integer $userId ) : boolean | Response
following ( string $username, string $type = UrlBuilder::FOLLOWING_PEOPLE, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator Get following info for pinner.
followingBoards ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
followingInterests ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
followingPeople ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
info ( string $username ) : array Get user info.
likes ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator Get pins that user likes.
pins ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator Get pinner pins.

Protected Methods

Method Description
paginate ( string $username, string $url, integer $limit ) : Traversable

Method Details

block() public method

public block ( string $username ) : boolean | Response
$username string
return boolean | seregazhuk\PinterestBot\Api\Response

blockById() public method

public blockById ( integer $userId ) : boolean | Response
$userId integer
return boolean | seregazhuk\PinterestBot\Api\Response

following() public method

Get following info for pinner.
public following ( string $username, string $type = UrlBuilder::FOLLOWING_PEOPLE, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$type string
$limit integer
return Iterator

followingBoards() public method

public followingBoards ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
return Iterator

followingInterests() public method

public followingInterests ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
return Iterator

followingPeople() public method

public followingPeople ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
return Iterator

info() public method

If username param is not specified, will return info for logged user.
public info ( string $username ) : array
$username string
return array

likes() public method

Get pins that user likes.
public likes ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
return Iterator

paginate() protected method

protected paginate ( string $username, string $url, integer $limit ) : Traversable
$username string
$url string
$limit integer
return Traversable

pins() public method

Get pinner pins.
public pins ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
return Iterator

Property Details

$entityIdName protected_oe property

protected $entityIdName

$followUrl protected_oe property

protected $followUrl

$followersFor protected_oe property

protected $followersFor

$followersUrl protected_oe property

protected $followersUrl

$loginRequiredFor protected_oe property

protected array $loginRequiredFor
return array

$searchScope protected_oe property

protected $searchScope

$unFollowUrl protected_oe property

protected $unFollowUrl