Documentation

EasyBlogClientFacebook extends EasyBlogFacebookConsumer
in package

EasyBlog

Extends the BaseFacebook class with the intent of using PHP sessions to store user ids and access tokens.

Constants

VERSION = '3.1.1': Version.

Properties

$apiKey : mixed
$apiSecret : mixed
$app : mixed
$callback : mixed
$config : mixed
$CURL_OPTS : mixed: Default options for curl.
$DOMAIN_MAP : mixed: Maps aliases to Facebook domains.
$input : mixed
$jConfig : mixed
$redirect : mixed
$token : mixed
$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.
$kSupportedKeys : mixed
$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: Identical to the parent constructor, except that we start a PHP session to store the user ID and access token if during the course of execution we discover them.
api() : mixed: Make an API call.
destroySession() : mixed: Destroy the current session
doneLogin() : mixed: Javascript to close dialog when call=doneLogin is specified in the URI.
exchangeToken() : mixed: Exchanges the code with Facebook to get the access token
extractPostData() : mixed: Retrieve the extracted content of a blog post that can be formatted to Facebook
getAccess() : mixed: Exchanges the request token with the access token
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.
getAuthorizeURL() : mixed: Retrieves the authorization end point url
getFileUploadSupport() : bool: Get the file upload support status.
getGroups() : mixed: Retrieves a list of groups
getLoginButton() : mixed: Retrieves the loggin button for Facebook
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.
getPages() : mixed: Retrieves a list of pages
getRequestToken() : mixed: Facebook does not need the request tokens
getRevokeButton() : mixed: Retrieves the revoke access button
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.
getVerifier() : string: Returns the verifier option. Since Facebook does not have oauth_verifier, The only way to validate this is through the 'code' query
normalizeToken() : mixed: Normalize the token access
notifyAdminTokenExpiry() : mixed: Revokes application access from Facebook
revoke() : mixed: Revokes application access from Facebook
setAccess() : mixed: Sets the access token
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.
setCallback() : mixed
setFileUploadSupport() : BaseFacebook: Set the file upload support status.
setRequestToken() : mixed: Sets the request token
share() : mixed: Shares the data to facebook
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
constructSessionVariableName() : mixed
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: Provides the implementations of the inherited abstract methods. The implementation uses PHP sessions to maintain a store for authorization codes, user ids, CSRF states, and access tokens.
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: Overrides the exception method so that we can silently fail

VERSION

Version.


    public
        mixed
    VERSION
    = '3.1.1'

$apiKey


    public
        mixed
    $apiKey
     = ''

$apiSecret


    public
        mixed
    $apiSecret
     = ''

$app


    public
        mixed
    $app
     = \null

$callback


    public
        mixed
    $callback
     = ''

$config


    public
        mixed
    $config
     = \null

$CURL_OPTS

Default options for curl.


    public
    static    mixed
    $CURL_OPTS
     = array(\CURLOPT_CONNECTTIMEOUT => 10, \CURLOPT_RETURNTRANSFER => \true, \CURLOPT_TIMEOUT => 60, \CURLOPT_USERAGENT => 'facebook-php-3.1')

$DOMAIN_MAP

Maps aliases to Facebook domains.


    public
    static    mixed
    $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/', 'www' => 'https://www.facebook.com/')

$input


    public
        mixed
    $input
     = \null

$jConfig


    public
        mixed
    $jConfig
     = \null

$redirect


    public
        mixed
    $redirect
     = \null

$token


    public
        mixed
    $token
     = ''

$accessToken

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


    protected
        string
    $accessToken
     = \null

$appId

The Application ID.


    protected
        string
    $appId

$appSecret

The Application App Secret.


    protected
        string
    $appSecret

$DROP_QUERY_PARAMS

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


    protected
    static    mixed
    $DROP_QUERY_PARAMS
     = array('code', 'state', 'signed_request')

$fileUploadSupport

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


    protected
        bool
    $fileUploadSupport
     = \false

$kSupportedKeys


    protected
    static    mixed
    $kSupportedKeys
     = array('state', 'code', 'access_token', 'user_id')

$signedRequest

The data from the signed_request token.


    protected
        mixed
    $signedRequest

$state

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


    protected
        mixed
    $state

$user

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


    protected
        int
    $user

__construct()

Identical to the parent constructor, except that we start a PHP session to store the user ID and access token if during the course of execution we discover them.


    public
                    __construct([mixed $options = array() ]) : mixed

Parameters

$options : mixed = array()

api()

Make an API call.


    public
                    api() : mixed

Return values

mixed —

The decoded response

destroySession()

Destroy the current session


    public
                    destroySession() : mixed

doneLogin()

Javascript to close dialog when call=doneLogin is specified in the URI.


    public
                    doneLogin() : mixed

exchangeToken()

Exchanges the code with Facebook to get the access token


    public
                    exchangeToken(mixed $code) : mixed

Parameters

$code : mixed

extractPostData()

Retrieve the extracted content of a blog post that can be formatted to Facebook


    public
                    extractPostData(EasyBlogPost &$post) : mixed

Parameters

$post : EasyBlogPost

getAccess()

Exchanges the request token with the access token


    public
                    getAccess([mixed $code = false ]) : mixed

Parameters

$code : mixed = false

getAccessToken()

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


    public
                    getAccessToken() : string

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.

Return values

string —

The access token

getApiSecret()

Get the App Secret.


    public
                    getApiSecret() : string

Return values

string —

the App Secret

getAppId()

Get the Application ID.


    public
                    getAppId() : string

Return values

string —

the Application ID

getAppSecret()

Get the App Secret.


    public
                    getAppSecret() : string

Return values

string —

the App Secret

getAuthorizeURL()

Retrieves the authorization end point url


    public
                    getAuthorizeURL() : mixed

getFileUploadSupport()

Get the file upload support status.


    public
                    getFileUploadSupport() : bool

Return values

bool —

true if and only if the server supports file upload.

getGroups()

Retrieves a list of groups


    public
                    getGroups() : mixed

getLoginButton()

Retrieves the loggin button for Facebook


    public
                    getLoginButton(mixed $return[, mixed $system = false ][, mixed $userId = false ]) : mixed

Parameters

$return : mixed
$system : mixed = false
$userId : mixed = false

getLoginStatusUrl()

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


    public
                    getLoginStatusUrl([array<string|int, mixed> $params = array() ]) : string

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

$params : array<string|int, mixed> = array(): Provide custom parameters

Return values

string —

The URL for the logout flow

getLoginUrl()

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.


    public
                    getLoginUrl([array<string|int, mixed> $params = array() ]) : string

The parameters:

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

Parameters

$params : array<string|int, mixed> = array(): Provide custom parameters

Return values

string —

The URL for the login flow

getLogoutUrl()

Get a Logout URL suitable for use with redirects.


    public
                    getLogoutUrl([array<string|int, mixed> $params = array() ]) : string

The parameters:

next: the url to go to after a successful logout

Parameters

$params : array<string|int, mixed> = array(): Provide custom parameters

Return values

string —

The URL for the logout flow

getPages()

Retrieves a list of pages


    public
                    getPages() : mixed

getRequestToken()

Facebook does not need the request tokens


    public
                    getRequestToken() : mixed

getRevokeButton()

Retrieves the revoke access button


    public
                    getRevokeButton(mixed $return[, mixed $system = false ][, mixed $userId = false ]) : mixed

Parameters

$return : mixed
$system : mixed = false
$userId : mixed = false

getSignedRequest()

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


    public
                    getSignedRequest() : string

Return values

string —

the signed request, if available, or null otherwise.

getUser()

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


    public
                    getUser() : string

Return values

string —

the UID if available.

getVerifier()

Returns the verifier option. Since Facebook does not have oauth_verifier, The only way to validate this is through the 'code' query


    public
                    getVerifier() : string

Return values

string —

$verifier Any string representation that we can verify it isn't empty.

normalizeToken()

Normalize the token access


    public
                    normalizeToken(mixed $token) : mixed

Parameters

$token : mixed

notifyAdminTokenExpiry()

Revokes application access from Facebook


    public
                    notifyAdminTokenExpiry([mixed $days = 7 ]) : mixed

Parameters

$days : mixed = 7

revoke()

Revokes application access from Facebook


    public
                    revoke() : mixed

setAccess()

Sets the access token


    public
                    setAccess(mixed $access) : mixed

Parameters

$access : mixed

setAccessToken()

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.


    public
                    setAccessToken(string $access_token) : BaseFacebook

Parameters

$access_token : string: an access token.

Return values

BaseFacebook

setApiSecret()

Set the App Secret.


    public
                    setApiSecret(string $apiSecret) : BaseFacebook

Parameters

$apiSecret : string: The App Secret

Return values

BaseFacebook

setAppId()

Set the Application ID.


    public
                    setAppId(string $appId) : BaseFacebook

Parameters

$appId : string: The Application ID

Return values

BaseFacebook

setAppSecret()

Set the App Secret.


    public
                    setAppSecret(string $appSecret) : BaseFacebook

Parameters

$appSecret : string: The App Secret

Return values

BaseFacebook

setCallback()


    public
                    setCallback(mixed $url) : mixed

Parameters

$url : mixed

setFileUploadSupport()

Set the file upload support status.


    public
                    setFileUploadSupport(bool $fileUploadSupport) : BaseFacebook

Parameters

$fileUploadSupport : bool: The file upload support status.

Return values

BaseFacebook

setRequestToken()

Sets the request token


    public
                    setRequestToken(mixed $token, mixed $secret) : mixed

Parameters

$token : mixed
$secret : mixed

share()

Shares the data to facebook


    public
                    share(EasyBlogPost &$post, EasyBlogTableOAuth &$oauth[, mixed $system = true ][, mixed $reposting = false ]) : mixed

Parameters

$post : EasyBlogPost
$oauth : EasyBlogTableOAuth
$system : mixed = true
$reposting : mixed = false

useFileUploadSupport()

DEPRECATED! Please use getFileUploadSupport instead.


    public
                    useFileUploadSupport() : bool

Get the file upload support status.

Return values

bool —

true if and only if the server supports file upload.

_graph()

Invoke the Graph API.


    protected
                    _graph(string $path[, string $method = 'GET' ][, array<string|int, mixed> $params = array() ]) : mixed

Parameters

$path : string: The path (required)
$method : string = 'GET': The http method (default 'GET')
$params : array<string|int, mixed> = array(): The query/post data

Return values

mixed —

The decoded response object

_oauthRequest()

Make a OAuth Request.


    protected
                    _oauthRequest(string $url, array<string|int, mixed> $params) : string

Parameters

$url : string: The path (required)
$params : array<string|int, mixed>: The query/post data

Return values

string —

The decoded response object

_restserver()

Invoke the old restserver.php endpoint.


    protected
                    _restserver(array<string|int, mixed> $params) : mixed

Parameters

$params : array<string|int, mixed>: Method call object

Return values

mixed —

The decoded response object

base64UrlDecode()

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


    protected
            static        base64UrlDecode(string $input) : string

Exactly the same as base64_encode except it uses

instead of + _ instead of /

Parameters

$input : string: base64UrlEncoded string

Return values

string

clearAllPersistentData()

Clear all data from the persistent storage


    protected
                    clearAllPersistentData() : void

clearPersistentData()

Clear the data with $key from the persistent storage


    protected
                    clearPersistentData(mixed $key) : void

Parameters

$key : mixed

constructSessionVariableName()


    protected
                    constructSessionVariableName(mixed $key) : mixed

Parameters

$key : mixed

errorLog()

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


    protected
            static        errorLog(string $msg) : mixed

Parameters

$msg : string: Log message

establishCSRFTokenState()

Lays down a CSRF state token for this process.


    protected
                    establishCSRFTokenState() : void

getAccessTokenFromCode()

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.


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

Parameters

$code : string: An authorization code.
$redirect_uri : mixed = null

Return values

mixed —

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

getApiUrl()

Build the URL for api given parameters.


    protected
                    getApiUrl(mixed $method) : string

Parameters

$method : mixed: String the method name.

Return values

string —

The URL for the given parameters

getApplicationAccessToken()

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


    protected
                    getApplicationAccessToken() : string

Return values

string —

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

getCode()

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


    protected
                    getCode() : mixed

Return values

mixed —

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

getCurrentUrl()

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


    protected
                    getCurrentUrl() : string

Return values

string —

The current URL

getPersistentData()

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


    protected
                    getPersistentData(mixed $key[, mixed $default = false ]) : mixed

Parameters

$key : mixed: The key of the data to retrieve
$default : mixed = false: The default value to return if $key is not found

getSignedRequestCookieName()

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


    protected
                    getSignedRequestCookieName() : string

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

Return values

string —

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

getUrl()

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


    protected
                    getUrl(mixed $name[, mixed $path = '' ][, mixed $params = array() ]) : string

Parameters

$name : mixed: string The name of the domain
$path : mixed = '': string Optional path (without a leading slash)
$params : mixed = array(): array Optional query parameters

Return values

string —

The URL for the given parameters

getUserAccessToken()

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.


    protected
                    getUserAccessToken() : string

Return values

string —

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

getUserFromAccessToken()

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.


    protected
                    getUserFromAccessToken() : int

Return values

int —

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

getUserFromAvailableData()

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.


    protected
                    getUserFromAvailableData() : int

Return values

int —

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

makeRequest()

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.


    protected
                    makeRequest(string $url, array<string|int, mixed> $params[, CurlHandler $ch = null ]) : string

Parameters

$url : string: The URL to make the request to
$params : array<string|int, mixed>: The parameters to use for the POST body
$ch : CurlHandler = null: Initialized curl handle

Return values

string —

The response text

parseSignedRequest()

Parses a signed_request and validates the signature.


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

Parameters

$signed_request : string: A signed token

Return values

array<string|int, mixed> —

The payload inside it or null if the sig is wrong

setPersistentData()

Provides the implementations of the inherited abstract methods. The implementation uses PHP sessions to maintain a store for authorization codes, user ids, CSRF states, and access tokens.


    protected
                    setPersistentData(mixed $key, mixed $value) : void

Parameters

$key : mixed
$value : mixed

shouldRetainParam()

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.


    protected
                    shouldRetainParam(string $param) : bool

Parameters

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

Return values

bool

throwAPIException()

Overrides the exception method so that we can silently fail


    protected
                    throwAPIException(mixed $result) : mixed

Parameters

$result : mixed: array A record storing the error message returned by a failed API call.

EasyBlogClientFacebook extends EasyBlogFacebookConsumer in package EasyBlog

Table of Contents

Constants

Properties

Methods

Constants

VERSION

Properties

$apiKey

$apiSecret

$app

$callback

$config

$CURL_OPTS

$DOMAIN_MAP

$input

$jConfig

$redirect

$token

$accessToken

$appId

$appSecret

$DROP_QUERY_PARAMS

$fileUploadSupport

$kSupportedKeys

$signedRequest

$state

$user

Methods

__construct()

Parameters

api()

Return values

destroySession()

doneLogin()

Tags

exchangeToken()

Parameters

Tags

extractPostData()

Parameters

Tags

getAccess()

Parameters

Tags

getAccessToken()

Return values

getApiSecret()

Return values

getAppId()

Return values

getAppSecret()

Return values

getAuthorizeURL()

Tags

getFileUploadSupport()

Return values

getGroups()

Tags

getLoginButton()

Parameters

Tags

getLoginStatusUrl()

Parameters

EasyBlogClientFacebook extends EasyBlogFacebookConsumer
in package

EasyBlog