emgiezet/faceboo

This package is abandoned and no longer maintained. No replacement package was suggested.

Faceboo

dev-master 2012-10-01 21:27 UTC

Requires

• php: >=5.3.0

MIT

• Damien Pitard
• Max Małecki

README

Integrate Facebook SDK into Silex micro-framework (FacebookServiceProvider) or Symfony2 (FacebooBundle).

Provide several methods to do common tasks with Facebook.

• authentification
• permissions management
• fan-gate management

Installation

Composer

• modify your composer.json

  {
    "repositories": {
        "faceboo": {
            "type": "package",
            "package": {
                "name": "faceboo",
                "version": "1.0",
                "source": {
                    "url": "https://github.com/pitpit/Faceboo.git",
                    "type": "git",
                    "reference": "master"
                }
            }
        }
    },
    "require": { ... }
    }
  

• Then add to your require section in composer.json following line

  "require": {
      "faceboo": "1.*"
  }
  

• Finally update your composer:

  $php composer.phar update
  

Get the sources:

cd vendor
git clone https://github.com/dpitard/Faceboo.git faceboo
cd faceboo
git submodule update --init

Parameters

• app_id: you app id
• secret: your app secret
• permissions: array of facebook permissions needed to access the app
  • http://developers.facebook.com/docs/reference/api/permissions/
• namespace: your app namespace
• canvas: true if your app work under a facebook iframe
• proxy: to make facebook requests work behind non-transparent proxy
• timeout :
• connect_timeout
• protect: true|false, disable the redirection when accessing the server, in canvas mode
• class_path (silex only): define another path to reach Facebook PHP SDK

Usage

Silex

Register the namespace and the extension, in top of index.php:

$app['autoloader']->registerNamespace('Faceboo', __DIR__.'/../vendor/faceboo/src');

$app->register(new Faceboo\Provider\FacebookServiceProvider(), array(
    'facebook.app_id' => 'YOUR_APP_ID'
));

The parameters are formated as : facebook.

Login and ask user for permissions if needed:

$app['facebook.permissions'] = array();

$app->match('/', function () use ($app) {

    if ($response = $app['facebook']->auth()) return $response;

    //...
});

In canvas mode, protect your canvas app from direct access to the source server:

$app->before(function(Request $request) use ($app) {
    if ($response = $app['facebook']->protect()) return $response;
});

* do not rely on it for security, it's based on HTTP_REFERER so it's not safe

In a fan page tab, is the current user admin of the fan page :

$app->match('/', function () use ($app) {

    $isAdmin = $app['facebook']->isFanPageAdmin();
    
    //...
}

* you need to define "secret" parameter

In a fan page tab, what is the fan page id :

$app->match('/', function () use ($app) {

    $pageId = $app['facebook']->getFanPageId();
    
    //...
}

* you need to define "secret" parameter

In a fan page tab, does the current user like the fan page :

$app->match('/', function () use ($app) {

    $isFan = $app['facebook']->isFan();
    
    //...
}

* you need to define "secret" parameter

Get the current facebook user id:

$app['facebook']->getUser();

Call the Facebook api:

$data =  $app['facebook']->api('/me);

Symfony2

Register the autoload in app/autoload.php:

$loader->registerNamespaces(array(
    //...
    'Faceboo'        => __DIR__.'/../vendor/faceboo/src'
));

//...

require_once __DIR__.'/../. /vendor/php-sdk/src/facebook.php';

Register the bundle in app/AppKernel.php:

    $bundles = array(
        //...
        new Faceboo\FacebookBundle\FacebooFacebookBundle(),
    );

Add the following in app/config/config.yml:

faceboo_facebook:
    app_id: 297720976910223
    secret: b151a27351e91dab2ee18986d8c47052

Parameters:

• facebook.app_id: you app id
• facebook.secret: your app secret
• facebook.permissions: array of facebook permissions needed to access the app
  • http://developers.facebook.com/docs/reference/api/permissions/
• facebook.namespace: your app namespace
• facebook.canvas: true if your app work under a facebook iframe
• facebook.proxy: to make facebook requests work behind non-transparent proxy
• facebook.timeout
• facebook.connect_timeout
• facebook.protect: true|false, disable the redirection when accessing the server, in canvas mode
• facebook.class_path: define another path to reach Facebook PHP SDK

Login and ask user for permissions if needed:

public function indexAction()
{   
    if ($response = $this->get('facebook')->auth()) return $response;
    
    //...
}

Todo

• developp permissions authorization on website mode
• get rid of SilexEvent dependency to make it work with Symfony
• In canvas mode, override UrlGenerator to have the canvas URL when generate() is called with $absolute = true
• fan page
  • does the user like the fan page ?
  • route according to local

Changelog

• added symfony support
• app_id and secret are now mandatory
• updated to last version of Silex
• updated parameter prefix (now "facebook")