PHP Class Instagram\API\Request\BaseRequest

Inheritance: extends Instagram\API\Framework\Request
Datei anzeigen Open project: liamcottle/instagram-sdk-php Class Usage Examples

Public Properties

Property Type Description
$instagram Instagram\Instagram

Public Methods

Method Description
__construct ( $instagram )
execute ( ) : object Execute the Request
getCachedResponse ( )
getEndpoint ( ) : string
getResponseObject ( ) : object
getUrl ( )
interceptResponse ( $response ) : boolean This method will be called before checking the Response is OK.
parseResponse ( )
setInstagram ( $instagram )
setSignedBody ( $params )
throwExceptionIfResponseNotOk ( )

Method Details

__construct() public method

public __construct ( $instagram )
$instagram Instagram The Instagram instance to make the Request with.

execute() public method

Execute the Request
public execute ( ) : object
return object Response Data

getCachedResponse() public method

public getCachedResponse ( )

getEndpoint() abstract public method

abstract public getEndpoint ( ) : string
return string The API Endpoint

getResponseObject() abstract public method

abstract public getResponseObject ( ) : object
return object The class instance to map the JSON to.

getUrl() public method

public getUrl ( )

interceptResponse() public method

This method will be called before checking the Response is OK.
public interceptResponse ( $response ) : boolean
$response Response
return boolean If the Response was intercepted, and should stop being processed.

parseResponse() public method

public parseResponse ( )

setInstagram() public method

public setInstagram ( $instagram )
$instagram Instagram Instagram Instance to use for this Request

setSignedBody() public method

public setSignedBody ( $params )
$params array Parameters to add to Signed Body

throwExceptionIfResponseNotOk() public method

Property Details

$instagram public_oe property

public Instagram,Instagram $instagram
return Instagram\Instagram