Cheetah
Public Member Functions | Protected Attributes | List of all members
Facebook\FacebookBatchResponse Class Reference
Inheritance diagram for Facebook\FacebookBatchResponse:
Facebook\FacebookResponse

Public Member Functions

 __construct (FacebookBatchRequest $batchRequest, FacebookResponse $response)
 
 getResponses ()
 
 setResponses (array $responses)
 
 addResponse ($key, $response)
 
 getIterator ()
 
 offsetSet ($offset, $value)
 
 offsetExists ($offset)
 
 offsetUnset ($offset)
 
 offsetGet ($offset)
 
- Public Member Functions inherited from Facebook\FacebookResponse
 __construct (FacebookRequest $request, $body=null, $httpStatusCode=null, array $headers=[])
 
 getRequest ()
 
 getApp ()
 
 getAccessToken ()
 
 getHttpStatusCode ()
 
 getHeaders ()
 
 getBody ()
 
 getDecodedBody ()
 
 getAppSecretProof ()
 
 getETag ()
 
 getGraphVersion ()
 
 isError ()
 
 throwException ()
 
 makeException ()
 
 getThrownException ()
 
 decodeBody ()
 
 getGraphObject ($subclassName=null)
 
 getGraphNode ($subclassName=null)
 
 getGraphAlbum ()
 
 getGraphPage ()
 
 getGraphSessionInfo ()
 
 getGraphUser ()
 
 getGraphEvent ()
 
 getGraphGroup ()
 
 getGraphList ($subclassName=null, $auto_prefix=true)
 
 getGraphEdge ($subclassName=null, $auto_prefix=true)
 

Protected Attributes

 $batchRequest
 
 $responses = []
 
- Protected Attributes inherited from Facebook\FacebookResponse
 $httpStatusCode
 
 $headers
 
 $body
 
 $decodedBody = []
 
 $request
 
 $thrownException
 

Detailed Description

Definition at line 35 of file FacebookBatchResponse.php.

Constructor & Destructor Documentation

◆ __construct()

Facebook\FacebookBatchResponse::__construct ( FacebookBatchRequest  $batchRequest,
FacebookResponse  $response 
)

Creates a new Response entity.

Parameters
FacebookBatchRequest$batchRequest
FacebookResponse$response

Definition at line 53 of file FacebookBatchResponse.php.

Member Function Documentation

◆ addResponse()

Facebook\FacebookBatchResponse::addResponse (   $key,
  $response 
)

Add a response to the list.

Parameters
int$key
array | null$response

Definition at line 98 of file FacebookBatchResponse.php.

◆ getIterator()

Facebook\FacebookBatchResponse::getIterator ( )

Definition at line 119 of file FacebookBatchResponse.php.

◆ getResponses()

Facebook\FacebookBatchResponse::getResponses ( )

Returns an array of FacebookResponse entities.

Returns
array

Definition at line 72 of file FacebookBatchResponse.php.

◆ offsetExists()

Facebook\FacebookBatchResponse::offsetExists (   $offset)

Definition at line 135 of file FacebookBatchResponse.php.

◆ offsetGet()

Facebook\FacebookBatchResponse::offsetGet (   $offset)

Definition at line 151 of file FacebookBatchResponse.php.

◆ offsetSet()

Facebook\FacebookBatchResponse::offsetSet (   $offset,
  $value 
)

Definition at line 127 of file FacebookBatchResponse.php.

◆ offsetUnset()

Facebook\FacebookBatchResponse::offsetUnset (   $offset)

Definition at line 143 of file FacebookBatchResponse.php.

◆ setResponses()

Facebook\FacebookBatchResponse::setResponses ( array  $responses)

The main batch response will be an array of requests so we need to iterate over all the responses.

Parameters
array$responses

Definition at line 83 of file FacebookBatchResponse.php.

Member Data Documentation

◆ $batchRequest

Facebook\FacebookBatchResponse::$batchRequest
protected

Definition at line 40 of file FacebookBatchResponse.php.

◆ $responses

Facebook\FacebookBatchResponse::$responses = []
protected

Definition at line 45 of file FacebookBatchResponse.php.


The documentation for this class was generated from the following file: