Cheetah
Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
Facebook\FacebookClient Class Reference

Public Member Functions

 __construct (FacebookHttpClientInterface $httpClientHandler=null, $enableBeta=false)
 
 setHttpClientHandler (FacebookHttpClientInterface $httpClientHandler)
 
 getHttpClientHandler ()
 
 detectHttpClientHandler ()
 
 enableBetaMode ($betaMode=true)
 
 getBaseGraphUrl ($postToVideoUrl=false)
 
 prepareRequestMessage (FacebookRequest $request)
 
 sendRequest (FacebookRequest $request)
 
 sendBatchRequest (FacebookBatchRequest $request)
 

Public Attributes

const BASE_GRAPH_URL = 'https://graph.facebook.com'
 
const BASE_GRAPH_VIDEO_URL = 'https://graph-video.facebook.com'
 
const BASE_GRAPH_URL_BETA = 'https://graph.beta.facebook.com'
 
const BASE_GRAPH_VIDEO_URL_BETA = 'https://graph-video.beta.facebook.com'
 
const DEFAULT_REQUEST_TIMEOUT = 60
 
const DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT = 3600
 
const DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT = 7200
 

Static Public Attributes

static $requestCount = 0
 

Protected Attributes

 $enableBetaMode = false
 
 $httpClientHandler
 

Detailed Description

Definition at line 36 of file FacebookClient.php.

Constructor & Destructor Documentation

◆ __construct()

Facebook\FacebookClient::__construct ( FacebookHttpClientInterface  $httpClientHandler = null,
  $enableBeta = false 
)

Instantiates a new FacebookClient object.

Parameters
FacebookHttpClientInterface | null$httpClientHandler
boolean$enableBeta

Definition at line 94 of file FacebookClient.php.

Member Function Documentation

◆ detectHttpClientHandler()

Facebook\FacebookClient::detectHttpClientHandler ( )

Detects which HTTP client handler to use.

Returns
FacebookHttpClientInterface

Definition at line 125 of file FacebookClient.php.

◆ enableBetaMode()

Facebook\FacebookClient::enableBetaMode (   $betaMode = true)

Toggle beta mode.

Parameters
boolean$betaMode

Definition at line 135 of file FacebookClient.php.

◆ getBaseGraphUrl()

Facebook\FacebookClient::getBaseGraphUrl (   $postToVideoUrl = false)

Returns the base Graph URL.

Parameters
boolean$postToVideoUrlPost to the video API if videos are being uploaded.
Returns
string

Definition at line 147 of file FacebookClient.php.

◆ getHttpClientHandler()

Facebook\FacebookClient::getHttpClientHandler ( )

Returns the HTTP client handler.

Returns
FacebookHttpClientInterface

Definition at line 115 of file FacebookClient.php.

◆ prepareRequestMessage()

Facebook\FacebookClient::prepareRequestMessage ( FacebookRequest  $request)

Prepares the request for sending to the client handler.

Parameters
FacebookRequest$request
Returns
array

Definition at line 163 of file FacebookClient.php.

◆ sendBatchRequest()

Facebook\FacebookClient::sendBatchRequest ( FacebookBatchRequest  $request)

Makes a batched request to Graph and returns the result.

Parameters
FacebookBatchRequest$request
Returns
FacebookBatchResponse
Exceptions
FacebookSDKException

Definition at line 243 of file FacebookClient.php.

◆ sendRequest()

Facebook\FacebookClient::sendRequest ( FacebookRequest  $request)

Makes the request to Graph and returns the result.

Parameters
FacebookRequest$request
Returns
FacebookResponse
Exceptions
FacebookSDKException

Definition at line 198 of file FacebookClient.php.

◆ setHttpClientHandler()

Facebook\FacebookClient::setHttpClientHandler ( FacebookHttpClientInterface  $httpClientHandler)

Sets the HTTP client handler.

Parameters
FacebookHttpClientInterface$httpClientHandler

Definition at line 105 of file FacebookClient.php.

Member Data Documentation

◆ $enableBetaMode

Facebook\FacebookClient::$enableBetaMode = false
protected

Definition at line 76 of file FacebookClient.php.

◆ $httpClientHandler

Facebook\FacebookClient::$httpClientHandler
protected

Definition at line 81 of file FacebookClient.php.

◆ $requestCount

Facebook\FacebookClient::$requestCount = 0
static

Definition at line 86 of file FacebookClient.php.

◆ BASE_GRAPH_URL

const Facebook\FacebookClient::BASE_GRAPH_URL = 'https://graph.facebook.com'

@const string Production Graph API URL.

Definition at line 41 of file FacebookClient.php.

◆ BASE_GRAPH_URL_BETA

const Facebook\FacebookClient::BASE_GRAPH_URL_BETA = 'https://graph.beta.facebook.com'

@const string Beta Graph API URL.

Definition at line 51 of file FacebookClient.php.

◆ BASE_GRAPH_VIDEO_URL

const Facebook\FacebookClient::BASE_GRAPH_VIDEO_URL = 'https://graph-video.facebook.com'

@const string Graph API URL for video uploads.

Definition at line 46 of file FacebookClient.php.

◆ BASE_GRAPH_VIDEO_URL_BETA

const Facebook\FacebookClient::BASE_GRAPH_VIDEO_URL_BETA = 'https://graph-video.beta.facebook.com'

@const string Beta Graph API URL for video uploads.

Definition at line 56 of file FacebookClient.php.

◆ DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT

const Facebook\FacebookClient::DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT = 3600

@const int The timeout in seconds for a request that contains file uploads.

Definition at line 66 of file FacebookClient.php.

◆ DEFAULT_REQUEST_TIMEOUT

const Facebook\FacebookClient::DEFAULT_REQUEST_TIMEOUT = 60

@const int The timeout in seconds for a normal request.

Definition at line 61 of file FacebookClient.php.

◆ DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT

const Facebook\FacebookClient::DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT = 7200

@const int The timeout in seconds for a request that contains video uploads.

Definition at line 71 of file FacebookClient.php.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.20