Constants

VERSION

VERSION

Version.

SIGNED_REQUEST_ALGORITHM

SIGNED_REQUEST_ALGORITHM

Signed Request Algorithm.

Properties

$CURL_OPTS

$CURL_OPTS : 

Default options for curl.

Type

$DOMAIN_MAP

$DOMAIN_MAP : 

Maps aliases to Facebook domains.

Type

$DROP_QUERY_PARAMS

$DROP_QUERY_PARAMS : 

List of query parameters that get automatically dropped when rebuilding the current URL.

Type

$appId

$appId : string

The Application ID.

Type

string

$appSecret

$appSecret : string

The Application App Secret.

Type

string

$user

$user : integer

The ID of the Facebook user, or 0 if the user is logged out.

Type

integer

$signedRequest

$signedRequest : 

The data from the signed_request token.

Type

$state

$state : 

A CSRF state variable to assist in the defense against CSRF attacks.

Type

$accessToken

$accessToken : string

The OAuth access token received in exchange for a valid authorization code. null means the access token has yet to be determined.

Type

string

$fileUploadSupport

$fileUploadSupport : boolean

Indicates if the CURL based @ syntax for file uploads is enabled.

Type

boolean

$trustForwarded

$trustForwarded : boolean

Indicates if we trust HTTP_X_FORWARDED_* headers.

Type

boolean

Methods

__construct()

__construct(array  $config) 

Initialize a Facebook Application.

The configuration:

  • appId: the application ID
  • secret: the application secret
  • fileUpload: (optional) boolean indicating if file uploads are enabled

Parameters

array $config

The application configuration

setAppId()

setAppId(string  $appId) : \BaseFacebook

Set the Application ID.

Parameters

string $appId

The Application ID

Returns

\BaseFacebook

getAppId()

getAppId() : string

Get the Application ID.

Returns

string —

the Application ID

setApiSecret()

setApiSecret(string  $apiSecret) : \BaseFacebook

Set the App Secret.

Parameters

string $apiSecret

The App Secret

Returns

\BaseFacebook

setAppSecret()

setAppSecret(string  $appSecret) : \BaseFacebook

Set the App Secret.

Parameters

string $appSecret

The App Secret

Returns

\BaseFacebook

getApiSecret()

getApiSecret() : string

Get the App Secret.

Returns

string —

the App Secret

getAppSecret()

getAppSecret() : string

Get the App Secret.

Returns

string —

the App Secret

setFileUploadSupport()

setFileUploadSupport(boolean  $fileUploadSupport) : \BaseFacebook

Set the file upload support status.

Parameters

boolean $fileUploadSupport

The file upload support status.

Returns

\BaseFacebook

getFileUploadSupport()

getFileUploadSupport() : boolean

Get the file upload support status.

Returns

boolean —

true if and only if the server supports file upload.

useFileUploadSupport()

useFileUploadSupport() : boolean

DEPRECATED! Please use getFileUploadSupport instead.

Get the file upload support status.

Returns

boolean —

true if and only if the server supports file upload.

setAccessToken()

setAccessToken(string  $access_token) : \BaseFacebook

Sets the access token for api calls. Use this if you get your access token by other means and just want the SDK to use it.

Parameters

string $access_token

an access token.

Returns

\BaseFacebook

setExtendedAccessToken()

setExtendedAccessToken() 

Extend an access token, while removing the short-lived token that might have been generated via client-side flow. Thanks to http://bit.ly/b0Pt0H for the workaround.

getAccessToken()

getAccessToken() : string

Determines the access token that should be used for API calls.

The first time this is called, $this->accessToken is set equal to either a valid user access token, or it's set to the application access token if a valid user access token wasn't available. Subsequent calls return whatever the first call returned.

Returns

string —

The access token

getSignedRequest()

getSignedRequest() : string

Retrieve the signed request, either from a request parameter or, if not present, from a cookie.

Returns

string —

the signed request, if available, or null otherwise.

getUser()

getUser() : string

Get the UID of the connected user, or 0 if the Facebook user is not connected.

Returns

string —

the UID if available.

getLoginUrl()

getLoginUrl(array  $params = array()) : string

Get a Login URL for use with redirects. By default, full page redirect is assumed. If you are using the generated URL with a window.open() call in JavaScript, you can pass in display=popup as part of the $params.

The parameters:

  • redirect_uri: the url to go to after a successful login
  • scope: comma separated list of requested extended perms

Parameters

array $params

Provide custom parameters

Returns

string —

The URL for the login flow

getLogoutUrl()

getLogoutUrl(array  $params = array()) : string

Get a Logout URL suitable for use with redirects.

The parameters:

  • next: the url to go to after a successful logout

Parameters

array $params

Provide custom parameters

Returns

string —

The URL for the logout flow

getLoginStatusUrl()

getLoginStatusUrl(array  $params = array()) : string

Get a login status URL to fetch the status from Facebook.

The parameters:

  • ok_session: the URL to go to if a session is found
  • no_session: the URL to go to if the user is not connected
  • no_user: the URL to go to if the user is not signed into facebook

Parameters

array $params

Provide custom parameters

Returns

string —

The URL for the logout flow

api()

api() : mixed

Make an API call.

Returns

mixed —

The decoded response

destroySession()

destroySession() 

Destroy the current session

getUserAccessToken()

getUserAccessToken() : string

Determines and returns the user access token, first using the signed request if present, and then falling back on the authorization code if present. The intent is to return a valid user access token, or false if one is determined to not be available.

Returns

string —

A valid user access token, or false if one could not be determined.

getUserFromAvailableData()

getUserFromAvailableData() : integer

Determines the connected user by first examining any signed requests, then considering an authorization code, and then falling back to any persistent store storing the user.

Returns

integer —

The id of the connected Facebook user, or 0 if no such user exists.

getSignedRequestCookieName()

getSignedRequestCookieName() : string

Constructs and returns the name of the cookie that potentially houses the signed request for the app user.

The cookie is not set by the BaseFacebook class, but it may be set by the JavaScript SDK.

Returns

string —

the name of the cookie that would house the signed request value.

getMetadataCookieName()

getMetadataCookieName() : string

Constructs and returns the name of the coookie that potentially contain metadata. The cookie is not set by the BaseFacebook class, but it may be set by the JavaScript SDK.

Returns

string —

the name of the cookie that would house metadata.

getCode()

getCode() : mixed

Get the authorization code from the query parameters, if it exists, and otherwise return false to signal no authorization code was discoverable.

Returns

mixed —

The authorization code, or false if the authorization code could not be determined.

getUserFromAccessToken()

getUserFromAccessToken() : integer

Retrieves the UID with the understanding that $this->accessToken has already been set and is seemingly legitimate. It relies on Facebook's Graph API to retrieve user information and then extract the user ID.

Returns

integer —

Returns the UID of the Facebook user, or 0 if the Facebook user could not be determined.

getApplicationAccessToken()

getApplicationAccessToken() : string

Returns the access token that should be used for logged out users when no authorization code is available.

Returns

string —

The application access token, useful for gathering public information about users and applications.

establishCSRFTokenState()

establishCSRFTokenState() : void

Lays down a CSRF state token for this process.

getAccessTokenFromCode()

getAccessTokenFromCode(string  $code,   $redirect_uri = null) : mixed

Retrieves an access token for the given authorization code (previously generated from www.facebook.com on behalf of a specific user). The authorization code is sent to graph.facebook.com and a legitimate access token is generated provided the access token and the user for which it was generated all match, and the user is either logged in to Facebook or has granted an offline access permission.

Parameters

string $code

An authorization code.

$redirect_uri

Returns

mixed —

An access token exchanged for the authorization code, or false if an access token could not be generated.

_restserver()

_restserver(array  $params) : mixed

Invoke the old restserver.php endpoint.

Parameters

array $params

Method call object

Throws

\FacebookApiException

Returns

mixed —

The decoded response object

isVideoPost()

isVideoPost(string  $path, string  $method = 'GET') : boolean

Return true if this is video post.

Parameters

string $path

The path

string $method

The http method (default 'GET')

Returns

boolean —

true if this is video post

_graph()

_graph(string  $path, string  $method = 'GET', array  $params = array()) : mixed

Invoke the Graph API.

Parameters

string $path

The path (required)

string $method

The http method (default 'GET')

array $params

The query/post data

Throws

\FacebookApiException

Returns

mixed —

The decoded response object

_oauthRequest()

_oauthRequest(string  $url, array  $params) : string

Make a OAuth Request.

Parameters

string $url

The path (required)

array $params

The query/post data

Throws

\FacebookApiException

Returns

string —

The decoded response object

makeRequest()

makeRequest(string  $url, array  $params, \CurlHandler  $ch = null) : string

Makes an HTTP request. This method can be overridden by subclasses if developers want to do fancier things or use something other than curl to make the request.

Parameters

string $url

The URL to make the request to

array $params

The parameters to use for the POST body

\CurlHandler $ch

Initialized curl handle

Returns

string —

The response text

parseSignedRequest()

parseSignedRequest(string  $signed_request) : array

Parses a signed_request and validates the signature.

Parameters

string $signed_request

A signed token

Returns

array —

The payload inside it or null if the sig is wrong

makeSignedRequest()

makeSignedRequest(  $data) : string

Makes a signed_request blob using the given data.

Parameters

$data

Returns

string —

The signed request.

getApiUrl()

getApiUrl(  $method) : string

Build the URL for api given parameters.

Parameters

$method

String the method name.

Returns

string —

The URL for the given parameters

getUrl()

getUrl(  $name,   $path = '',   $params = array()) : string

Build the URL for given domain alias, path and parameters.

Parameters

$name

string The name of the domain

$path

string Optional path (without a leading slash)

$params

array Optional query parameters

Returns

string —

The URL for the given parameters

getHttpHost()

getHttpHost() 

getHttpProtocol()

getHttpProtocol() 

getBaseDomain()

getBaseDomain() 

Get the base domain used for the cookie.

getCurrentUrl()

getCurrentUrl() : string

Returns the Current URL, stripping it of known FB parameters that should not persist.

Returns

string —

The current URL

shouldRetainParam()

shouldRetainParam(string  $param) : boolean

Returns true if and only if the key or key/value pair should be retained as part of the query string. This amounts to a brute-force search of the very small list of Facebook-specific params that should be stripped out.

Parameters

string $param

A key or key/value pair within a URL's query (e.g. 'foo=a', 'foo=', or 'foo'.

Returns

boolean

throwAPIException()

throwAPIException(  $result) 

Analyzes the supplied result to see if it was thrown because the access token is no longer valid. If that is the case, then we destroy the session.

Parameters

$result

array A record storing the error message returned by a failed API call.

errorLog()

errorLog(string  $msg) 

Prints to the error log if you aren't in command line mode.

Parameters

string $msg

Log message

base64UrlDecode()

base64UrlDecode(string  $input) : string

Base64 encoding that doesn't need to be urlencode()ed.

Exactly the same as base64_encode except it uses

  • instead of + _ instead of / No padded =

Parameters

string $input

base64UrlEncoded string

Returns

string

base64UrlEncode()

base64UrlEncode(string  $input) : string

Base64 encoding that doesn't need to be urlencode()ed.

Exactly the same as base64_encode except it uses

  • instead of + _ instead of /

Parameters

string $input

string

Returns

string —

base64Url encoded string

getMetadataCookie()

getMetadataCookie() : \an

Parses the metadata cookie that our Javascript API set

Returns

\an —

array mapping key to value

isAllowedDomain()

isAllowedDomain(  $big,   $small) 

Parameters

$big
$small

endsWith()

endsWith(  $big,   $small) 

Parameters

$big
$small

setPersistentData()

setPersistentData(string  $key, array  $value) : void

Stores the given ($key, $value) pair, so that future calls to getPersistentData($key) return $value. This call may be in another request.

Parameters

string $key
array $value

getPersistentData()

getPersistentData(string  $key, boolean  $default = false) : mixed

Get the data for $key, persisted by BaseFacebook::setPersistentData()

Parameters

string $key

The key of the data to retrieve

boolean $default

The default value to return if $key is not found

Returns

mixed

clearPersistentData()

clearPersistentData(string  $key) : void

Clear the data with $key from the persistent storage

Parameters

string $key

clearAllPersistentData()

clearAllPersistentData() : void

Clear all data from the persistent storage