PHP Class Instagram\API\Framework\Request

Datei anzeigen Open project: liamcottle/instagram-sdk-php Class Usage Examples

Public Properties

Property Type Description
$mapper JsonMapper Used for Mapping response Json to Class instances.

Public Methods

Method Description
__construct ( )
addCookie ( $key, $value ) Add Cookie to the Request
addFile ( $key, $file ) Add File to the Request
addHeader ( $key, $value ) Add Header to the Request
addParam ( $key, $value ) Add Parameter to the Request
clearCookies ( )
clearHeaders ( )
clearParams ( )
execute ( ) : Response Execute the Request
getCookies ( ) : array
getHeaders ( ) : array
getMethod ( ) : string
getParams ( ) : array
getUrl ( ) : string
setProxy ( $proxy ) Set Proxy to be used for Requests
setProxyCredentials ( $credentials ) Set Proxy Credentials to be used for Requests
setVerifyPeer ( $verifyPeer ) Enable/Disable SSL Verification of Peer

Method Details

__construct() public method

public __construct ( )

addCookie() public method

Add Cookie to the Request
public addCookie ( $key, $value )
$key string Cookie Key
$value string Cookie Value

addFile() public method

Add File to the Request
public addFile ( $key, $file )
$key string File Key
$file RequestFile

addHeader() public method

Add Header to the Request
public addHeader ( $key, $value )
$key string Header Key
$value string Header Value

addParam() public method

Add Parameter to the Request
public addParam ( $key, $value )
$key string Parameter Key
$value string Parameter Value

clearCookies() public method

public clearCookies ( )

clearHeaders() public method

public clearHeaders ( )

clearParams() public method

public clearParams ( )

execute() public method

Execute the Request
public execute ( ) : Response
return Response The Response

getCookies() public method

public getCookies ( ) : array
return array Request Cookies

getHeaders() public method

public getHeaders ( ) : array
return array Request Headers

getMethod() abstract public method

abstract public getMethod ( ) : string
return string Request Method

getParams() public method

public getParams ( ) : array
return array Request Parameters

getUrl() abstract public method

abstract public getUrl ( ) : string
return string Request Url

setProxy() public method

Set Proxy to be used for Requests
public setProxy ( $proxy )
$proxy string

setProxyCredentials() public method

Set Proxy Credentials to be used for Requests
public setProxyCredentials ( $credentials )
$credentials string

setVerifyPeer() public method

Enable/Disable SSL Verification of Peer
public setVerifyPeer ( $verifyPeer )
$verifyPeer boolean

Property Details

$mapper public_oe property

Used for Mapping response Json to Class instances.
public JsonMapper $mapper
return JsonMapper