Class: Services_Facebook_Auth

Source Location: /Services_Facebook-0.2.14/Services/Facebook/Auth.php

Class Overview

Services_Facebook_Common
   |
   --Services_Facebook_Auth

Facebook Authentication Interface

Author(s):

Jeff Hodsdon <jeff at digg.com>
Joe Stump <joe at joestump.net>

Version:

Release: 0.2.14

Inherited Variables

Class: Services_Facebook_Common

Services_Facebook_Common::$api
Services_Facebook_Common::$sessionKey
Services_Facebook_Common::$useSessionSecret
Services_Facebook_Common::$version

Inherited Methods

Class: Services_Facebook_Common

Services_Facebook_Common::__construct(): Construct
Services_Facebook_Common::callMethod(): Call method
Services_Facebook_Common::checkRequest(): Check if request resulted in an error
Services_Facebook_Common::getAPI(): Get API
Services_Facebook_Common::parseResponse(): parseResponse
Services_Facebook_Common::sendRequest(): Send a request to the API
Services_Facebook_Common::setAPI(): Set API
Services_Facebook_Common::signRequest(): Sign the request
Services_Facebook_Common::updateArgs(): Update arguments

Class Details

[line 48]
Facebook Authentication Interface

 <?php

 require_once 'Services/Facebook.php';
 $api = Services_Facebook();
 // An instance of SimpleXmlElement with the response loaded into it
 // is returned.
 $session = $api->auth->getSession($_GET['auth_token']);
 echo 'uid: ' . (string)$session->uid . '<br />';
 echo 'session_key: ' . (string)$session->session_key . '<br />';
 ?>

Author: Jeff Hodsdon <jeff@digg.com>
Author: Joe Stump <joe@joestump.net>
Version: Release: 0.2.14
Link: http://wiki.developers.facebook.com
License: New BSD License

[ Top ]

Method Detail

createToken [line 55]

string createToken(
)

Create a token for login

Access: public

[ Top ]

expireSession [line 104]

void expireSession(
)

Expire session

Invalidates the current session being used, regardless of whether it is temporary or infinite. After successfully calling this function, no further API calls requiring a session will succeed using this session. If the invalidation is successful, this will return true.

Access: public

[ Top ]

getSession [line 68]

object SimpleXmlElement getSession(
string
$authToken)

Convert auth_token into a session_key

Return: of response
Access: public

Parameters:

string $authToken — auth_token from callback

[ Top ]

promoteSession [line 87]

void promoteSession(
)

Promote session

Creates a temporary session secret for the current (non-infinite) session of a Web application. This session secret will not be used in the signature for the server-side component of an application, it is only meant for use by the application which additionally want to use a client side component. (e.g. Javascript Client Library)

Access: public

[ Top ]

revokeAuthorization [line 122]

void revokeAuthorization(
[string
$uid = null])

Revoke authorization

If this method is called for the logged in user, then no further API calls can be made on that user's behalf until the user decides to authorize the application again.

Access: public

Parameters:

string $uid — User's id

[ Top ]