PHP Класс seregazhuk\PinterestBot\Api\Providers\Pinners

Наследование: extends Provider, use trait seregazhuk\PinterestBot\Api\Traits\Searchable, use trait seregazhuk\PinterestBot\Api\Traits\Followable
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$entityIdName
$followUrl
$followersFor
$followersUrl
$loginRequiredFor array
$searchScope
$unFollowUrl

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
paginate ( string $username, string $url, integer $limit ) : Traversable

Описание методов

block() публичный Метод

public block ( string $username ) : boolean | Response
$username string
Результат boolean | seregazhuk\PinterestBot\Api\Response

blockById() публичный Метод

public blockById ( integer $userId ) : boolean | Response
$userId integer
Результат boolean | seregazhuk\PinterestBot\Api\Response

following() публичный Метод

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
Результат Iterator

followingBoards() публичный Метод

public followingBoards ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
Результат Iterator

followingInterests() публичный Метод

public followingInterests ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
Результат Iterator

followingPeople() публичный Метод

public followingPeople ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
Результат Iterator

info() публичный Метод

If username param is not specified, will return info for logged user.
public info ( string $username ) : array
$username string
Результат array

likes() публичный Метод

Get pins that user likes.
public likes ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
Результат Iterator

paginate() защищенный Метод

protected paginate ( string $username, string $url, integer $limit ) : Traversable
$username string
$url string
$limit integer
Результат Traversable

pins() публичный Метод

Get pinner pins.
public pins ( string $username, integer $limit = Pagination::DEFAULT_LIMIT ) : Iterator
$username string
$limit integer
Результат Iterator

Описание свойств

$entityIdName защищенное свойство

protected $entityIdName

$followUrl защищенное свойство

protected $followUrl

$followersFor защищенное свойство

protected $followersFor

$followersUrl защищенное свойство

protected $followersUrl

$loginRequiredFor защищенное свойство

protected array $loginRequiredFor
Результат array

$searchScope защищенное свойство

protected $searchScope

$unFollowUrl защищенное свойство

protected $unFollowUrl