Facebook\SignedRequest Class Reference

Public Member Functions
	__construct (FacebookApp $facebookApp, $rawSignedRequest=null)
	getRawSignedRequest ()
	getPayload ()
	get ($key, $default=null)
	getUserId ()
	hasOAuthData ()
	make (array $payload)
	base64UrlDecode ($input)
	base64UrlEncode ($input)

Protected Member Functions
	parse ()
	split ()
	decodeSignature ($encodedSig)
	decodePayload ($encodedPayload)
	validateAlgorithm ()
	hashSignature ($encodedData)
	validateSignature ($hashedSig, $sig)
	validateBase64 ($input)

Protected Attributes
	$app
	$rawSignedRequest
	$payload

Detailed Description

Definition at line 33 of file SignedRequest.php.

Constructor & Destructor Documentation

__construct()

Facebook\SignedRequest::__construct	(	FacebookApp	$facebookApp,
			$rawSignedRequest = null
	)

Instantiate a new SignedRequest entity.

Parameters

FacebookApp	$facebookApp	The FacebookApp entity.
string | null	$rawSignedRequest	The raw signed request.

Definition at line 56 of file SignedRequest.php.

Member Function Documentation

base64UrlDecode()

Facebook\SignedRequest::base64UrlDecode

(

$input

)

Base64 decoding which replaces characters:

• instead of - / instead of _

string $input base64 url encoded input string decoded string

Definition at line 289 of file SignedRequest.php.

base64UrlEncode()

Facebook\SignedRequest::base64UrlEncode

(

$input

)

Base64 encoding which replaces characters:

• instead of - / instead of _

string $input string to encode string base64 url encoded input

Definition at line 308 of file SignedRequest.php.

decodePayload()

Facebook\SignedRequest::decodePayload (   $encodedPayload )

protected

Decodes the raw payload from a signed request.

Parameters

string

$encodedPayload

Returns

array

Exceptions

FacebookSDKException

Definition at line 209 of file SignedRequest.php.

decodeSignature()

Facebook\SignedRequest::decodeSignature (   $encodedSig )

protected

Decodes the raw signature from a signed request.

Parameters

string

$encodedSig

Returns

string

Exceptions

FacebookSDKException

Definition at line 189 of file SignedRequest.php.

get()

Facebook\SignedRequest::get	(		$key,
			$default = null
	)

Returns a property from the signed request data if available.

Parameters

string	$key
mixed | null	$default

Returns

mixed|null

Definition at line 97 of file SignedRequest.php.

getPayload()

Facebook\SignedRequest::getPayload

(

)

Returns the parsed signed request data.

Returns

array|null

Definition at line 84 of file SignedRequest.php.

getRawSignedRequest()

Facebook\SignedRequest::getRawSignedRequest

(

)

Returns the raw signed request data.

Returns

string|null

Definition at line 74 of file SignedRequest.php.

getUserId()

Facebook\SignedRequest::getUserId

(

)

Returns user_id from signed request data if available.

Returns

string|null

Definition at line 111 of file SignedRequest.php.

hashSignature()

Facebook\SignedRequest::hashSignature (   $encodedData )

protected

Hashes the signature used in a signed request.

Parameters

string

$encodedData

Returns

string

Exceptions

FacebookSDKException

Definition at line 245 of file SignedRequest.php.

hasOAuthData()

Facebook\SignedRequest::hasOAuthData

(

)

Checks for OAuth data in the payload.

Returns

boolean

Definition at line 121 of file SignedRequest.php.

make()

Facebook\SignedRequest::make

(

array

$payload

)

Creates a signed request from an array of data.

Parameters

array

$payload

Returns

string

Definition at line 133 of file SignedRequest.php.

parse()

Facebook\SignedRequest::parse ( )

protected

Validates and decodes a signed request and saves the payload to an array.

Definition at line 149 of file SignedRequest.php.

split()

Facebook\SignedRequest::split ( )

protected

Splits a raw signed request into signature and payload.

Returns

array

Exceptions

FacebookSDKException

Definition at line 171 of file SignedRequest.php.

validateAlgorithm()

Facebook\SignedRequest::validateAlgorithm ( )

protected

Validates the algorithm used in a signed request.

Exceptions

FacebookSDKException

Definition at line 229 of file SignedRequest.php.

validateBase64()

Facebook\SignedRequest::validateBase64 (   $input )

protected

Validates a base64 string.

Parameters

string

$input

base64 value to validate

Exceptions

FacebookSDKException

Definition at line 320 of file SignedRequest.php.

validateSignature()

Facebook\SignedRequest::validateSignature (   $hashedSig,   $sig  )

protected

Validates the signature used in a signed request.

Parameters

string	$hashedSig
string	$sig

Exceptions

FacebookSDKException

Definition at line 269 of file SignedRequest.php.

Member Data Documentation

$app

Facebook\SignedRequest::$app

protected

Definition at line 38 of file SignedRequest.php.

$payload

Facebook\SignedRequest::$payload

protected

Definition at line 48 of file SignedRequest.php.

$rawSignedRequest

Facebook\SignedRequest::$rawSignedRequest

protected

Definition at line 43 of file SignedRequest.php.

---

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

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