PHP Class DirkGroenen\Pinterest\Pinterest

Show file Open project: dirkgroenen/pinterest-api-php Class Usage Examples

Public Properties

Property	Type	Description
$auth	DirkGroenen\Pinterest\Auth\PinterestOAuth	Reference to authentication class instance
$request	DirkGroenen\Pinterest\Transport\Request	A reference to the request class which travels through the application

Public Methods

Method	Description
__construct ( string $client_id, string $client_secret, DirkGroenen\Pinterest\Utils\CurlBuilder $curlbuilder = null )	Constructor
__get ( string $endpoint ) : mixed	Get an Pinterest API endpoint
getRateLimit ( ) : integer	Get rate limit from the headers
getRateLimitRemaining ( ) : mixed	Get rate limit remaining from the headers

Method Details

__construct() public method

Constructor

public __construct ( string $client_id, string $client_secret, DirkGroenen\Pinterest\Utils\CurlBuilder $curlbuilder = null )
$client_id	string
$client_secret	string
$curlbuilder	DirkGroenen\Pinterest\Utils\CurlBuilder

__get() public method

Get an Pinterest API endpoint

public __get ( string $endpoint ) : mixed
$endpoint	string
return	mixed

getRateLimit() public method

Get rate limit from the headers

public getRateLimit ( ) : integer
return	integer

getRateLimitRemaining() public method

Get rate limit remaining from the headers

public getRateLimitRemaining ( ) : mixed
return	mixed

Property Details

$auth public property

Reference to authentication class instance

public PinterestOAuth,DirkGroenen\Pinterest\Auth $auth
return	DirkGroenen\Pinterest\Auth\PinterestOAuth

$request public property

A reference to the request class which travels through the application

public Request,DirkGroenen\Pinterest\Transport $request
return	DirkGroenen\Pinterest\Transport\Request