Documentation

EasyBlogBaseFacebook

in package

• Application

Provides access to the Facebook Platform. This class provides a majority of the functionality needed, but the class is abstract because it is designed to be sub-classed. The subclass must implement the four abstract methods listed at the bottom of the file.

Tags

author

Naitik Shah naitik@facebook.com

Table of Contents

Constants

VERSION  = '3.1.1'

Version.

Properties

$CURL_OPTS  : mixed

Default options for curl.

$DOMAIN_MAP  : mixed

Maps aliases to Facebook domains.

$accessToken  : string

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

$appId  : string

The Application ID.

$appSecret  : string

The Application App Secret.

$DROP_QUERY_PARAMS  : mixed

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

$fileUploadSupport  : bool

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

$signedRequest  : mixed

The data from the signed_request token.

$state  : mixed

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

$user  : int

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

Methods

__construct()  : mixed

Initialize a Facebook Application.

api()  : mixed

Make an API call.

destroySession()  : mixed

Destroy the current session

getAccessToken()  : string

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

getApiSecret()  : string

Get the App Secret.

getAppId()  : string

Get the Application ID.

getAppSecret()  : string

Get the App Secret.

getFileUploadSupport()  : bool

Get the file upload support status.

getLoginStatusUrl()  : string

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

getLoginUrl()  : 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.

getLogoutUrl()  : string

Get a Logout URL suitable for use with redirects.

getSignedRequest()  : string

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

getUser()  : string

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

setAccessToken()  : 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.

setApiSecret()  : BaseFacebook

Set the App Secret.

setAppId()  : BaseFacebook

Set the Application ID.

setAppSecret()  : BaseFacebook

Set the App Secret.

setFileUploadSupport()  : BaseFacebook

Set the file upload support status.

useFileUploadSupport()  : bool

DEPRECATED! Please use getFileUploadSupport instead.

_graph()  : mixed

Invoke the Graph API.

_oauthRequest()  : string

Make a OAuth Request.

_restserver()  : mixed

Invoke the old restserver.php endpoint.

base64UrlDecode()  : string

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

clearAllPersistentData()  : void

Clear all data from the persistent storage

clearPersistentData()  : void

Clear the data with $key from the persistent storage

errorLog()  : mixed

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

establishCSRFTokenState()  : void

Lays down a CSRF state token for this process.

getAccessTokenFromCode()  : 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.

getApiUrl()  : string

Build the URL for api given parameters.

getApplicationAccessToken()  : string

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

getCode()  : mixed

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

getCurrentUrl()  : string

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

getPersistentData()  : mixed

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

getSignedRequestCookieName()  : string

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

getUrl()  : string

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

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.

getUserFromAccessToken()  : int

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.

getUserFromAvailableData()  : int

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.

makeRequest()  : 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.

parseSignedRequest()  : array<string|int, mixed>

Parses a signed_request and validates the signature.

setPersistentData()  : void

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

shouldRetainParam()  : bool

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.

throwAPIException()  : mixed

Analyzes the supplied result to see if it was thrown because the access token is no longer valid. If that is the case, then the persistent store is cleared.