Inheritance diagram for Facebook\FacebookRequest:

Public Member Functions
	__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 ()

Static Public Member Functions
static	getDefaultHeaders ()

Protected Attributes
	$app

	$accessToken

	$method

	$endpoint

	$headers = []

	$params = []

	$files = []

	$eTag

	$graphVersion

Detailed Description

Definition at line 39 of file FacebookRequest.php.

Constructor & Destructor Documentation

◆ __construct()

Facebook\FacebookRequest::__construct	(	FacebookApp	$app = `null`,
			$accessToken = `null`,
			$method = `null`,
			$endpoint = `null`,
		array	$params = `[]`,
			$eTag = `null`,
			$graphVersion = `null`
	)

Creates a new Request entity.

Parameters

FacebookApp \| null	$app
AccessToken \| string \| null	$accessToken
string \| null	$method
string \| null	$endpoint
array \| null	$params
string \| null	$eTag
string \| null	$graphVersion

Definition at line 97 of file FacebookRequest.php.

Member Function Documentation

◆ addFile()

Facebook\FacebookRequest::addFile	(		$key,
		FacebookFile	$file
	)

Add a file to be uploaded.

Parameters

string	$key
FacebookFile	$file

Definition at line 385 of file FacebookRequest.php.

◆ containsFileUploads()

Facebook\FacebookRequest::containsFileUploads ( )

Let's us know if there is a file upload with this request.

Returns: boolean

Definition at line 413 of file FacebookRequest.php.

◆ containsVideoUploads()

Facebook\FacebookRequest::containsVideoUploads ( )

Let's us know if there is a video upload with this request.

Returns: boolean

Definition at line 423 of file FacebookRequest.php.

◆ dangerouslySetParams()

Facebook\FacebookRequest::dangerouslySetParams ( array $params = [] )

Set the params for this request without filtering them first.

Parameters

array $params

Returns: FacebookRequest

Definition at line 353 of file FacebookRequest.php.

◆ getAccessToken()

Facebook\FacebookRequest::getAccessToken ( )

Return the access token for this request.

Returns: string|null

Definition at line 151 of file FacebookRequest.php.

◆ getAccessTokenEntity()

Facebook\FacebookRequest::getAccessTokenEntity ( )

Return the access token for this request as an AccessToken entity.

Returns: AccessToken|null

Definition at line 161 of file FacebookRequest.php.

◆ getApp()

Facebook\FacebookRequest::getApp ( )

Return the FacebookApp entity used for this request.

Returns: FacebookApp

Definition at line 181 of file FacebookRequest.php.

◆ getAppSecretProof()

Facebook\FacebookRequest::getAppSecretProof ( )

Generate an app secret proof to sign this request.

Returns: string|null

Definition at line 191 of file FacebookRequest.php.

◆ getDefaultHeaders()

static Facebook\FacebookRequest::getDefaultHeaders ( )

static

Return the default headers that every request should use.

Returns: array

Definition at line 527 of file FacebookRequest.php.

◆ getEndpoint()

Facebook\FacebookRequest::getEndpoint ( )

Return the endpoint for this request.

Returns: string

Definition at line 278 of file FacebookRequest.php.

◆ getFiles()

Facebook\FacebookRequest::getFiles ( )

Get the list of files to be uploaded.

Returns: array

Definition at line 403 of file FacebookRequest.php.

◆ getGraphVersion()

Facebook\FacebookRequest::getGraphVersion ( )

The graph version used for this request.

Returns: string

Definition at line 495 of file FacebookRequest.php.

◆ getHeaders()

Facebook\FacebookRequest::getHeaders ( )

Generate and return the headers for this request.

Returns: array

Definition at line 289 of file FacebookRequest.php.

◆ getMethod()

Facebook\FacebookRequest::getMethod ( )

Return the HTTP method for this request.

Returns: string

Definition at line 228 of file FacebookRequest.php.

◆ getMultipartBody()

Facebook\FacebookRequest::getMultipartBody ( )

Returns the body of the request as multipart/form-data.

Returns: RequestBodyMultipart

Definition at line 439 of file FacebookRequest.php.

◆ getParams()

Facebook\FacebookRequest::getParams ( )

Generate and return the params for this request.

Returns: array

Definition at line 463 of file FacebookRequest.php.

◆ getPostParams()

Facebook\FacebookRequest::getPostParams ( )

Only return params on POST requests.

Returns: array

Definition at line 481 of file FacebookRequest.php.

◆ getUrl()

Facebook\FacebookRequest::getUrl ( )

Generate and return the URL for this request.

Returns: string

Definition at line 505 of file FacebookRequest.php.

◆ getUrlEncodedBody()

Facebook\FacebookRequest::getUrlEncodedBody ( )

Returns the body of the request as URL-encoded.

Returns: RequestBodyUrlEncoded

Definition at line 451 of file FacebookRequest.php.

◆ resetFiles()

Facebook\FacebookRequest::resetFiles ( )

Removes all the files from the upload queue.

Definition at line 393 of file FacebookRequest.php.

◆ sanitizeFileParams()

Facebook\FacebookRequest::sanitizeFileParams ( array $params )

Iterate over the params and pull out the file uploads.

Parameters

array $params

Returns: array

Definition at line 367 of file FacebookRequest.php.

◆ setAccessToken()

Facebook\FacebookRequest::setAccessToken ( $accessToken )

Set the access token for this request.

Parameters

AccessToken|string|null

Returns: FacebookRequest

Definition at line 115 of file FacebookRequest.php.

◆ setAccessTokenFromParams()

Facebook\FacebookRequest::setAccessTokenFromParams ( $accessToken )

Sets the access token with one harvested from a URL or POST params.

Parameters

string $accessToken The access token.

Returns: FacebookRequest

Exceptions

FacebookSDKException

Definition at line 134 of file FacebookRequest.php.

◆ setApp()

Facebook\FacebookRequest::setApp ( FacebookApp $app = null )

Set the FacebookApp entity used for this request.

Parameters

FacebookApp | null $app

Definition at line 171 of file FacebookRequest.php.

◆ setEndpoint()

Facebook\FacebookRequest::setEndpoint ( $endpoint )

Set the endpoint for this request.

Parameters

string

Returns: FacebookRequest

Exceptions

FacebookSDKException

Definition at line 258 of file FacebookRequest.php.

◆ setETag()

Facebook\FacebookRequest::setETag ( $eTag )

Sets the eTag value.

Parameters

string $eTag

Definition at line 315 of file FacebookRequest.php.

◆ setHeaders()

Facebook\FacebookRequest::setHeaders ( array $headers )

Set the headers for this request.

Parameters

array $headers

Definition at line 305 of file FacebookRequest.php.

◆ setMethod()

Facebook\FacebookRequest::setMethod ( $method )

Set the HTTP method for this request.

Parameters

string

Definition at line 218 of file FacebookRequest.php.

◆ setParams()

Facebook\FacebookRequest::setParams ( array $params = [] )

Set the params for this request.

Parameters

array $params

Returns: FacebookRequest

Exceptions

FacebookSDKException

Definition at line 329 of file FacebookRequest.php.

◆ validateAccessToken()

Facebook\FacebookRequest::validateAccessToken ( )

Validate that an access token exists for this request.

Exceptions

FacebookSDKException

Definition at line 205 of file FacebookRequest.php.

◆ validateMethod()

Facebook\FacebookRequest::validateMethod ( )

Validate that the HTTP method is set.

Exceptions

FacebookSDKException

Definition at line 238 of file FacebookRequest.php.

Member Data Documentation

◆ $accessToken

Facebook\FacebookRequest::$accessToken

protected

Definition at line 49 of file FacebookRequest.php.

◆ $app

Facebook\FacebookRequest::$app

protected

Definition at line 44 of file FacebookRequest.php.

◆ $endpoint

Facebook\FacebookRequest::$endpoint

protected

Definition at line 59 of file FacebookRequest.php.

◆ $eTag

Facebook\FacebookRequest::$eTag

protected

Definition at line 79 of file FacebookRequest.php.

◆ $files

Facebook\FacebookRequest::$files = []

protected

Definition at line 74 of file FacebookRequest.php.

◆ $graphVersion

Facebook\FacebookRequest::$graphVersion

protected

Definition at line 84 of file FacebookRequest.php.

◆ $headers

Facebook\FacebookRequest::$headers = []

protected

Definition at line 64 of file FacebookRequest.php.

◆ $method

Facebook\FacebookRequest::$method

protected

Definition at line 54 of file FacebookRequest.php.

◆ $params

Facebook\FacebookRequest::$params = []

protected

Definition at line 69 of file FacebookRequest.php.

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

plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFile()

◆ containsFileUploads()

◆ containsVideoUploads()

◆ dangerouslySetParams()

◆ getAccessToken()

◆ getAccessTokenEntity()

◆ getApp()

◆ getAppSecretProof()

◆ getDefaultHeaders()

◆ getEndpoint()

◆ getFiles()

◆ getGraphVersion()

◆ getHeaders()

◆ getMethod()

◆ getMultipartBody()

◆ getParams()

◆ getPostParams()

◆ getUrl()

◆ getUrlEncodedBody()

◆ resetFiles()

◆ sanitizeFileParams()

◆ setAccessToken()

◆ setAccessTokenFromParams()

◆ setApp()

◆ setEndpoint()

◆ setETag()

◆ setHeaders()

◆ setMethod()

◆ setParams()

◆ validateAccessToken()

◆ validateMethod()

Member Data Documentation

◆ $accessToken

◆ $app

◆ $endpoint

◆ $eTag

◆ $files

◆ $graphVersion

◆ $headers

◆ $method

◆ $params