Cheetah: Facebook\Helpers\FacebookSignedRequestFromInputHelper Class Reference

Cheetah

Inheritance diagram for Facebook\Helpers\FacebookSignedRequestFromInputHelper:

Public Member Functions
	__construct (FacebookApp $app, FacebookClient $client, $graphVersion=null)

	instantiateSignedRequest ($rawSignedRequest=null)

	getAccessToken ()

	getSignedRequest ()

	getUserId ()

	getRawSignedRequest ()

	getRawSignedRequestFromPost ()

	getRawSignedRequestFromCookie ()

Protected Attributes
	$signedRequest

	$app

	$oAuth2Client

Detailed Description

Definition at line 38 of file FacebookSignedRequestFromInputHelper.php.

Constructor & Destructor Documentation

◆ __construct()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::__construct	(	FacebookApp	$app,
		FacebookClient	$client,
			$graphVersion = `null`
	)

Initialize the helper and process available signed request data.

Parameters

FacebookApp	$app	The FacebookApp entity.
FacebookClient	$client	The client to make HTTP requests.
string \| null	$graphVersion	The version of Graph to use.

Reimplemented in Facebook\Helpers\FacebookPageTabHelper.

Definition at line 62 of file FacebookSignedRequestFromInputHelper.php.

Member Function Documentation

◆ getAccessToken()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::getAccessToken ( )

Returns an AccessToken entity from the signed request.

Returns: AccessToken|null

Exceptions

Definition at line 94 of file FacebookSignedRequestFromInputHelper.php.

◆ getRawSignedRequest()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::getRawSignedRequest ( )

abstract

Get raw signed request from input.

Returns: string|null

Reimplemented in Facebook\Helpers\FacebookJavaScriptHelper, and Facebook\Helpers\FacebookCanvasHelper.

◆ getRawSignedRequestFromCookie()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::getRawSignedRequestFromCookie ( )

Get raw signed request from cookie set from the Javascript SDK.

Returns: string|null

Definition at line 158 of file FacebookSignedRequestFromInputHelper.php.

◆ getRawSignedRequestFromPost()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::getRawSignedRequestFromPost ( )

Get raw signed request from POST input.

Returns: string|null

Definition at line 144 of file FacebookSignedRequestFromInputHelper.php.

◆ getSignedRequest()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::getSignedRequest ( )

Returns the SignedRequest entity.

Returns: SignedRequest|null

Definition at line 117 of file FacebookSignedRequestFromInputHelper.php.

◆ getUserId()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::getUserId ( )

Returns the user_id if available.

Returns: string|null

Definition at line 127 of file FacebookSignedRequestFromInputHelper.php.

◆ instantiateSignedRequest()

Facebook\Helpers\FacebookSignedRequestFromInputHelper::instantiateSignedRequest ( $rawSignedRequest = null )

Instantiates a new SignedRequest entity.

Parameters

string|null

Definition at line 76 of file FacebookSignedRequestFromInputHelper.php.

Member Data Documentation

◆ $app

Facebook\Helpers\FacebookSignedRequestFromInputHelper::$app

protected

Definition at line 48 of file FacebookSignedRequestFromInputHelper.php.

◆ $oAuth2Client

Facebook\Helpers\FacebookSignedRequestFromInputHelper::$oAuth2Client

protected

Definition at line 53 of file FacebookSignedRequestFromInputHelper.php.

◆ $signedRequest

Facebook\Helpers\FacebookSignedRequestFromInputHelper::$signedRequest

protected

Definition at line 43 of file FacebookSignedRequestFromInputHelper.php.

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

plugins/facebook-php-sdk/src/Facebook/Helpers/FacebookSignedRequestFromInputHelper.php