Facebook\FacebookBatchRequest Class Reference

Inheritance diagram for Facebook\FacebookBatchRequest:

Public Member Functions
	__construct (FacebookApp $app=null, array $requests=[], $accessToken=null, $graphVersion=null)
	add ($request, $options=null)
	addFallbackDefaults (FacebookRequest $request)
	extractFileAttachments (FacebookRequest $request)
	getRequests ()
	prepareRequestsForBatch ()
	convertRequestsToJson ()
	validateBatchRequestCount ()
	requestEntityToBatchArray (FacebookRequest $request, $options=null, $attachedFiles=null)
	getIterator ()
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from Facebook\FacebookRequest
	__construct (FacebookApp $app=null, $accessToken=null, $method=null, $endpoint=null, array $params=[], $eTag=null, $graphVersion=null)
	setAccessToken ($accessToken)
	setAccessTokenFromParams ($accessToken)
	getAccessToken ()
	getAccessTokenEntity ()
	setApp (FacebookApp $app=null)
	getApp ()
	getAppSecretProof ()
	validateAccessToken ()
	setMethod ($method)
	getMethod ()
	validateMethod ()
	setEndpoint ($endpoint)
	getEndpoint ()
	getHeaders ()
	setHeaders (array $headers)
	setETag ($eTag)
	setParams (array $params=[])
	dangerouslySetParams (array $params=[])
	sanitizeFileParams (array $params)
	addFile ($key, FacebookFile $file)
	resetFiles ()
	getFiles ()
	containsFileUploads ()
	containsVideoUploads ()
	getMultipartBody ()
	getUrlEncodedBody ()
	getParams ()
	getPostParams ()
	getGraphVersion ()
	getUrl ()

Protected Attributes
	$requests
	$attachedFiles
Protected Attributes inherited from Facebook\FacebookRequest
	$app
	$accessToken
	$method
	$endpoint
	$headers = []
	$params = []
	$files = []
	$eTag
	$graphVersion

Additional Inherited Members
Static Public Member Functions inherited from Facebook\FacebookRequest
static	getDefaultHeaders ()

Detailed Description

Definition at line 37 of file FacebookBatchRequest.php.

Constructor & Destructor Documentation

__construct()

Facebook\FacebookBatchRequest::__construct	(	FacebookApp	$app = null,
		array	$requests = [],
			$accessToken = null,
			$graphVersion = null
	)

Creates a new Request entity.

Parameters

FacebookApp | null	$app
array	$requests
AccessToken | string | null	$accessToken
string | null	$graphVersion

Definition at line 57 of file FacebookBatchRequest.php.

Member Function Documentation

add()

Facebook\FacebookBatchRequest::add	(		$request,
			$options = null
	)

Adds a new request to the array.

Parameters

FacebookRequest | array	$request
string | null | array	$options	Array of batch request options e.g. 'name', 'omit_response_on_success'. If a string is given, it is the value of the 'name' option.

Returns

FacebookBatchRequest

Exceptions

Definition at line 75 of file FacebookBatchRequest.php.

addFallbackDefaults()

Facebook\FacebookBatchRequest::addFallbackDefaults

(

FacebookRequest

$request

)

Ensures that the FacebookApp and access token fall back when missing.

Parameters

FacebookRequest

$request

Exceptions

FacebookSDKException

Definition at line 123 of file FacebookBatchRequest.php.

convertRequestsToJson()

Facebook\FacebookBatchRequest::convertRequestsToJson

(

)

Converts the requests into a JSON(P) string.

Returns

string

Definition at line 200 of file FacebookBatchRequest.php.

extractFileAttachments()

Facebook\FacebookBatchRequest::extractFileAttachments

(

FacebookRequest

$request

)

Extracts the files from a request.

Parameters

FacebookRequest

$request

Returns

string|null

Exceptions

FacebookSDKException

Definition at line 151 of file FacebookBatchRequest.php.

getIterator()

Facebook\FacebookBatchRequest::getIterator

(

)

Get an iterator for the items.

Returns

ArrayIterator

Definition at line 286 of file FacebookBatchRequest.php.

getRequests()

Facebook\FacebookBatchRequest::getRequests

(

)

Return the FacebookRequest entities.

Returns

array

Definition at line 176 of file FacebookBatchRequest.php.

offsetExists()

Facebook\FacebookBatchRequest::offsetExists

(

$offset

)

Definition at line 302 of file FacebookBatchRequest.php.

offsetGet()

Facebook\FacebookBatchRequest::offsetGet

(

$offset

)

Definition at line 318 of file FacebookBatchRequest.php.

offsetSet()

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

Definition at line 294 of file FacebookBatchRequest.php.

offsetUnset()

Facebook\FacebookBatchRequest::offsetUnset

(

$offset

)

Definition at line 310 of file FacebookBatchRequest.php.

prepareRequestsForBatch()

Facebook\FacebookBatchRequest::prepareRequestsForBatch

(

)

Prepares the requests to be sent as a batch request.

Definition at line 184 of file FacebookBatchRequest.php.

requestEntityToBatchArray()

Facebook\FacebookBatchRequest::requestEntityToBatchArray	(	FacebookRequest	$request,
			$options = null,
			$attachedFiles = null
	)

Converts a Request entity into an array that is batch-friendly.

Parameters

FacebookRequest	$request	The request entity to convert.
string | null | array	$options	Array of batch request options e.g. 'name', 'omit_response_on_success'. If a string is given, it is the value of the 'name' option.
string | null	$attachedFiles	Names of files associated with the request.

Returns

array

Definition at line 244 of file FacebookBatchRequest.php.

validateBatchRequestCount()

Facebook\FacebookBatchRequest::validateBatchRequestCount

(

)

Validate the request count before sending them as a batch.

Exceptions

FacebookSDKException

Definition at line 223 of file FacebookBatchRequest.php.

Member Data Documentation

$attachedFiles

Facebook\FacebookBatchRequest::$attachedFiles

protected

Definition at line 47 of file FacebookBatchRequest.php.

$requests

Facebook\FacebookBatchRequest::$requests

protected

Definition at line 42 of file FacebookBatchRequest.php.

---

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

• plugins/facebook-php-sdk/src/Facebook/FacebookBatchRequest.php