Facebook\Authentication\OAuth2Client Class Reference

Public Member Functions
	__construct (FacebookApp $app, FacebookClient $client, $graphVersion=null)
	getLastRequest ()
	debugToken ($accessToken)
	getAuthorizationUrl ($redirectUrl, $state, array $scope=[], array $params=[], $separator='&')
	getAccessTokenFromCode ($code, $redirectUri='')
	getLongLivedAccessToken ($accessToken)
	getCodeFromLongLivedAccessToken ($accessToken, $redirectUri='')

Public Attributes
const	BASE_AUTHORIZATION_URL = 'https://www.facebook.com'

Protected Member Functions
	requestAnAccessToken (array $params)
	sendRequestWithClientParams ($endpoint, array $params, $accessToken=null)
	getClientParams ()

Protected Attributes
	$app
	$client
	$graphVersion
	$lastRequest

Detailed Description

Definition at line 39 of file OAuth2Client.php.

Constructor & Destructor Documentation

__construct()

Facebook\Authentication\OAuth2Client::__construct	(	FacebookApp	$app,
		FacebookClient	$client,
			$graphVersion = null
	)

Parameters

FacebookApp	$app
FacebookClient	$client
string | null	$graphVersion	The version of the Graph API to use.

Definition at line 79 of file OAuth2Client.php.

Member Function Documentation

debugToken()

Facebook\Authentication\OAuth2Client::debugToken

(

$accessToken

)

Get the metadata associated with the access token.

Parameters

AccessToken | string

$accessToken

The access token to debug.

Returns

AccessTokenMetadata

Definition at line 104 of file OAuth2Client.php.

getAccessTokenFromCode()

Facebook\Authentication\OAuth2Client::getAccessTokenFromCode	(		$code,
			$redirectUri = ''
	)

Get a valid access token from a code.

Parameters

string	$code
string	$redirectUri

Returns

AccessToken

Exceptions

FacebookSDKException

Definition at line 159 of file OAuth2Client.php.

getAuthorizationUrl()

Facebook\Authentication\OAuth2Client::getAuthorizationUrl	(		$redirectUrl,
			$state,
		array	$scope = [],
		array	$params = [],
			$separator = '&'
	)

Generates an authorization URL to begin the process of authenticating a user.

Parameters

string	$redirectUrl	The callback URL to redirect to.
string	$state	The CSPRNG-generated CSRF value.
array	$scope	An array of permissions to request.
array	$params	An array of parameters to generate URL.
string	$separator	The separator to use in http_build_query().

Returns

string

Definition at line 135 of file OAuth2Client.php.

getClientParams()

Facebook\Authentication\OAuth2Client::getClientParams ( )

protected

Returns the client_* params for OAuth requests.

Returns

array

Definition at line 285 of file OAuth2Client.php.

getCodeFromLongLivedAccessToken()

Facebook\Authentication\OAuth2Client::getCodeFromLongLivedAccessToken	(		$accessToken,
			$redirectUri = ''
	)

Get a valid code from an access token.

Parameters

AccessToken | string	$accessToken
string	$redirectUri

Returns

AccessToken

Exceptions

FacebookSDKException

Definition at line 199 of file OAuth2Client.php.

getLastRequest()

Facebook\Authentication\OAuth2Client::getLastRequest

(

)

Returns the last FacebookRequest that was sent. Useful for debugging and testing.

Returns

FacebookRequest|null

Definition at line 92 of file OAuth2Client.php.

getLongLivedAccessToken()

Facebook\Authentication\OAuth2Client::getLongLivedAccessToken

(

$accessToken

)

Exchanges a short-lived access token with a long-lived access token.

Parameters

AccessToken | string

$accessToken

Returns

AccessToken

Exceptions

FacebookSDKException

Definition at line 178 of file OAuth2Client.php.

requestAnAccessToken()

Facebook\Authentication\OAuth2Client::requestAnAccessToken ( array  $params )

protected

Send a request to the OAuth endpoint.

Parameters

array

$params

Returns

AccessToken

Exceptions

FacebookSDKException

Definition at line 224 of file OAuth2Client.php.

sendRequestWithClientParams()

Facebook\Authentication\OAuth2Client::sendRequestWithClientParams (   $endpoint, array  $params,   $accessToken = null  )

protected

Send a request to Graph with an app access token.

Parameters

string	$endpoint
array	$params
AccessToken | string | null	$accessToken

Returns

FacebookResponse

Exceptions

FacebookResponseException

Definition at line 261 of file OAuth2Client.php.

Member Data Documentation

$app

Facebook\Authentication\OAuth2Client::$app

protected

Definition at line 51 of file OAuth2Client.php.

$client

Facebook\Authentication\OAuth2Client::$client

protected

Definition at line 58 of file OAuth2Client.php.

$graphVersion

Facebook\Authentication\OAuth2Client::$graphVersion

protected

Definition at line 65 of file OAuth2Client.php.

$lastRequest

Facebook\Authentication\OAuth2Client::$lastRequest

protected

Definition at line 72 of file OAuth2Client.php.

BASE_AUTHORIZATION_URL

const Facebook\Authentication\OAuth2Client::BASE_AUTHORIZATION_URL = 'https://www.facebook.com'

@const string The base authorization URL.

Definition at line 44 of file OAuth2Client.php.

---

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

• plugins/facebook-php-sdk/src/Facebook/Authentication/OAuth2Client.php