include/externalAPI/Facebook/base_facebook.php

Show:

inherited

Classes
- \BaseFacebook
- \FacebookApiException

Table of Contents

\BaseFacebook
jump to top

Package: SugarCRM

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.

Children: \Facebook
Author: Naitik Shah

Constants

 
                VERSION
                = '3.2.2'

Version.

 
                SIGNED_REQUEST_ALGORITHM
                = 'HMAC-SHA256'

Signed Request Algorithm.

Properties


                 $CURL_OPTS= 'array(
    CURLOPT_CONNECTTIMEOUT => 10,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 60,
    CURLOPT_USERAGENT      => 'facebook-php-3.2',
  )'

static

Default options for curl.

Default value

array(
    CURLOPT_CONNECTTIMEOUT => 10,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT        => 60,
    CURLOPT_USERAGENT      => 'facebook-php-3.2',
  )

Details

Type: n/a


                 $DOMAIN_MAP= 'array(
    'api'         => 'https://api.facebook.com/',
    'api_video'   => 'https://api-video.facebook.com/',
    'api_read'    => 'https://api-read.facebook.com/',
    'graph'       => 'https://graph.facebook.com/',
    'graph_video' => 'https://graph-video.facebook.com/',
    'www'         => 'https://www.facebook.com/',
  )'

static

Maps aliases to Facebook domains.

Default value

array(
    'api'         => 'https://api.facebook.com/',
    'api_video'   => 'https://api-video.facebook.com/',
    'api_read'    => 'https://api-read.facebook.com/',
    'graph'       => 'https://graph.facebook.com/',
    'graph_video' => 'https://graph-video.facebook.com/',
    'www'         => 'https://www.facebook.com/',
  )

Details

Type: n/a


                 $DROP_QUERY_PARAMS= 'array(
    'code',
    'state',
    'signed_request',
  )'

static

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

Default value

array(
    'code',
    'state',
    'signed_request',
  )

Details

Type: n/a

string
                 $accessToken= 'null'

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

Default valuenullDetails

Type: string

string
                 $appId= ''

The Application ID.

Details

Type: string

string
                 $appSecret= ''

The Application App Secret.

Details

Type: string

boolean
                 $fileUploadSupport= 'false'

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

Default valuefalseDetails

Type: boolean


                 $signedRequest= ''

The data from the signed_request token.

Details

Type: n/a


                 $state= ''

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

Details

Type: n/a

boolean
                 $trustForwarded= 'false'

Indicates if we trust HTTP_X_FORWARDED_* headers.

Default valuefalseDetails

Type: boolean

integer
                 $user= ''

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

Details

Type: integer

Methods

__construct(
          array $config
          )
        
        :
          void

Initialize a Facebook Application.

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

Parameters

Name	Type	Description
$config	array	The application configuration

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

Invoke the Graph API.

Parameters

Name	Type	Description
$path	string	The path (required)
$method	string	The http method (default 'GET')
$params	array	The query/post data

Returns

Type	Description
mixed	The decoded response object

Throws

Exception	Description
\FacebookApiException

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

Make a OAuth Request.

Parameters

Name	Type	Description
$url	string	The path (required)
$params	array	The query/post data

Returns

Type	Description
string	The decoded response object

Throws

Exception	Description
\FacebookApiException

_restserver(
          array $params
          )
        
        :
          mixed

Invoke the old restserver.php endpoint.

Parameters

Name	Type	Description
$params	array	Method call object

Returns

Type	Description
mixed	The decoded response object

Throws

Exception	Description
\FacebookApiException

Make an API call.

Returns

Type	Description
mixed	The decoded response

base64UrlDecode(
          string $input
          )
        
        :
          string

static

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

Name	Type	Description
$input	string	base64UrlEncoded string

Returns

Type	Description
string

base64UrlEncode(
          string $input
          )
        
        :
          string

static

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

Exactly the same as base64_encode except it uses - instead of + _ instead of /

Parameters

Name	Type	Description
$input	string	string

Returns

Type	Description
string	base64Url encoded string

clearAllPersistentData(
          
          )
        
        :
          void

abstract

Clear all data from the persistent storage

clearPersistentData(
          string $key
          )
        
        :
          void

abstract

Clear the data with $key from the persistent storage

Parameters

Name	Type	Description
$key	string

destroySession(
          
          )
        
        :
          void

Destroy the current session

endsWith(
           $big,  $small
          )
        
        :
          void

static

Parameters

Name	Type	Description
$big
$small

errorLog(
          string $msg
          )
        
        :
          void

static

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

Parameters

Name	Type	Description
$msg	string	Log message

establishCSRFTokenState(
          
          )
        
        :
          void

Lays down a CSRF state token for this process.

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

Type	Description
string	The access token

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

Name	Type	Description
$code	string	An authorization code.
$redirect_uri

Returns

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

getApiSecret(
          
          )
        
        :
          string

Get the App Secret.

Returns

Type	Description
string	the App Secret

Details

Deprecated

getApiUrl(
          \$method $method
          )
        
        :
          string

Build the URL for api given parameters.

Parameters

Name	Type	Description
$method	\$method	String the method name.

Returns

Type	Description
string	The URL for the given parameters

getAppId(
          
          )
        
        :
          string

Get the Application ID.

Returns

Type	Description
string	the Application ID

getAppSecret(
          
          )
        
        :
          string

Get the App Secret.

Returns

Type	Description
string	the App Secret

getApplicationAccessToken(
          
          )
        
        :
          string

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

Returns

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

getBaseDomain(
          
          )
        
        :
          void

Get the base domain used for the cookie.

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

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

getCurrentUrl(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The current URL

getFileUploadSupport(
          
          )
        
        :
          boolean

Get the file upload support status.

Returns

Type	Description
boolean	true if and only if the server supports file upload.

getHttpHost(
          
          )
        
        :
          void

getHttpProtocol(
          
          )
        
        :
          void

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

Name	Type	Description
$params	array	Provide custom parameters

Returns

Type	Description
string	The URL for the logout flow

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

Name	Type	Description
$params	array	Provide custom parameters

Returns

Type	Description
string	The URL for the login flow

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

Name	Type	Description
$params	array	Provide custom parameters

Returns

Type	Description
string	The URL for the logout flow

getMetadataCookie(
          
          )
        
        :
          \an

Parses the metadata cookie that our Javascript API set

Returns

Type	Description
\an	array mapping key to value

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

Type	Description
string	the name of the cookie that would house metadata.

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

abstract

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

Parameters

Name	Type	Description
$key	string	The key of the data to retrieve
$default	boolean	The default value to return if $key is not found

Returns

Type	Description
mixed

getSignedRequest(
          
          )
        
        :
          string

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

Returns

Type	Description
string	the signed request, if available, or null otherwise.

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

Type	Description
string	the name of the cookie that would house the signed request value.

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

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

Parameters

Name	Type	Description
$name	\$name	string The name of the domain
$path	\$path	string Optional path (without a leading slash)
$params	\$params	array Optional query parameters

Returns

Type	Description
string	The URL for the given parameters

getUser(
          
          )
        
        :
          string

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

Returns

Type	Description
string	the UID if available.

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

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

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

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

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

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

isAllowedDomain(
           $big,  $small
          )
        
        :
          void

static

Parameters

Name	Type	Description
$big
$small

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

Return true if this is video post.

Parameters

Name	Type	Description
$path	string	The path
$method	string	The http method (default 'GET')

Returns

Type	Description
boolean	true if this is video post

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

Name	Type	Description
$url	string	The URL to make the request to
$params	array	The parameters to use for the POST body
$ch	\CurlHandler	Initialized curl handle

Returns

Type	Description
string	The response text

makeSignedRequest(
          array $data
          )
        
        :
          string

Makes a signed_request blob using the given data.

Parameters

Name	Type	Description
$data	array	The data array.

Returns

Type	Description
string	The signed request.

parseSignedRequest(
          string $signed_request
          )
        
        :
          array

Parses a signed_request and validates the signature.

Parameters

Name	Type	Description
$signed_request	string	A signed token

Returns

Type	Description
array	The payload inside it or null if the sig is wrong

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

Name	Type	Description
$access_token	string	an access token.

Returns

Type	Description
\BaseFacebook

setApiSecret(
          string $apiSecret
          )
        
        :
          \BaseFacebook

Set the App Secret.

Parameters

Name	Type	Description
$apiSecret	string	The App Secret

Returns

Type	Description
\BaseFacebook

Details

Deprecated

setAppId(
          string $appId
          )
        
        :
          \BaseFacebook

Set the Application ID.

Parameters

Name	Type	Description
$appId	string	The Application ID

Returns

Type	Description
\BaseFacebook

setAppSecret(
          string $appSecret
          )
        
        :
          \BaseFacebook

Set the App Secret.

Parameters

Name	Type	Description
$appSecret	string	The App Secret

Returns

Type	Description
\BaseFacebook

setExtendedAccessToken(
          
          )
        
        :
          void

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.

setFileUploadSupport(
          boolean $fileUploadSupport
          )
        
        :
          \BaseFacebook

Set the file upload support status.

Parameters

Name	Type	Description
$fileUploadSupport	boolean	The file upload support status.

Returns

Type	Description
\BaseFacebook

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

abstract

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

Parameters

Name	Type	Description
$key	string
$value	array

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

Name	Type	Description
$param	string	A key or key/value pair within a URL's query (e.g. 'foo=a', 'foo=', or 'foo'.

Returns

Type	Description
boolean

throwAPIException(
          \$result $result
          )
        
        :
          void

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

Name	Type	Description
$result	\$result	array A record storing the error message returned by a failed API call.

useFileUploadSupport(
          
          )
        
        :
          boolean

DEPRECATED! Please use getFileUploadSupport instead.

Get the file upload support status.

Returns

Type	Description
boolean	true if and only if the server supports file upload.

\FacebookApiException
jump to top

Package: SugarCRM

Thrown when an API call returns an exception.

Parent(s): \Exception
Author: Naitik Shah

Properties


                 $result= ''

The result from the API server that represents the exception information.

Details

Type: n/a

Methods

__construct(
          array $result
          )
        
        :
          void

Make a new API Exception with the given result.

Parameters

Name	Type	Description
$result	array	The result from the API server

__toString(
          
          )
        
        :
          string

To make debugging easier.

Returns

Type	Description
string	The string representation of the error

getResult(
          
          )
        
        :
          array

Return the associated result object returned by the API server.

Returns

Type	Description
array	The result from the API server

getType(
          
          )
        
        :
          string

Returns the associated type for the error. This will default to 'Exception' when a type is not available.

Returns

Type	Description
string

include/externalAPI/Facebook/base_facebook.php

\BaseFacebookjump to top

Constants

Properties

Methods

\FacebookApiExceptionjump to top

Properties

Methods

\BaseFacebook
jump to top

\FacebookApiException
jump to top