Docs For Class WMSFacebook

Description

Abstracts a minimal subset of the functionality for $facebook.

Abstracts a minimal subset of the functionality for $facebook. This class facilitates the creation of WMSFacebook subclasses. It is also responsible for login (and redirection). The result of logging into Facebook results in a valid WMSFacebookUser instance, upon success.

author: Dave Jarvis
version: 0.0.1
copyright: Copyright (c) 2007 White Magic Software, Ltd.
link: http://www.davidjarvis.ca
example: Data Store Example
license: GNU LGPL Version 3

Located in /WMSFacebook.php (line 22)

WMSFacebookObject
   |
   --WMSFacebook

Method Summary

WMSFacebook WMSFacebook (string $key, string $secret)

void getWMSFacebookApplication ()

void getWMSFacebookDataStore ()

void getWMSFacebookUser ()

void initFacebook ( $key, $secret)

void initWMSFacebookApplication ( $url)

void initWMSFacebookDataStore ()

void initWMSFacebookUser ( $user)

WMSFacebookUser login (string $url)

void setWMSFacebookUser ( $wmsFacebookUser)

Variables

Inherited Variables

Inherited from WMSFacebookObject

WMSFacebookObject::$ASSOCATION_TYPE_ASYMMETRIC
WMSFacebookObject::$ASSOCATION_TYPE_DIRECTED
WMSFacebookObject::$ASSOCATION_TYPE_SYMMETRIC
WMSFacebookObject::$ERROR_OBJECT_EXISTS
WMSFacebookObject::$ERROR_OBJECT_NOT_FOUND
WMSFacebookObject::$OBJECT_TYPE_BINARY
WMSFacebookObject::$OBJECT_TYPE_INTEGER
WMSFacebookObject::$OBJECT_TYPE_STRING

Methods

Constructor WMSFacebook (line 33)

Creates a new WMSFacebook instance, which wraps the $facebook instance.

access: public

WMSFacebook WMSFacebook (string $key, string $secret)

string $key: Unique identifier for this application.
string $secret: Password for this application.

getWMSFacebookApplication (line 85)

access: public

void getWMSFacebookApplication ()

getWMSFacebookDataStore (line 93)

access: public

void getWMSFacebookDataStore ()

getWMSFacebookUser (line 77)

access: public

void getWMSFacebookUser ()

initFacebook (line 97)

access: protected

void initFacebook ( $key, $secret)

$key
$secret

initWMSFacebookApplication (line 105)

access: protected

void initWMSFacebookApplication ( $url)

$url

initWMSFacebookDataStore (line 109)

access: protected

void initWMSFacebookDataStore ()

initWMSFacebookUser (line 101)

access: protected

void initWMSFacebookUser ( $user)

$user

login (line 48)

Authenticates the user's credentials. a valid instance of WMSFacebookUser. be redirected to Facebook.

Authenticates the user's credentials. If successful, this will return a valid instance of WMSFacebookUser. If unsuccessful, the user will be redirected to Facebook.

access: public

WMSFacebookUser login (string $url)

string $url: Application website.

setWMSFacebookUser (line 73)

access: public

void setWMSFacebookUser ( $wmsFacebookUser)

$wmsFacebookUser

Inherited Methods

Inherited From WMSFacebookObject

WMSFacebookObject::WMSFacebookObject()
WMSFacebookObject::getFacebook()
WMSFacebookObject::getFacebookAPI()